tgui::Picture Class Reference

Picture widget. More...

#include <TGUI/Widgets/Picture.hpp>

Inheritance diagram for tgui::Picture:

Public Types
typedef std::shared_ptr< Picture >	Ptr
	Shared widget pointer.
typedef std::shared_ptr< const Picture >	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
	Picture ()
	Default constructor.
	Picture (const sf::String &filename, bool fullyClickable=true)
	Constructor to creates the picture. More...
	Picture (const Texture &texture, bool fullyClickable=true)
	Constructor to create the picture from an image. More...
void	setTexture (const sf::String &filename, bool fullyClickable=true)
	Change the image. More...
void	setTexture (const Texture &texture, bool fullyClickable=true)
	Change the image. More...
const sf::String &	getLoadedFilename () const
	Returns the filename of the image that was used to load the widget. 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 picture. More...
void	setSmooth (bool smooth=true)
	Enable or disable the smooth filter. More...
bool	isSmooth () const
	Tell whether the smooth filter is enabled or not. More...
virtual void	setOpacity (float opacity) override
	Changes the opacity of the widget. More...
virtual void	setPosition (const Layout2d &position)
	set the position of the widget More...
void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...
virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...
void	setSize (const Layout &width, const Layout &height)
	Changes the size 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.
Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...
std::shared_ptr< WidgetRenderer >	getRenderer () 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...
Container *	getParent () 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< BaseTheme >	getTheme () 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...
void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...
void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...
Public Member Functions inherited from tgui::Transformable
virtual	~Transformable ()
	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...
SignalWidgetBase &	operator= (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 Picture::Ptr	create (const char *filename, bool fullyClickable=true)
	Creates a new picture widget. More...
static Picture::Ptr	create (const Texture &texture={}, bool fullyClickable=true)
	Creates a new picture widget. More...
static Picture::Ptr	copy (Picture::ConstPtr picture)
	Makes a copy of another picture. 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...

Detailed Description

Picture widget.

Signals:

• DoubleClicked (double left clicked on top of the picture)
  • Optional parameter sf::Vector2f: Position where you clicked
  • Uses Callback member 'mouse'
• Inherited signals from ClickableWidget

Constructor & Destructor Documentation

Picture() [1/2]

tgui::Picture::Picture	(	const sf::String &	filename,
		bool	fullyClickable = true
	)

Constructor to creates the picture.

Parameters

filename	The absolute or relative filename of the image that should be loaded
fullyClickable	This affects what happens when clicking on a transparent pixel in the image. Is the click caught by the picture, or does the event pass to the widgets behind it?

Exceptions

Exception

when the image could not be loaded (probably not found)

Picture() [2/2]

tgui::Picture::Picture	(	const Texture &	texture,
		bool	fullyClickable = true
	)

Constructor to create the picture from an image.

Parameters

texture	The texture to load the picture from
fullyClickable	This affects what happens when clicking on a transparent pixel in the image. Is the click caught by the picture, or does the event pass to the widgets behind it?

auto picture1 = tgui::Picture::create({"image.png", {10, 10, 80, 80}});
 
sf::Texture texture;
texture.loadFromFile("image.png", {10, 10, 80, 80});
auto picture2 = tgui::Picture::create(texture);

Member Function Documentation

clone()

virtual Widget::Ptr tgui::Picture::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 Picture::Ptr tgui::Picture::copy ( Picture::ConstPtr  picture )

static

Makes a copy of another picture.

Parameters

picture

The other picture

Returns

The new picture

create() [1/2]

static Picture::Ptr tgui::Picture::create ( const char *  filename, bool  fullyClickable = true  )

static

Creates a new picture widget.

Parameters

filename	The filename of the texture to load the picture from
fullyClickable	This affects what happens when clicking on a transparent pixel in the image. Is the click caught by the picture, or does the event pass to the widgets behind it?

Returns

The new picture

auto picture1 = Picture::create("image.png");
 
auto picture2 = Picture::create({"image.png", {20, 15, 60, 40}}); // Load part of the image from (20,15) to (80,55)
 
sf::Texture texture;
texture.loadFromFile("image.png", {20, 15, 60, 40});
auto picture3 = Picture::create(texture);

create() [2/2]

static Picture::Ptr tgui::Picture::create ( const Texture &  texture = {}, bool  fullyClickable = true  )

static

Creates a new picture widget.

Parameters

texture	The texture to load the picture from
fullyClickable	This affects what happens when clicking on a transparent pixel in the image. Is the click caught by the picture, or does the event pass to the widgets behind it?

Returns

The new picture

auto picture1 = Picture::create("image.png");
 
auto picture2 = Picture::create({"image.png", {20, 15, 60, 40}}); // Load part of the image from (20,15) to (80,55)
 
sf::Texture texture;
texture.loadFromFile("image.png", {20, 15, 60, 40});
auto picture3 = Picture::create(texture);

getLoadedFilename()

const sf::String & tgui::Picture::getLoadedFilename ( ) const

inline

Returns the filename of the image that was used to load the widget.

Returns

Filename of loaded image. Empty string when no image was loaded yet or when it was loaded directly from a texture.

isSmooth()

bool tgui::Picture::isSmooth ( ) const

inline

Tell whether the smooth filter is enabled or not.

Returns

True if smoothing is enabled, false if it is disabled

See also

setSmooth

setOpacity()

virtual void tgui::Picture::setOpacity ( float  opacity )

overridevirtual

Changes the opacity of the widget.

Parameters

opacity

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

Reimplemented from tgui::Widget.

setPosition() [1/3]

void tgui::Transformable::setPosition ( const Layout &  x, const Layout &  y  )

inline

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

x	New x coordinate
y	New y coordinate

See also

move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition(40, 30);
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition().x, otherWidget->getPosition().y + otherWidget->getSize().y + 50);
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition(tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50);

