TGUI  0.8-dev

Picture widget. More...

#include <Picture.hpp>

Inheritance diagram for tgui::Picture:
tgui::ClickableWidget tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

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

 Picture ()
 Default constructor.
 
 Picture (const Texture &texture, bool fullyClickable=true)
 Constructor to create the picture from a texture. More...
 
void setTexture (const Texture &texture, bool fullyClickable=true)
 Changes the image. More...
 
const sf::String & getLoadedFilename () const
 Returns the filename of the image that was used to load the widget. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the picture. More...
 
void setSmooth (bool smooth=true)
 Enables or disable the smooth filter. More...
 
bool isSmooth () const
 Tells whether the smooth filter is enabled or not. More...
 
virtual void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
 ClickableWidget ()
 Default constructor.
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~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...
 
WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 sets the position of the widget More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. 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 ()
 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...
 
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...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void move (const Layout2d &offset)
 Moves the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Moves 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)
 Scales the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scales the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
virtual ~SignalWidgetBase ()
 Virtual destructor.
 
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)
 Disconnects all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnects all connections from a all signals.
 

Static Public Member Functions

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 void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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
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.
 

Detailed Description

Picture widget.

Signals:

  • DoubleClicked (double left clicked on top of the picture)
  • Inherited signals from ClickableWidget

Constructor & Destructor Documentation

§ Picture()

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

Constructor to create the picture from a texture.

Parameters
textureThe texture to load the picture from
fullyClickableThis 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?
Picture picture1("image.png");
Picture picture2({"image.png", {20, 15, 60, 40}}); // Only load the part of the image from (20,15) to (80,55)
sf::Texture texture;
texture.loadFromFile("image.png", {20, 15, 60, 40});
Picture picture3(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
pictureThe other picture
Returns
The new picture

§ create()

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

Creates a new picture widget.

Parameters
textureThe texture to load the picture from
fullyClickableThis 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);

§ draw()

virtual void tgui::Picture::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::ClickableWidget.

§ getLoadedFilename()

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

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 an sf::Texture.

§ isSmooth()

bool tgui::Picture::isSmooth ( ) const

Tells whether the smooth filter is enabled or not.

Returns
True if smoothing is enabled, false if it is disabled
See also
setSmooth

§ rendererChanged()

virtual void tgui::Picture::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

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

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Widget.

§ setSize()

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

Changes the size of the picture.

Parameters
sizeThe 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)

Enables 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
smoothTrue to enable smoothing, false to disable it
See also
isSmooth

§ setTexture()

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

Changes the image.

Parameters
textureThe texture to load the picture from
fullyClickableThis 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");
picture2->setTexture({"image.png", {20, 15, 60, 40}}); // Only load the part of the image from (20,15) to (80,55)
sf::Texture texture;
texture.loadFromFile("image.png", {20, 15, 60, 40});
picture3->setTexture(texture);

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