sfAnimatedSprite Class Reference

sfAnimatedSprite defines an animated sprite, ie a sequences of sprites More...

#include <AnimatedSprite.hpp>

Inheritance diagram for sfAnimatedSprite:

sfSprite sfDrawable List of all members.

Public Member Functions

 sfAnimatedSprite ()
 Default constructor.
 sfAnimatedSprite (const sfImage &Image, const sfIntRect &SourceRect, unsigned int FrameWidth, unsigned int FrameHeight)
 Construct the animated sprite from its parameters.
void CreateAnimation (const sfImage &Image, const sfIntRect &SourceRect, unsigned int FrameWidth, unsigned int FrameHeight)
 Create the animated sprite.
void AddFrame (const sfIntRect &FrameRect, int Index=-1)
 Add a frame to the animation, defined as a sub-rectangle of source image.
void SetTiming (float Timing)
 Set the delay between two consecutive frames.
float GetTiming () const
 Get the delay between two consecutive frames.
void SetImage (const sfImage &Image)
 Change the image of the sprite.
void SetSubRect (const sfIntRect &SubRect)
 Set the sub-rectangle of the sprite inside the source image.
const sfImageGetImage () const
 Get the source image of the sprite.
const sfIntRectGetSubRect () 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.
sfColor 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 Scale)
 Set the uniform 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 sfColor &Color)
 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 GetScale () const
 Get the uniform scale of the object.
float GetRotation () const
 Get the orientation of the object.
const sfColorGetColor () const
 Get the color of the object.
void Move (float OffsetX, float OffsetY)
 Move the object.
void Scale (float Factor)
 Scale the object.
void Rotate (float Angle)
 Rotate the object.

Protected Member Functions

virtual void Render (sfRenderWindow &Window)
 /see sfDrawable::Render

Detailed Description

sfAnimatedSprite defines an animated sprite, ie a sequences of sprites

Definition at line 40 of file AnimatedSprite.hpp.


Constructor & Destructor Documentation

sfAnimatedSprite::sfAnimatedSprite (  ) 

Default constructor.

Definition at line 35 of file AnimatedSprite.cpp.

sfAnimatedSprite::sfAnimatedSprite ( const sfImage Image,
const sfIntRect SourceRect,
unsigned int  FrameWidth,
unsigned int  FrameHeight 
)

Construct the animated sprite from its parameters.

Parameters:
Img : Image containing the sprite frames
SourceRect : Sub-rectangle contaning frames in source image
FrameWidth : Width of one frame of animation, in pixels
FrameHeight : Height of one frame of animation, in pixels

Definition at line 47 of file AnimatedSprite.cpp.


Member Function Documentation

void sfAnimatedSprite::CreateAnimation ( const sfImage Image,
const sfIntRect SourceRect,
unsigned int  FrameWidth,
unsigned int  FrameHeight 
)

Create the animated sprite.

Parameters:
Img : Image containing the sprite frames
SourceRect : Sub-rectangle contaning frames in source image
FrameWidth : Width of one frame of animation, in pixels
FrameHeight : Height of one frame of animation, in pixels

Definition at line 59 of file AnimatedSprite.cpp.

void sfAnimatedSprite::AddFrame ( const sfIntRect FrameRect,
int  Index = -1 
)

Add a frame to the animation, defined as a sub-rectangle of source image.

Parameters:
FrameRect : Rectangle defining the frame
Index : Index of insertion (-1 by default, means at the end)

Definition at line 85 of file AnimatedSprite.cpp.

void sfAnimatedSprite::SetTiming ( float  Timing  ) 

Set the delay between two consecutive frames.

Parameters:
Timing : New timing, in seconds

Definition at line 119 of file AnimatedSprite.cpp.

float sfAnimatedSprite::GetTiming (  )  const

Get the delay between two consecutive frames.

Returns:
Animation timing, in seconds

Definition at line 128 of file AnimatedSprite.cpp.

void sfAnimatedSprite::Render ( sfRenderWindow Window  )  [protected, virtual]

/see sfDrawable::Render

Reimplemented from sfSprite.

Definition at line 137 of file AnimatedSprite.cpp.

void sfSprite::SetImage ( const sfImage Image  )  [inherited]

Change the image of the sprite.

Parameters:
Image : New image

Definition at line 59 of file Sprite.cpp.

void sfSprite::SetSubRect ( const sfIntRect SubRect  )  [inherited]

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

Parameters:
SubRect : New sub-rectangle

Definition at line 73 of file Sprite.cpp.

const sfImage * sfSprite::GetImage (  )  const [inherited]

Get the source image of the sprite.

Returns:
Pointer to the image (can be NULL)

Definition at line 82 of file Sprite.cpp.

const sfIntRect & sfSprite::GetSubRect (  )  const [inherited]

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

Returns:
Sub-rectangle

Definition at line 91 of file Sprite.cpp.

float sfSprite::GetWidth (  )  const [inherited]

Get the sprite width.

Returns:
Width of the sprite

Definition at line 100 of file Sprite.cpp.

float sfSprite::GetHeight (  )  const [inherited]

Get the sprite height.

Returns:
Height of the sprite

Definition at line 109 of file Sprite.cpp.

sfColor sfSprite::GetPixel ( unsigned int  X,
unsigned int  Y 
) const [inherited]

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 118 of file Sprite.cpp.

void sfDrawable::SetLeft ( float  Left  )  [inherited]

Set the left position of the object.

Parameters:
Left : New left position

Definition at line 60 of file Drawable.cpp.

void sfDrawable::SetTop ( float  Top  )  [inherited]

Set the top position of the object.

Parameters:
Top : New top position

Definition at line 69 of file Drawable.cpp.

void sfDrawable::SetScale ( float  Scale  )  [inherited]

Set the uniform scale of the object.

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

Definition at line 78 of file Drawable.cpp.

void sfDrawable::SetRotation ( float  Rotation  )  [inherited]

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

Definition at line 88 of file Drawable.cpp.

void sfDrawable::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 98 of file Drawable.cpp.

void sfDrawable::SetColor ( const sfColor Color  )  [inherited]

Set the color of the object.

Parameters:
Color : New color

Definition at line 108 of file Drawable.cpp.

float sfDrawable::GetLeft (  )  const [inherited]

Get the left position of the object.

Returns:
Current left position

Definition at line 117 of file Drawable.cpp.

float sfDrawable::GetTop (  )  const [inherited]

Get the top position of the object.

Returns:
Current top position

Definition at line 126 of file Drawable.cpp.

float sfDrawable::GetScale (  )  const [inherited]

Get the uniform scale of the object.

Returns:
Current scale position (always positive)

Definition at line 135 of file Drawable.cpp.

float sfDrawable::GetRotation (  )  const [inherited]

Get the orientation of the object.

Returns:
Current rotation, in degrees

Definition at line 144 of file Drawable.cpp.

const sfColor & sfDrawable::GetColor (  )  const [inherited]

Get the color of the object.

Returns:
Current color

Definition at line 153 of file Drawable.cpp.

void sfDrawable::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 162 of file Drawable.cpp.

void sfDrawable::Scale ( float  Factor  )  [inherited]

Scale the object.

Parameters:
Factor : Scaling factor (must be strictly positive)

Definition at line 172 of file Drawable.cpp.

void sfDrawable::Rotate ( float  Angle  )  [inherited]

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

Definition at line 182 of file Drawable.cpp.


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