sfTiledBackground Class Reference

sfTiledBackground defines a static background, made of tiles. More...

#include <TiledBackground.hpp>

Inheritance diagram for sfTiledBackground:

sfDrawable List of all members.

Public Member Functions

 sfTiledBackground ()
 Default constructor.
 sfTiledBackground (const sfImage &Image, unsigned int TileSize, unsigned int NbTilesX, unsigned int NbTilesY)
 Construct the background.
 sfTiledBackground (const sfTiledBackground &Copy)
 Copy constructor.
 ~sfTiledBackground ()
 Destructor.
void Initialize (const sfImage &Image, unsigned int TileSize, unsigned int NbTilesX, unsigned int NbTilesY)
 Initialize background parameters.
void SetTile (unsigned int Left, unsigned int Top, unsigned int IndexX, unsigned int IndexY)
 Setup a tile.
sfTiledBackgroundoperator= (const sfTiledBackground &Other)
 Assignment operator.
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

Classes

struct  Tile
 Structure defining a tile.

Detailed Description

sfTiledBackground defines a static background, made of tiles.

The purpose of this class is to provide an easy and optimized way to manage backgrounds

Definition at line 43 of file TiledBackground.hpp.


Constructor & Destructor Documentation

sfTiledBackground::sfTiledBackground (  ) 

Default constructor.

Definition at line 37 of file TiledBackground.cpp.

sfTiledBackground::sfTiledBackground ( const sfImage Image,
unsigned int  TileSize,
unsigned int  NbTilesX,
unsigned int  NbTilesY 
)

Construct the background.

Parameters:
Img : Image to use as a tileset
TileSize : Size of tiles, in pixels
NbTilesX : Background width, in number of tiles
NbTilesY : Background height, in number of tiles

Definition at line 54 of file TiledBackground.cpp.

sfTiledBackground::sfTiledBackground ( const sfTiledBackground Copy  ) 

Copy constructor.

Parameters:
Copy : Instance to copy

Definition at line 73 of file TiledBackground.cpp.

sfTiledBackground::~sfTiledBackground (  ) 

Destructor.

Definition at line 90 of file TiledBackground.cpp.


Member Function Documentation

void sfTiledBackground::Initialize ( const sfImage Image,
unsigned int  TileSize,
unsigned int  NbTilesX,
unsigned int  NbTilesY 
)

Initialize background parameters.

Parameters:
Img : Image to use as a tileset
TileSize : Size of tiles, in pixels
NbTilesX : Background width, in number of tiles (0 by default)
NbTilesY : Background height, in number of tiles (0 by default)

Definition at line 114 of file TiledBackground.cpp.

void sfTiledBackground::SetTile ( unsigned int  Left,
unsigned int  Top,
unsigned int  IndexX,
unsigned int  IndexY 
)

Setup a tile.

Parameters:
Left : X coordinate of tile to set
Top : Y coordinate of tile to set
IndexX : X index of tile in tileset
IndexY : Y index of tile in tileset

Definition at line 128 of file TiledBackground.cpp.

sfTiledBackground & sfTiledBackground::operator= ( const sfTiledBackground Other  ) 

Assignment operator.

Parameters:
Other : Instance to assign
Returns:
Reference to the background

Definition at line 148 of file TiledBackground.cpp.

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

/see sfDrawable::Render

Implements sfDrawable.

Definition at line 100 of file TiledBackground.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: