tgui::CanvasSFML Class Reference

Inheritance diagram for tgui::CanvasSFML:

Public Types
typedef std::shared_ptr< CanvasSFML >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const CanvasSFML >	ConstPtr
	Shared constant widget pointer.
Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidget >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const ClickableWidget >	ConstPtr
	Shared constant widget pointer.
Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	CanvasSFML (const char *typeName="Canvas", bool initRenderer=true)
	CanvasSFML (const CanvasSFML &copy)
	Copy constructor.
	CanvasSFML (CanvasSFML &&copy)
	Move constructor.
CanvasSFML &	operator= (const CanvasSFML &right)
	Overload of copy assignment operator.
CanvasSFML &	operator= (CanvasSFML &&right)
	Overload of move assignment operator.
void	setSize (const Layout2d &size) override
	Changes the size of the widget.
void	setView (const sf::View &view)
	Change the current active view.
const sf::View &	getView () const
	Get the view currently in use in the canvas.
const sf::View &	getDefaultView () const
	Get the default view of the canvas.
IntRect	getViewport () const
	Get the viewport of the currently applied view, applied to this canvas.
void	clear (Color color=Color::Black)
	Clears the entire canvas with a single color.
void	draw (const sf::Drawable &drawable, const sf::RenderStates &states={})
	Draws a drawable object to the canvas.
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.
void	draw (const tgui::Sprite &sprite, const RenderStates &states={})
	Draws a TGUI sprite to the canvas.
void	display ()
	Updates the contents of the canvas.
void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the widget to a render target.
bool	canGainFocus () const override
	Returns whether the widget can gain focus.
sf::RenderTexture &	getRenderTexture ()
	Access the internal render texture that the canvas widget uses to draw on.
virtual void	setSize (const Layout2d &size)
	Changes the size of the widget.
void	setSize (Layout width, Layout height)
	Changes the size of the widget.
Public Member Functions inherited from tgui::ClickableWidget
	ClickableWidget (const char *typeName="ClickableWidget", bool initRenderer=true)
bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
void	leftMousePressed (Vector2f pos) override
void	leftMouseReleased (Vector2f pos) override
void	rightMousePressed (Vector2f pos) override
void	rightMouseReleased (Vector2f pos) override
void	rightMouseButtonNoLongerDown () override
void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the widget to a render target.
Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)
	Widget (const Widget &)
	Copy constructor.
	Widget (Widget &&)
	Move constructor.
virtual	~Widget ()
	Destructor.
Widget &	operator= (const Widget &)
	Overload of copy assignment operator.
Widget &	operator= (Widget &&)
	Move assignment.
void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.
WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const WidgetRenderer *	getSharedRenderer () const
WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.
const WidgetRenderer *	getRenderer () const
virtual void	setPosition (const Layout2d &position)
	sets the position of the widget
void	setPosition (Layout x, Layout y)
	Sets the position of the widget.
Vector2f	getPosition () const
	Gets the position of the widget.
void	setSize (Layout width, Layout height)
	Changes the size of the widget.
void	setWidth (Layout width)
	Changes the width of the widget.
void	setHeight (Layout height)
	Changes the height of the widget.
Vector2f	getSize () const
	Returns the size of the widget.
virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.
virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the top-left point of the widget instead of the relative position to its parent.
virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.
void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.
void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.
Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.
void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.
void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.
void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.
void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.
Vector2f	getScale () const
	Returns the scaling to be applied to the widget.
Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.
void	setRotation (float angle)
	Sets the rotation to be applied to the widget.
void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.
float	getRotation () const
	Returns the rotation to be applied to the widget.
Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.
void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.
void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.
virtual void	setVisible (bool visible)
	Shows or hides a widget.
bool	isVisible () const
	Returns true when the widget is visible.
virtual void	setEnabled (bool enabled)
	Enables or disables the widget.
bool	isEnabled () const
	Returns true when the widget is enabled.
virtual void	setFocused (bool focused)
	Focus or unfocus the widget.
bool	isFocused () const
	Returns true when the widget is focused and false otherwise.
const String &	getWidgetType () const
	Returns the type of the widget.
Container *	getParent () const
	Returns a pointer to the parent widget.
GuiBase *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.
bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
void	moveToFront ()
	Places the widget before all other widgets.
void	moveToBack ()
	Places the widget behind all other widgets.
