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)
 Set 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 object (by changing its scale factors).
const ImageGetImage () const
 Get the source image of the sprite.
const IntRectGetSubRect () 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 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.
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 ColorGetColor () const
 Get the color of the object.
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 (RenderWindow &Window)
 /see sfDrawable::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.

Definition at line 38 of file Sprite.cpp.

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)

Definition at line 49 of file Sprite.cpp.


Member Function Documentation

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

Set the image of the sprite.

Parameters:
Img : New image

Definition at line 61 of file Sprite.cpp.

void sf::Sprite::SetSubRect ( const IntRect SubRect  ) 

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

Parameters:
SubRect : New sub-rectangle

Definition at line 75 of file Sprite.cpp.

void sf::Sprite::Resize ( float  Width,
float  Height 
)

Resize the object (by changing its scale factors).

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

Definition at line 84 of file Sprite.cpp.

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

Get the source image of the sprite.

Returns:
Pointer to the image (can be NULL)

Definition at line 99 of file Sprite.cpp.

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

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

Returns:
Sub-rectangle

Definition at line 108 of file Sprite.cpp.

float sf::Sprite::GetWidth (  )  const

Get the sprite width.

Returns:
Width of the sprite

Definition at line 117 of file Sprite.cpp.

float sf::Sprite::GetHeight (  )  const

Get the sprite height.

Returns:
Height of the sprite

Definition at line 126 of file Sprite.cpp.

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)

Definition at line 135 of file Sprite.cpp.

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

/see sfDrawable::Render

Implements sf::Drawable.

Definition at line 144 of file Sprite.cpp.

void sf::Drawable::SetLeft ( float  Left  )  [inherited]

Set the left position of the object.

Parameters:
Left : New left position

Definition at line 63 of file Drawable.cpp.

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

Set the top position of the object.

Parameters:
Top : New top position

Definition at line 72 of file Drawable.cpp.

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)

Definition at line 81 of file Drawable.cpp.

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

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

Definition at line 91 of file Drawable.cpp.

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

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

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

Definition at line 101 of file Drawable.cpp.

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

Set the color of the object.

Parameters:
Col : New color

Definition at line 111 of file Drawable.cpp.

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

Get the left position of the object.

Returns:
Current left position

Definition at line 120 of file Drawable.cpp.

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

Get the top position of the object.

Returns:
Current top position

Definition at line 129 of file Drawable.cpp.

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

Get the horizontal scale of the object.

Returns:
Current X scale factor (always positive)

Definition at line 138 of file Drawable.cpp.

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

Get the vertical scale of the object.

Returns:
Current Y scale factor (always positive)

Definition at line 147 of file Drawable.cpp.

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

Get the orientation of the object.

Returns:
Current rotation, in degrees

Definition at line 156 of file Drawable.cpp.

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

Get the color of the object.

Returns:
Current color

Definition at line 165 of file Drawable.cpp.

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

Definition at line 174 of file Drawable.cpp.

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)

Definition at line 184 of file Drawable.cpp.

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

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

Definition at line 194 of file Drawable.cpp.


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