Overload  1.1
Game engine with editor
Public Member Functions | List of all members
OvUI::Modules::Canvas Class Reference

#include <Canvas.h>

Inheritance diagram for OvUI::Modules::Canvas:
OvUI::API::IDrawable

Public Member Functions

void AddPanel (Panels::APanel &p_panel)
 
void RemovePanel (Panels::APanel &p_panel)
 
void RemoveAllPanels ()
 
void MakeDockspace (bool p_state)
 
bool IsDockspace () const
 
void Draw () override
 

Detailed Description

A Canvas represents the whole frame available for UI drawing

Member Function Documentation

◆ AddPanel()

void OvUI::Modules::Canvas::AddPanel ( Panels::APanel p_panel)

Adds a panel to the canvas

Parameters
p_panel

◆ Draw()

void OvUI::Modules::Canvas::Draw ( )
overridevirtual

Draw the canvas (Draw every panels)

@project: Overload

Author
: Overload Tech. @restrictions: This software may not be resold, redistributed or otherwise conveyed to a third party.

Implements OvUI::API::IDrawable.

◆ IsDockspace()

bool OvUI::Modules::Canvas::IsDockspace ( ) const

Returns true if the canvas is a dockspace

◆ MakeDockspace()

void OvUI::Modules::Canvas::MakeDockspace ( bool  p_state)

Makes the canvas a dockspace (Dockable panels will be able to attach themselves to the canvas)

◆ RemoveAllPanels()

void OvUI::Modules::Canvas::RemoveAllPanels ( )

Removes every panels from the canvas

◆ RemovePanel()

void OvUI::Modules::Canvas::RemovePanel ( Panels::APanel p_panel)

Removes a panel from the canvas

Parameters
p_panel

The documentation for this class was generated from the following files: