Sprite defines a sprite : texture, transformations, color, and draw on screen. More...
#include <Sprite.hpp>
Public Member Functions | |
Sprite () | |
Default constructor. More... | |
Sprite (const Image &Img, const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255)) | |
Construct the sprite from a source image. More... | |
void | SetImage (const Image &Img) |
Change the image of the sprite. More... | |
void | SetSubRect (const IntRect &SubRect) |
Set the sub-rectangle of the sprite inside the source image. More... | |
void | Resize (float Width, float Height) |
Resize the sprite (by changing its scale factors) (take 2 values). More... | |
void | Resize (const Vector2f &Size) |
Resize the sprite (by changing its scale factors) (take a 2D vector). More... | |
void | FlipX (bool Flipped) |
Flip the sprite horizontally. More... | |
void | FlipY (bool Flipped) |
Flip the sprite vertically. More... | |
const Image * | GetImage () const |
Get the source image of the sprite. More... | |
const IntRect & | GetSubRect () const |
Get the sub-rectangle of the sprite inside the source image. More... | |
Vector2f | GetSize () const |
Get the sprite size. More... | |
Color | GetPixel (unsigned int X, unsigned int Y) const |
Get the color of a given pixel in the sprite (point is in local coordinates) More... | |
void | SetPosition (float X, float Y) |
Set the position of the object (take 2 values) More... | |
void | SetPosition (const Vector2f &Position) |
Set the position of the object (take a 2D vector) More... | |
void | SetX (float X) |
Set the X position of the object. More... | |
void | SetY (float Y) |
Set the Y position of the object. More... | |
void | SetScale (float ScaleX, float ScaleY) |
Set the scale of the object (take 2 values) More... | |
void | SetScale (const Vector2f &Scale) |
Set the scale of the object (take a 2D vector) More... | |
void | SetScaleX (float FactorX) |
Set the X scale factor of the object. More... | |
void | SetScaleY (float FactorY) |
Set the Y scale factor of the object. More... | |
void | SetCenter (float CenterX, float CenterY) |
Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). More... | |
void | SetCenter (const Vector2f &Center) |
Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector). More... | |
void | SetRotation (float Rotation) |
Set the orientation of the object. More... | |
void | SetColor (const Color &Col) |
Set the color of the object. More... | |
void | SetBlendMode (Blend::Mode Mode) |
Set the blending mode for the object. More... | |
const Vector2f & | GetPosition () const |
Get the position of the object. More... | |
const Vector2f & | GetScale () const |
Get the current scale of the object. More... | |
const Vector2f & | GetCenter () const |
Get the center of the object. More... | |
float | GetRotation () const |
Get the orientation of the object. More... | |
const Color & | GetColor () const |
Get the color of the object. More... | |
Blend::Mode | GetBlendMode () const |
Get the current blending mode. More... | |
void | Move (float OffsetX, float OffsetY) |
Move the object of a given offset (take 2 values) More... | |
void | Move (const Vector2f &Offset) |
Move the object of a given offset (take a 2D vector) More... | |
void | Scale (float FactorX, float FactorY) |
Scale the object (take 2 values) More... | |
void | Scale (const Vector2f &Factor) |
Scale the object (take a 2D vector) More... | |
void | Rotate (float Angle) |
Rotate the object. More... | |
sf::Vector2f | TransformToLocal (const sf::Vector2f &Point) const |
Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point) More... | |
sf::Vector2f | TransformToGlobal (const sf::Vector2f &Point) const |
Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point) More... | |
Protected Member Functions | |
virtual void | Render (RenderTarget &Target) const |
/see Drawable::Render More... | |
const Matrix3 & | GetMatrix () const |
Get the transform matrix of the drawable. More... | |
const Matrix3 & | GetInverseMatrix () const |
Get the inverse transform matrix of the drawable. More... | |
Sprite defines a sprite : texture, transformations, color, and draw on screen.
Definition at line 44 of file Sprite.hpp.
sf::Sprite::Sprite | ( | ) |
Default constructor.
Definition at line 38 of file Sprite.cpp.
|
explicit |
Construct the sprite from a source image.
Img | : Image of the sprite |
Position | : Position of the sprite (0, 0 by default) |
Scale | : Scale factor (1, 1 by default) |
Rotation | : Orientation, in degrees (0 by default) |
Col | : Color of the sprite (white by default) |
Definition at line 50 of file Sprite.cpp.
void sf::Sprite::FlipX | ( | bool | Flipped | ) |
Flip the sprite horizontally.
Flipped | : True to flip the sprite |
Definition at line 112 of file Sprite.cpp.
void sf::Sprite::FlipY | ( | bool | Flipped | ) |
Flip the sprite vertically.
Flipped | : True to flip the sprite |
Definition at line 121 of file Sprite.cpp.
|
inherited |
Get the current blending mode.
Definition at line 258 of file Drawable.cpp.
|
inherited |
Get the center of the object.
Definition at line 231 of file Drawable.cpp.
|
inherited |
const Image * sf::Sprite::GetImage | ( | ) | const |
Get the source image of the sprite.
Definition at line 130 of file Sprite.cpp.
|
protectedinherited |
Get the inverse transform matrix of the drawable.
Definition at line 350 of file Drawable.cpp.
|
protectedinherited |
Get the transform matrix of the drawable.
Definition at line 334 of file Drawable.cpp.
Color sf::Sprite::GetPixel | ( | unsigned int | X, |
unsigned int | Y | ||
) | const |
Get the color of a given pixel in the sprite (point is in local coordinates)
X | : X coordinate of the pixel to get |
Y | : Y coordinate of the pixel to get |
Definition at line 158 of file Sprite.cpp.
|
inherited |
Get the position of the object.
Definition at line 213 of file Drawable.cpp.
|
inherited |
Get the orientation of the object.
Rotation is always in the range [0, 360]
Definition at line 240 of file Drawable.cpp.
|
inherited |
Get the current scale of the object.
Definition at line 222 of file Drawable.cpp.
Vector2f sf::Sprite::GetSize | ( | ) | const |
const IntRect & sf::Sprite::GetSubRect | ( | ) | const |
Get the sub-rectangle of the sprite inside the source image.
Definition at line 139 of file Sprite.cpp.
|
inherited |
Move the object of a given offset (take 2 values)
OffsetX | : X offset |
OffsetY | : Y offset |
Definition at line 268 of file Drawable.cpp.
|
inherited |
Move the object of a given offset (take a 2D vector)
Offset | : Amount of units to move the object of |
Definition at line 278 of file Drawable.cpp.
|
protectedvirtual |
/see Drawable::Render
/see sfDrawable::Render
Implements sf::Drawable.
Definition at line 180 of file Sprite.cpp.
void sf::Sprite::Resize | ( | float | Width, |
float | Height | ||
) |
Resize the sprite (by changing its scale factors) (take 2 values).
The default size is defined by the subrect
Width | : New width (must be strictly positive) |
Height | : New height (must be strictly positive) |
The default size is defined by the subrect
Definition at line 89 of file Sprite.cpp.
void sf::Sprite::Resize | ( | const Vector2f & | Size | ) |
Resize the sprite (by changing its scale factors) (take a 2D vector).
Resize the object (by changing its scale factors) (take a 2D vector) The default size is defined by the subrect.
The default size is defined by the subrect
Size | : New size (both coordinates must be strictly positive) |
Definition at line 103 of file Sprite.cpp.
|
inherited |
Rotate the object.
Angle | : Angle of rotation, in degrees |
Definition at line 306 of file Drawable.cpp.
|
inherited |
Scale the object (take 2 values)
FactorX | : Scaling factor on X (must be strictly positive) |
FactorY | : Scaling factor on Y (must be strictly positive) |
Definition at line 287 of file Drawable.cpp.
|
inherited |
Scale the object (take a 2D vector)
Factor | : Scaling factors (both values must be strictly positive) |
Definition at line 297 of file Drawable.cpp.
|
inherited |
Set the blending mode for the object.
The default blend mode is Blend::Alpha
Mode | : New blending mode |
The default blend mode is Blend::Alpha
Definition at line 204 of file Drawable.cpp.
|
inherited |
Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).
The default center is (0, 0)
CenterX | : X coordinate of the center |
CenterY | : Y coordinate of the center |
The default center is (0, 0)
Definition at line 157 of file Drawable.cpp.
|
inherited |
Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).
The default center is (0, 0)
Center | : New center |
The default center is (0, 0)
Definition at line 171 of file Drawable.cpp.
|
inherited |
Set the color of the object.
The default color is white
Col | : New color |
The default color is white
Definition at line 194 of file Drawable.cpp.
void sf::Sprite::SetImage | ( | const Image & | Img | ) |
Change the image of the sprite.
Set the image of the sprite.
Img | : New image |
Definition at line 63 of file Sprite.cpp.
|
inherited |
Set the position of the object (take 2 values)
X | : New X coordinate |
Y | : New Y coordinate |
Definition at line 65 of file Drawable.cpp.
|
inherited |
Set the position of the object (take a 2D vector)
Position | : New position |
Definition at line 75 of file Drawable.cpp.
|
inherited |
Set the orientation of the object.
Rotation | : Angle of rotation, in degrees |
Definition at line 180 of file Drawable.cpp.
|
inherited |
Set the scale of the object (take 2 values)
ScaleX | : New horizontal scale (must be strictly positive) |
ScaleY | : New vertical scale (must be strictly positive) |
Definition at line 107 of file Drawable.cpp.
|
inherited |
Set the scale of the object (take a 2D vector)
Scale | : New scale (both values must be strictly positive) |
Definition at line 117 of file Drawable.cpp.
|
inherited |
Set the X scale factor of the object.
X | : New X scale factor |
Definition at line 127 of file Drawable.cpp.
|
inherited |
Set the Y scale factor of the object.
Y | : New Y scale factor |
Definition at line 141 of file Drawable.cpp.
void sf::Sprite::SetSubRect | ( | const IntRect & | SubRect | ) |
Set the sub-rectangle of the sprite inside the source image.
By default, the subrect covers the entire source image
SubRect | : New sub-rectangle |
Definition at line 79 of file Sprite.cpp.
|
inherited |
Set the X position of the object.
X | : New X coordinate |
Definition at line 85 of file Drawable.cpp.
|
inherited |
Set the Y position of the object.
Y | : New Y coordinate |
Definition at line 96 of file Drawable.cpp.
|
inherited |
Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point)
Point | : Point to transform |
Definition at line 325 of file Drawable.cpp.
|
inherited |
Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point)
Point | : Point to transform |
Definition at line 316 of file Drawable.cpp.