TGUI  0.10-dev
Inheritance diagram for tgui::CanvasSFML:
tgui::ClickableWidget tgui::Widget

Public Types

typedef std::shared_ptr< CanvasSFMLPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const CanvasSFMLConstPtr
 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

 CanvasSFML (const CanvasSFML &copy)
 Copy constructor.
 
 CanvasSFML (CanvasSFML &&copy)
 Move constructor.
 
CanvasSFMLoperator= (const CanvasSFML &right)
 Overload of copy assignment operator.
 
CanvasSFMLoperator= (CanvasSFML &&right)
 Overload of move assignment operator.
 
void setSize (const Layout2d &size) override
 Changes the size of the widget. More...
 
void setView (const sf::View &view)
 Change the current active view. More...
 
const sf::View & getView () const
 Get the view currently in use in the canvas. More...
 
const sf::View & getDefaultView () const
 Get the default view of the canvas. More...
 
IntRect getViewport () const
 Get the viewport of the currently applied view, applied to this canvas. More...
 
void clear (Color color=Color::Black)
 Clears the entire canvas with a single color. More...
 
void draw (const sf::Drawable &drawable, const sf::RenderStates &states={})
 Draws a drawable object to the canvas. More...
 
void draw (const sf::Vertex *vertices, std::size_t vertexCount, sf::PrimitiveType type, const sf::RenderStates &states={})
 Draws primitives defined by an array of vertices. More...
 
void draw (const tgui::Sprite &sprite, const RenderStates &states={})
 Draws a TGUI sprite to the canvas. More...
 
void display ()
 Updates the contents of the canvas. More...
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
bool canGainFocus () const override
 Returns whether the widget can gain focus. More...
 
sf::RenderTexture & getRenderTexture ()
 Access the internal render texture that the canvas widget uses to draw on. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
virtual void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Static Public Member Functions

static CanvasSFML::Ptr create (Layout2d size={"100%", "100%"})
 Creates a new canvas widget. More...
 
static CanvasSFML::Ptr copy (CanvasSFML::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

void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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::ClickableWidget
SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
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
virtual std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const
 Saves the widget as a tree node in order to save it to a file.
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes.
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

Additional Inherited Members

- Public Attributes inherited from tgui::ClickableWidget
SignalVector2f onMousePress = {"MousePressed"}
 The mouse went down on the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onMouseRelease = {"MouseReleased"}
 The mouse was released on top of the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onClick = {"Clicked"}
 The widget was clicked. Optional parameter: mouse position relative to widget.
 
SignalVector2f onRightMousePress = {"RightMousePressed"}
 The right mouse button went down on the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onRightMouseRelease = {"RightMouseReleased"}
 The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onRightClick = {"RightClicked"}
 The widget was right clicked. Optional parameter: mouse position relative to widget.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Member Function Documentation

◆ canGainFocus()

bool tgui::CanvasSFML::canGainFocus ( ) const
overridevirtual

Returns whether the widget can gain focus.

Returns
Can the widget be focused?

This function returns false for Canvas widgets.

Reimplemented from tgui::Widget.

◆ clear()

void tgui::CanvasSFML::clear ( Color  color = Color::Black)

Clears 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()

Widget::Ptr tgui::CanvasSFML::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

Implements tgui::Widget.

◆ copy()

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

Makes a copy of another canvas.

Parameters
canvasThe other canvas
Returns
The new canvas

◆ create()

static CanvasSFML::Ptr tgui::CanvasSFML::create ( Layout2d  size = {"100%", "100%"})
static

Creates a new canvas widget.

Parameters
sizeSize of the canvas
Returns
The new canvas

◆ display()

void tgui::CanvasSFML::display ( )

Updates 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/4]

void tgui::CanvasSFML::draw ( BackendRenderTarget target,
RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ draw() [2/4]

void tgui::CanvasSFML::draw ( const sf::Drawable &  drawable,
const sf::RenderStates &  states = {} 
)

Draws a drawable object to the canvas.

Parameters
drawableObject to draw
statesRender states to use for drawing

◆ draw() [3/4]

void tgui::CanvasSFML::draw ( const sf::Vertex *  vertices,
std::size_t  vertexCount,
sf::PrimitiveType  type,
const sf::RenderStates &  states = {} 
)

Draws 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

◆ draw() [4/4]

void tgui::CanvasSFML::draw ( const tgui::Sprite sprite,
const RenderStates states = {} 
)

Draws a TGUI sprite to the canvas.

Parameters
spriteSprite to draw
statesRender states to use for drawing
Warning
Only simple sprites can be drawn. There is currently no support for SVGs, shaders, clipping or rotation.

◆ getDefaultView()

const sf::View & tgui::CanvasSFML::getDefaultView ( ) const

Get the default view of the canvas.

The default view has the same size as the canvas.

Returns
The default view of the canvas

◆ getRenderTexture()

sf::RenderTexture & tgui::CanvasSFML::getRenderTexture ( )
inline

Access the internal render texture that the canvas widget uses to draw on.

Returns
Reference to the internal render texture
Warning
Don't call the create function on the returned render texture.

◆ getView()

const sf::View & tgui::CanvasSFML::getView ( ) const

Get the view currently in use in the canvas.

Returns
The view object that is currently used

◆ getViewport()

IntRect tgui::CanvasSFML::getViewport ( ) const

Get the viewport of the currently applied view, applied to this canvas.

The viewport is defined in the view as a ratio, this function simply applies this ratio to the current dimensions of the canvas to calculate the pixels rectangle that the viewport actually covers in the canvas.

Returns
Viewport rectangle, expressed in pixels

◆ rendererChanged()

void tgui::CanvasSFML::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::CanvasSFML::setSize ( const Layout2d size)
overridevirtual

Changes the size of the widget.

Parameters
sizeThe new size of the widget

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setView()

void tgui::CanvasSFML::setView ( const sf::View &  view)

Change the current active view.

The view is like a 2D camera, it controls which part of the 2D scene is visible, and how it is viewed in the canvas. The new view will affect everything that is drawn, until another view is set. The canvas keeps its own copy of the view, so it is not necessary to keep the original one alive after calling this function. To restore the original view of the target, you can pass the result of getDefaultView() to this function.

Warning
This view is reset when the size of the canvas is changed.
Parameters
viewNew view to use

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