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, float Left=0.f, float Top=0.f, float ScaleX=1.f, float ScaleY=1.f, 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).
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.
float GetWidth () const
 Get the sprite width.
float GetHeight () const
 Get the sprite height.
Color GetPixel (unsigned int X, unsigned int Y) const
 Get the color of a given pixel in the sprite.
void SetLeft (float Left)
 Set the left position of the object.
void SetTop (float Top)
 Set the top position of the object.
void SetPosition (float Left, float Top)
 Set the position of the object.
void SetScaleX (float Scale)
 Set the horizontal scale of the object.
void SetScaleY (float Scale)
 Set the vertical scale of the object.
void SetScale (float ScaleX, float ScaleY)
 Set the scale of the object.
void SetRotation (float Rotation)
 Set the orientation of the object.
void SetRotationCenter (float X, float Y)
 Set the center of rotation, in coordinates relative to 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.
float GetLeft () const
 Get the left position of the object.
float GetTop () const
 Get the top position of the object.
float GetScaleX () const
 Get the horizontal scale of the object.
float GetScaleY () const
 Get the vertical scale 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.
void Scale (float FactorX, float FactorY)
 Scale the object.
void Rotate (float Angle)
 Rotate the object.

Protected Member Functions

virtual void Render (const RenderWindow &Window) const
 /see Drawable::Render

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,
float  Left = 0.f,
float  Top = 0.f,
float  ScaleX = 1.f,
float  ScaleY = 1.f,
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
Left : Left coordinate of the sprite (0 by default)
Top : Top coordinate of the sprite (0 by default)
ScaleX : Horizontal scale (1 by default)
ScaleY : Vertical scale (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).

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

float sf::Sprite::GetWidth (  )  const

Get the sprite width.

Returns:
Width of the sprite

float sf::Sprite::GetHeight (  )  const

Get the sprite height.

Returns:
Height 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::SetLeft ( float  Left  )  [inherited]

Set the left position of the object.

Parameters:
Left : New left coordinate

void sf::Drawable::SetTop ( float  Top  )  [inherited]

Set the top position of the object.

Parameters:
Top : New top coordinate

void sf::Drawable::SetPosition ( float  Left,
float  Top 
) [inherited]

Set the position of the object.

Parameters:
Left : New left coordinate
Top : New top coordinate

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

Set the horizontal scale of the object.

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

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

Set the vertical scale of the object.

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

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

Set the scale of the object.

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

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

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

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

Set the center of rotation, in coordinates relative to the object.

The default rotation center is (0, 0)

Parameters:
X : X coordinate of the center of rotation
Y : Y coordinate of the center of rotation

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

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

Get the left position of the object.

Returns:
Current left position

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

Get the top position of the object.

Returns:
Current top position

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

Get the horizontal scale of the object.

Returns:
Current X scale factor (always positive)

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

Get the vertical scale of the object.

Returns:
Current Y scale factor (always positive)

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

Get the orientation of the object.

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.

Parameters:
OffsetX : Offset on the X axis
OffsetY : Offset on the Y axis

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

Scale the object.

Parameters:
FactorX : Horizontal scaling factor (must be strictly positive)
FactorY : Vertical scaling factor (must be strictly positive)

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

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

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