setPosition() [2/3]

virtual void tgui::Transformable::setPosition ( const Layout2d &  position )

virtual

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

position

New position

See also

move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition() + sf::Vector2f{0, otherWidget->getSize().y + 50});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented from tgui::Widget.

setPosition() [3/3]

virtual void tgui::Picture::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

position

New position

See also

move, getPosition

Reimplemented from tgui::Widget.

setSize() [1/3]

void tgui::Transformable::setSize ( const Layout &  width, const Layout &  height  )

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Usage examples:

// Give the widget an exact size
widget->setSize(40, 30);
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize().x, otherWidget->getSize().y + 50);
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindWidth(otherWidget), tgui::bindHeight(otherWidget) + 50);

setSize() [2/3]

virtual void tgui::Transformable::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});
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize() + sf::Vector2f{0, 50});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindSize(otherWidget) + sf::Vector2f{0, 50});

Reimplemented from tgui::Widget.

setSize() [3/3]

virtual void tgui::Picture::setSize ( const Layout2d &  size )

overridevirtual

Changes the size of the picture.

Parameters

size	The new size of the picture

The image will be scaled to fit this size.

Reimplemented from tgui::Widget.

setSmooth()

void tgui::Picture::setSmooth

(

bool

smooth = true

)

Enable or disable the smooth filter.

When the filter is activated, the texture appears smoother so that pixels are less noticeable. However if you want the texture to look exactly the same as its source file, you should leave it disabled. The smooth filter is disabled by default.

Parameters

smooth

True to enable smoothing, false to disable it

See also

isSmooth

setTexture() [1/2]

void tgui::Picture::setTexture	(	const sf::String &	filename,
		bool	fullyClickable = true
	)

Change the image.

Parameters

filename	The absolute or relative filename of the image that should be loaded
fullyClickable	This affects what happens when clicking on a transparent pixel in the image. Is the click caught by the picture, or does the event pass to the widgets behind it?

Exceptions

Exception

when the image could not be loaded (probably not found)

setTexture() [2/2]

void tgui::Picture::setTexture	(	const Texture &	texture,
		bool	fullyClickable = true
	)

Change the image.

Parameters

texture	The texture to load the picture from
fullyClickable	This affects what happens when clicking on a transparent pixel in the image. Is the click caught by the picture, or does the event pass to the widgets behind it?

picture1->setTexture({"image.png", {10, 10, 80, 80}});
 
sf::Texture texture;
texture.loadFromFile("image.png", {10, 10, 80, 80});
picture2->setTexture(texture);

---

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

• include/TGUI/Widgets/Picture.hpp