![]() |
Gamedev Framework (gf)
0.10.0
A C++14 framework for 2D games
|
A widget with a set of sprites. More...
#include <gf/Widgets.h>
Public Member Functions | |
SpriteWidget ()=default | |
Constructor with no texture. More... | |
SpriteWidget (const Texture &texture, const RectF &defaultRect, const RectF &selectedRect, const RectF &disabledRect) | |
Constructor with a single texture and three rectangles. More... | |
SpriteWidget (const Texture &defaultTexture, const Texture &selectedTexture, const Texture &disabledTexture) | |
Constructor with three full textures. More... | |
virtual void | draw (RenderTarget &target, const RenderStates &states) override |
Draw the object to a render target. More... | |
virtual bool | contains (Vector2f coords) override |
Check if the widget contains the coordinates. More... | |
void | setDisabledSprite (const Texture &texture, const RectF &textureRect) |
Set the texture for disabled state. More... | |
void | setDefaultSprite (const Texture &texture, const RectF &textureRect) |
Set the texture for default state. More... | |
void | setSelectedSprite (const Texture &texture, const RectF &textureRect) |
Set the texture for selected state. More... | |
RectF | getLocalBounds () const |
Get the local bounding rectangle of the entity. More... | |
void | setAnchor (Anchor anchor) |
Set the anchor origin of the entity. More... | |
![]() | |
Widget () | |
Constructor. More... | |
void | setDisabled () |
Disable the widget. More... | |
bool | isDisabled () const noexcept |
Check if the widget is disabled. More... | |
void | setDefault () |
Set the widget to it's default state. More... | |
bool | isDefault () const noexcept |
Check if the widget is in default state. More... | |
void | setSelected () |
Select the widget. More... | |
bool | isSelected () const |
Check if the widget is selected. More... | |
void | setState (WidgetState state) |
Set the state of the widget directly. More... | |
WidgetState | getState () const noexcept |
Get the state of the widget. More... | |
void | setCallback (std::function< void()> callback) |
Set the callback of the widget. More... | |
void | triggerCallback () |
Execute the callback function. More... | |
![]() | |
Transformable () | |
Default constructor. More... | |
void | setOrigin (Vector2f origin) |
Set the local origin of the object. More... | |
Vector2f | getOrigin () const |
Get the local origin of the object. More... | |
void | setPosition (Vector2f position) |
Set the position of the object. More... | |
Vector2f | getPosition () const |
Get the position of the object. More... | |
void | move (Vector2f offset) |
Move the object by a given offset. More... | |
void | setRotation (float angle) |
Set the orientation of the object. More... | |
float | getRotation () const |
Get the orientation of the object. More... | |
void | rotate (float angle) |
Rotate the object. More... | |
void | setScale (Vector2f factors) |
Set the scale factors of the object. More... | |
void | setScale (float factor) |
Set the scale factor of the object. More... | |
Vector2f | getScale () const |
Get the current scale of the object. More... | |
void | scale (Vector2f factors) |
Scale the object. More... | |
void | scale (float factor) |
Scale the object. More... | |
Matrix3f | getTransform () const |
Get the combined transform of the object. More... | |
Matrix3f | getInverseTransform () const |
Get the inverse of the combined transform of the object. More... | |
![]() | |
virtual | ~Drawable () |
Virtual desctructor. More... | |
Additional Inherited Members | |
![]() | |
virtual void | triggered () |
Function called when the callback is triggered. More... | |
![]() | |
void | setOriginFromAnchorAndBounds (Anchor anchor, const RectF &bounds) |
Set the origin from an anchor and bounds. More... | |
A widget with a set of sprites.
|
default |
Constructor with no texture.
gf::SpriteWidget::SpriteWidget | ( | const Texture & | texture, |
const RectF & | defaultRect, | ||
const RectF & | selectedRect, | ||
const RectF & | disabledRect | ||
) |
Constructor with a single texture and three rectangles.
texture | The texture used for the widget |
defaultRect | The rectangle in the texture used for default state |
selectedRect | The rectangle in the texture used for selected state |
disabledRect | The rectangle in the texture used for disabled state |
gf::SpriteWidget::SpriteWidget | ( | const Texture & | defaultTexture, |
const Texture & | selectedTexture, | ||
const Texture & | disabledTexture | ||
) |
Constructor with three full textures.
defaultTexture | The texture used for default state |
selectedTexture | The texture used for selected state |
disabledTexture | The texture used for disabled state |
|
overridevirtual |
Check if the widget contains the coordinates.
coords | The coordinates to check |
Implements gf::Widget.
|
overridevirtual |
Draw the object to a render target.
This is a pure virtual function that has to be implemented by the derived class to define how the drawable should be drawn.
target | Render target to draw to |
states | Current render states |
Implements gf::Drawable.
|
inline |
Get the local bounding rectangle of the entity.
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
void gf::SpriteWidget::setAnchor | ( | Anchor | anchor | ) |
Set the anchor origin of the entity.
Compute the origin of the entity based on the local bounds and the specified anchor. Internally, this function calls Transformable::setOrigin()
.
anchor | The anchor of the entity |
Set the texture for default state.
texture | The texture used for default state |
textureRect | The rectangle in the texture used for default state |
Set the texture for disabled state.
texture | The texture used for disabled state |
textureRect | The rectangle in the texture used for disabled state |