sf::Sprite

sf::Sprite Class Reference

Sprite defines a sprite : texture, transformations, color, and draw on screen. More...

#include <Sprite.hpp>

Inheritance diagram for sf::Sprite:

sf::Drawable List of all members.

Public Member Functions

 Sprite ()
 Default constructor.
 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.
void SetImage (const Image &Img)
 Change the image of the sprite.
void SetSubRect (const IntRect &SubRect)
 Set the sub-rectangle of the sprite inside the source image.
void Resize (float Width, float Height)
 Resize the sprite (by changing its scale factors) (take 2 values).
void Resize (const Vector2f &Size)
 Resize the sprite (by changing its scale factors) (take a 2D vector).
void FlipX (bool Flipped)
 Flip the sprite horizontally.
void FlipY (bool Flipped)
 Flip the sprite vertically.
const Image * GetImage () const
 Get the source image of the sprite.
const IntRect & GetSubRect () const
 Get the sub-rectangle of the sprite inside the source image.
Vector2f GetSize () const
 Get the sprite size.
Color GetPixel (unsigned int X, unsigned int Y) const
 Get the color of a given pixel in the sprite.
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values).
void SetPosition (const Vector2f &Position)
 Set the position of the object (take a 2D vector).
void SetX (float X)
 Set the X position of the object.
void SetY (float Y)
 Set the Y position of the object.
void SetScale (float ScaleX, float ScaleY)
 Set the scale of the object (take 2 values).
void SetScale (const Vector2f &Scale)
 Set the scale of the object (take a 2D vector).
void SetScaleX (float FactorX)
 Set the X scale factor of the object.
void SetScaleY (float FactorY)
 Set the Y scale factor of the object.
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).
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).
void SetRotation (float Rotation)
 Set the orientation of the object.
void SetColor (const Color &Col)
 Set the color of the object.
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object.
const Vector2f & GetPosition () const
 Get the position of the object.
const Vector2f & GetScale () const
 Get the current scale of the object.
const Vector2f & GetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object.
const Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values).
void Move (const Vector2f &Offset)
 Move the object of a given offset (take a 2D vector).
void Scale (float FactorX, float FactorY)
 Scale the object (take 2 values).
void Scale (const Vector2f &Factor)
 Scale the object (take a 2D vector).
void Rotate (float Angle)
 Rotate the object.

Protected Member Functions

virtual void Render (const RenderWindow &Window) const
 /see Drawable::Render
const Matrix3 & GetMatrix () const
 Get the transform matrix of the drawable.

Detailed Description

Sprite defines a sprite : texture, transformations, color, and draw on screen.

Definition at line 43 of file Sprite.hpp.

Constructor & Destructor Documentation

sf::Sprite::Sprite (  ) 

Default constructor.

sf::Sprite::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.

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

Member Function Documentation

void sf::Sprite::SetImage ( const Image &  Img  ) 

Change the image of the sprite.

Parameters:
Img : New image

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

Parameters:
SubRect : New sub-rectangle

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

Parameters:
Width : New width (must be strictly positive)
Height : New height (must be strictly positive)

void sf::Sprite::Resize ( const Vector2f &  Size  ) 

Resize the sprite (by changing its scale factors) (take a 2D vector).

The default size is defined by the subrect

Parameters:
Size : New size (both coordinates must be strictly positive)

void sf::Sprite::FlipX ( bool  Flipped  ) 

Flip the sprite horizontally.

Parameters:
Flipped : True to flip the sprite

void sf::Sprite::FlipY ( bool  Flipped  ) 

Flip the sprite vertically.

Parameters:
Flipped : True to flip the sprite

const Image* sf::Sprite::GetImage (  )  const

Get the source image of the sprite.

Returns:
Pointer to the image (can be NULL)

const IntRect& sf::Sprite::GetSubRect (  )  const

Get the sub-rectangle of the sprite inside the source image.

Returns:
Sub-rectangle

Vector2f sf::Sprite::GetSize (  )  const

Get the sprite size.

Returns:
Size of the sprite

Color sf::Sprite::GetPixel ( unsigned int  X,
unsigned int  Y 
) const

Get the color of a given pixel in the sprite.