void	setUserData (Any userData)
	Stores some data into the widget.
template<typename T >
T	getUserData () const
	Returns data stored in the widget.
void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.
const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.
void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
virtual void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.
virtual unsigned int	getTextSize () const
	Returns the character size of text in this widget.
void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.
Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.
void	setWidgetName (const String &name)
	Changes the name of a widget.
String	getWidgetName () const
	Returns the name of a widget.
void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.
Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.
void	setFocusable (bool focusable)
	Changes whether a widget could be focused.
bool	isFocusable () const
	Returns whether a widget could be focused.
bool	isContainer () const
	Returns whether the widget is a container widget or not.
bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.
virtual void	setParent (Container *parent)
virtual bool	updateTime (Duration elapsedTime)
virtual void	mousePressed (Event::MouseButton button, Vector2f pos)
virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)
virtual void	mouseMoved (Vector2f pos)
virtual void	keyPressed (const Event::KeyEvent &event)
virtual void	textEntered (char32_t key)
virtual bool	mouseWheelScrolled (float delta, Vector2f pos)
virtual void	mouseNoLongerOnWidget ()
virtual void	leftMouseButtonNoLongerDown ()
virtual Widget::Ptr	askToolTip (Vector2f mousePos)
const Layout2d &	getPositionLayout () const
const Layout2d &	getSizeLayout () const
void	bindPositionLayout (Layout *layout)
void	unbindPositionLayout (Layout *layout)
void	bindSizeLayout (Layout *layout)
void	unbindSizeLayout (Layout *layout)
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.
static CanvasSFML::Ptr	copy (CanvasSFML::ConstPtr canvas)
	Makes a copy of another canvas.
Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr	create (Layout2d size={"100%", "100%"})
	Creates a new clickable widget.
static ClickableWidget::Ptr	copy (ClickableWidget::ConstPtr widget)
	Makes a copy of another clickable widget.

Protected Member Functions
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.
Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.
Protected Member Functions inherited from tgui::ClickableWidget
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.
Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.
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.

Protected Attributes
sf::RenderTexture	m_renderTexture
Sprite	m_sprite
Protected Attributes inherited from tgui::Widget
String	m_type
String	m_name
Layout2d	m_position
Layout2d	m_size
unsigned int	m_textSize = 0
Vector2f	m_origin
Optional< Vector2f >	m_rotationOrigin
Optional< Vector2f >	m_scaleOrigin
Vector2f	m_scaleFactors = {1, 1}
float	m_rotationDeg = 0
Vector2f	m_prevPosition
Vector2f	m_prevSize
std::unordered_set< Layout * >	m_boundPositionLayouts
std::unordered_set< Layout * >	m_boundSizeLayouts
bool	m_enabled = true
bool	m_visible = true
Container *	m_parent = nullptr
GuiBase *	m_parentGui = nullptr
bool	m_mouseHover = false
bool	m_mouseDown = false
bool	m_focused = false
bool	m_focusable = true
Duration	m_animationTimeElapsed
bool	m_draggableWidget = false
bool	m_containerWidget = false
Widget::Ptr	m_toolTip = nullptr
aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr
std::vector< std::shared_ptr< priv::Animation > >	m_showAnimations
Font	m_inheritedFont
float	m_inheritedOpacity = 1
Font	m_fontCached = Font::getGlobalFont()
float	m_opacityCached = 1
bool	m_transparentTextureCached = false
Any	m_userData
Cursor::Type	m_mouseCursor = Cursor::Type::Arrow
std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

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.
SignalShowEffect	onAnimationFinish = {"AnimationFinished"}
SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
using	LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >

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

color

Fill 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

canvas

The other canvas

Returns

The new canvas

create()

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

static

Creates a new canvas widget.

Parameters

size	Size 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 ( BackendRenderTargetBase &  target, RenderStates  states  ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current 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

drawable	Object to draw
states	Render 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

vertices	Pointer to the vertices
vertexCount	Number of vertices in the array
type	Type of primitives to draw
states	Render 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

sprite	Sprite to draw
states	Render 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

property

Name 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

size	Size 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});

Reimplemented from tgui::Widget.

setSize() [2/3]

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

overridevirtual

Changes the size of the widget.

Parameters

size	The 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

width	Width of the widget
height	Height 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

view	New view to use

---

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

• include/TGUI/Widgets/Canvas.hpp