TGUI  0.7.4
Inheritance diagram for tgui::Canvas:
tgui::ClickableWidget tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

typedef std::shared_ptr< CanvasPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const CanvasConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ClickableWidgetConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 Canvas (const Layout2d &size={100, 100})
 Default constructor. More...
 
 Canvas (const Layout &width, const Layout &height)
 Default constructor. More...
 
 Canvas (const Canvas &copy)
 Copy constructor. More...
 
Canvasoperator= (const Canvas &right)
 Overload of assignment operator. More...
 
virtual void setPosition (const Layout2d &position) override
 Set the position of the widget. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
void clear (const Color &color=sf::Color(0, 0, 0, 255))
 Clear the entire canvas with a single color. More...
 
void draw (const sf::Drawable &drawable, const sf::RenderStates &states=sf::RenderStates::Default)
 Draw a drawable object to the canvas. More...
 
void draw (const sf::Vertex *vertices, unsigned int vertexCount, sf::PrimitiveType type, const sf::RenderStates &states=sf::RenderStates::Default)
 Draw primitives defined by an array of vertices. More...
 
void display ()
 Update the contents of the canvas. More...
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the widget. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
 ClickableWidget (const Layout2d &size={100, 100})
 Default constructor. More...
 
 ClickableWidget (const Layout &width, const Layout &height)
 Constructor. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable (bool blockMouseEvents=true)
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
virtual void setFont (const Font &font)
 Changes the font of the text in the widget. More...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all signals.
 

Static Public Member Functions

static Canvas::Ptr create (Layout2d size={100, 100})
 Creates a new canvas widget. More...
 
static Canvas::Ptr copy (Canvas::ConstPtr canvas)
 Makes a copy of another canvas. More...
 
- Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr create (Layout2d size={100, 100})
 Creates a new clickable widget. More...
 
static ClickableWidget::Ptr copy (ClickableWidget::ConstPtr widget)
 Makes a copy of another clickable widget. More...
 

Protected Member Functions

virtual Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Widget
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 
virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false)
 Reload the widget. More...
 

Constructor & Destructor Documentation

◆ Canvas() [1/3]

tgui::Canvas::Canvas ( const Layout2d size = {100, 100})

Default constructor.

Parameters
sizeSize of the canvas

◆ Canvas() [2/3]

tgui::Canvas::Canvas ( const Layout width,
const Layout height 
)

Default constructor.

Parameters
widthWidth of the canvas
heightHeight of the canvas

◆ Canvas() [3/3]

tgui::Canvas::Canvas ( const Canvas copy)

Copy constructor.

Parameters
copyInstance to copy

Member Function Documentation

◆ clear()

void tgui::Canvas::clear ( const Color color = sf::Color(0, 0, 0, 255))

Clear the entire canvas with a single color.

This function is usually called once every frame, to clear the previous contents of the canvas.

Parameters
colorFill color to use to clear the canvas

◆ clone()

virtual Widget::Ptr tgui::Canvas::clone ( ) const
inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Reimplemented from tgui::ClickableWidget.

◆ copy()

static Canvas::Ptr tgui::Canvas::copy ( Canvas::ConstPtr  canvas)
static

Makes a copy of another canvas.

Parameters
canvasThe other canvas
Returns
The new canvas

◆ create()

static Canvas::Ptr tgui::Canvas::create ( Layout2d  size = {100, 100})
static

Creates a new canvas widget.

Parameters
sizeSize of the canvas
Returns
The new canvas

◆ display()

void tgui::Canvas::display ( )

Update the contents of the canvas.

This function updates the canvas with what has been drawn so far. Like for windows, calling this function is mandatory at the end of rendering. Not calling it may leave the texture in an undefined state.

◆ draw() [1/2]

void tgui::Canvas::draw ( const sf::Drawable &  drawable,
const sf::RenderStates &  states = sf::RenderStates::Default 
)

Draw a drawable object to the canvas.

Parameters
drawableObject to draw
statesRender states to use for drawing

◆ draw() [2/2]

void tgui::Canvas::draw ( const sf::Vertex *  vertices,
unsigned int  vertexCount,
sf::PrimitiveType  type,
const sf::RenderStates &  states = sf::RenderStates::Default 
)

Draw primitives defined by an array of vertices.

Parameters
verticesPointer to the vertices
vertexCountNumber of vertices in the array
typeType of primitives to draw
statesRender states to use for drawing

◆ operator=()

Canvas& tgui::Canvas::operator= ( const Canvas right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

◆ setOpacity()

virtual void tgui::Canvas::setOpacity ( float  opacity)
overridevirtual

Changes the opacity of the widget.

Parameters
opacityThe opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition()

virtual void tgui::Canvas::setPosition ( const Layout2d position)
overridevirtual

Set the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
positionNew position
See also
move, getPosition

Reimplemented from tgui::Widget.

◆ setSize()

virtual void tgui::Canvas::setSize ( const Layout2d size)
overridevirtual

Changes the size of the widget.

Parameters
sizeThe new size of the widget

Reimplemented from tgui::Widget.


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