Parameters:
X : X coordinate of the pixel to get
Y : Y coordinate of the pixel to get
Returns:
Color of pixel (X, Y)

virtual void sf::Sprite::Render ( const RenderWindow &  Window  )  const [protected, virtual]

/see Drawable::Render

Implements sf::Drawable.

void sf::Drawable::SetPosition ( float  X,
float  Y 
) [inherited]

Set the position of the object (take 2 values).

Parameters:
X : New X coordinate
Y : New Y coordinate

void sf::Drawable::SetPosition ( const Vector2f &  Position  )  [inherited]

Set the position of the object (take a 2D vector).

Parameters:
Position : New position

void sf::Drawable::SetX ( float  X  )  [inherited]

Set the X position of the object.

Parameters:
X : New X coordinate

void sf::Drawable::SetY ( float  Y  )  [inherited]

Set the Y position of the object.

Parameters:
Y : New Y coordinate

void sf::Drawable::SetScale ( float  ScaleX,
float  ScaleY 
) [inherited]

Set the scale of the object (take 2 values).

Parameters:
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)

void sf::Drawable::SetScale ( const Vector2f &  Scale  )  [inherited]

Set the scale of the object (take a 2D vector).

Parameters:
Scale : New scale (both values must be strictly positive)

void sf::Drawable::SetScaleX ( float  FactorX  )  [inherited]

Set the X scale factor of the object.

Parameters:
X : New X scale factor

void sf::Drawable::SetScaleY ( float  FactorY  )  [inherited]

Set the Y scale factor of the object.

Parameters:
Y : New Y scale factor

void sf::Drawable::SetCenter ( float  CenterX,
float  CenterY 
) [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)

Parameters:
CenterX : X coordinate of the center
CenterY : Y coordinate of the center

void sf::Drawable::SetCenter ( const Vector2f &  Center  )  [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)

Parameters:
Center : New center

void sf::Drawable::SetRotation ( float  Rotation  )  [inherited]

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

void sf::Drawable::SetColor ( const Color &  Col  )  [inherited]

Set the color of the object.

The default color is white

Parameters:
Col : New color

void sf::Drawable::SetBlendMode ( Blend::Mode  Mode  )  [inherited]

Set the blending mode for the object.

The default blend mode is Blend::Alpha

Parameters:
Mode : New blending mode

const Vector2f& sf::Drawable::GetPosition (  )  const [inherited]

Get the position of the object.

Returns:
Current position

const Vector2f& sf::Drawable::GetScale (  )  const [inherited]

Get the current scale of the object.

Returns:
Current scale factor (always positive)

const Vector2f& sf::Drawable::GetCenter (  )  const [inherited]

Get the center of the object.

Returns:
Current position of the center

float sf::Drawable::GetRotation (  )  const [inherited]

Get the orientation of the object.

Rotation is always in the range [0, 360]

Returns:
Current rotation, in degrees

const Color& sf::Drawable::GetColor (  )  const [inherited]

Get the color of the object.

Returns:
Current color

Blend::Mode sf::Drawable::GetBlendMode (  )  const [inherited]

Get the current blending mode.

Returns:
Current blending mode

void sf::Drawable::Move ( float  OffsetX,
float  OffsetY 
) [inherited]

Move the object of a given offset (take 2 values).

Parameters:
OffsetX : X offset
OffsetY : Y offset

void sf::Drawable::Move ( const Vector2f &  Offset  )  [inherited]

Move the object of a given offset (take a 2D vector).

Parameters:
Offset : Amount of units to move the object of

void sf::Drawable::Scale ( float  FactorX,
float  FactorY 
) [inherited]

Scale the object (take 2 values).

Parameters:
FactorX : Scaling factor on X (must be strictly positive)
FactorY : Scaling factor on Y (must be strictly positive)

void sf::Drawable::Scale ( const Vector2f &  Factor  )  [inherited]

Scale the object (take a 2D vector).

Parameters:
Factor : Scaling factors (both values must be strictly positive)

void sf::Drawable::Rotate ( float  Angle  )  [inherited]

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

const Matrix3& sf::Drawable::GetMatrix (  )  const [protected, inherited]

Get the transform matrix of the drawable.

Returns:
Transform matrix

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