sfString Class Reference

sfString defines a graphical 2D text, that can be drawn on screen More...

#include <String.hpp>

Inheritance diagram for sfString:

sfDrawable List of all members.

Public Member Functions

 sfString (const std::string &Text="", const std::string &Font="", float Size=32.f)
 Default constructor.
void SetText (const std::string &Text)
 Set the text.
void SetFont (const std::string &Font)
 Set the font of the string.
void SetSize (float Size)
 Set the size of the string.
const std::string & GetText () const
 Get the text.
const std::string & GetFont () const
 Get the font used by the string.
float GetSize () const
 Get the size of the characters.
sfFloatRect GetRect () const
 Get the string rectangle on screen.
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.

Static Public Member Functions

static void PreloadFont (const std::string &Font, float Size)
 Preload a bitmap font (otherwise, it is done the first time the font is drawn).

Protected Member Functions

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

Detailed Description

sfString defines a graphical 2D text, that can be drawn on screen

Definition at line 39 of file String.hpp.


Constructor & Destructor Documentation

sfString::sfString ( const std::string &  Text = "",
const std::string &  Font = "",
float  Size = 32.f 
)

Default constructor.

Parameters:
Text : Text assigned to the string ("" by default)
Font : Font used to draw the string ("" by default - use default font)
Size : Characters size, in pixels (32 by default)

Definition at line 37 of file String.cpp.


Member Function Documentation

void sfString::PreloadFont ( const std::string &  Font,
float  Size 
) [static]

Preload a bitmap font (otherwise, it is done the first time the font is drawn).

Parameters:
Font : Font to load
Size : Requested character size

Definition at line 49 of file String.cpp.

void sfString::SetText ( const std::string &  Text  ) 

Set the text.

Parameters:
Text : New text

Definition at line 59 of file String.cpp.

void sfString::SetFont ( const std::string &  Font  ) 

Set the font of the string.

Parameters:
Font : Font filename

Definition at line 68 of file String.cpp.

void sfString::SetSize ( float  Size  ) 

Set the size of the string.

Parameters:
Size : New size, in pixels

Definition at line 77 of file String.cpp.

const std::string & sfString::GetText (  )  const

Get the text.

Returns:
Text

Definition at line 86 of file String.cpp.

const std::string & sfString::GetFont (  )  const

Get the font used by the string.

Returns:
Font name

Definition at line 95 of file String.cpp.

float sfString::GetSize (  )  const

Get the size of the characters.

Returns:
Size of the characters

Definition at line 104 of file String.cpp.

sfFloatRect sfString::GetRect (  )  const

Get the string rectangle on screen.

Returns:
Rectangle contaning the string in screen coordinates

Definition at line 113 of file String.cpp.

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

/see sfDrawable::Render

Implements sfDrawable.

Definition at line 161 of file String.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: