String defines a graphical 2D text, that can be drawn on screen. More...
#include <String.hpp>
Public Types | |
enum | Style { Regular = 0, Bold = 1 << 0, Italic = 1 << 1, Underlined = 1 << 2 } |
Enumerate the string drawing styles. More... | |
Public Member Functions | |
String () | |
Default constructor. More... | |
String (const Unicode::Text &Text, const Font &CharFont=Font::GetDefaultFont(), float Size=30.f) | |
Construct the string from any kind of text. More... | |
void | SetText (const Unicode::Text &Text) |
Set the text (from any kind of string) More... | |
void | SetFont (const Font &CharFont) |
Set the font of the string. More... | |
void | SetSize (float Size) |
Set the size of the string The default size is 30. More... | |
void | SetStyle (unsigned long TextStyle) |
Set the style of the text The default style is Regular. More... | |
const Unicode::Text & | GetText () const |
Get the text (the returned text can be converted implicitely to any kind of string) More... | |
const Font & | GetFont () const |
Get the font used by the string. More... | |
float | GetSize () const |
Get the size of the characters. More... | |
unsigned long | GetStyle () const |
Get the style of the text. More... | |
sf::Vector2f | GetCharacterPos (std::size_t Index) const |
Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied) More... | |
FloatRect | GetRect () const |
Get the string rectangle on screen. More... | |
void | SetPosition (float X, float Y) |
Set the position of the object (take 2 values) More... | |
void | SetPosition (const Vector2f &Position) |
Set the position of the object (take a 2D vector) More... | |
void | SetX (float X) |
Set the X position of the object. More... | |
void | SetY (float Y) |
Set the Y position of the object. More... | |
void | SetScale (float ScaleX, float ScaleY) |
Set the scale of the object (take 2 values) More... | |
void | SetScale (const Vector2f &Scale) |
Set the scale of the object (take a 2D vector) More... | |
void | SetScaleX (float FactorX) |
Set the X scale factor of the object. More... | |
void | SetScaleY (float FactorY) |
Set the Y scale factor of the object. More... | |
void | SetCenter (float CenterX, float CenterY) |
Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). More... | |
void | SetCenter (const Vector2f &Center) |
Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector). More... | |
void | SetRotation (float Rotation) |
Set the orientation of the object. More... | |
void | SetColor (const Color &Col) |
Set the color of the object. More... | |
void | SetBlendMode (Blend::Mode Mode) |
Set the blending mode for the object. More... | |
const Vector2f & | GetPosition () const |
Get the position of the object. More... | |
const Vector2f & | GetScale () const |
Get the current scale of the object. More... | |
const Vector2f & | GetCenter () const |
Get the center of the object. More... | |
float | GetRotation () const |
Get the orientation of the object. More... | |
const Color & | GetColor () const |
Get the color of the object. More... | |
Blend::Mode | GetBlendMode () const |
Get the current blending mode. More... | |
void | Move (float OffsetX, float OffsetY) |
Move the object of a given offset (take 2 values) More... | |
void | Move (const Vector2f &Offset) |
Move the object of a given offset (take a 2D vector) More... | |
void | Scale (float FactorX, float FactorY) |
Scale the object (take 2 values) More... | |
void | Scale (const Vector2f &Factor) |
Scale the object (take a 2D vector) More... | |
void | Rotate (float Angle) |
Rotate the object. More... | |
sf::Vector2f | TransformToLocal (const sf::Vector2f &Point) const |
Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point) More... | |
sf::Vector2f | TransformToGlobal (const sf::Vector2f &Point) const |
Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point) More... | |
Protected Member Functions | |
virtual void | Render (RenderTarget &Target) const |
/see Drawable::Render More... | |
const Matrix3 & | GetMatrix () const |
Get the transform matrix of the drawable. More... | |
const Matrix3 & | GetInverseMatrix () const |
Get the inverse transform matrix of the drawable. More... | |
String defines a graphical 2D text, that can be drawn on screen.
Definition at line 44 of file String.hpp.
enum sf::String::Style |
Enumerate the string drawing styles.
Enumerator | |
---|---|
Regular |
Regular characters, no style. |
Bold |
Characters are bold. |
Italic |
Characters are in italic. |
Underlined |
Characters are underlined. |
Definition at line 51 of file String.hpp.
sf::String::String | ( | ) |
Default constructor.
Definition at line 39 of file String.cpp.
|
explicit |
Construct the string from any kind of text.
Text | : Text assigned to the string |
Font | : Font used to draw the string (SFML built-in font by default) |
Size | : Characters size (30 by default) |
Definition at line 52 of file String.cpp.
|
inherited |
Get the current blending mode.
Definition at line 258 of file Drawable.cpp.
|
inherited |
Get the center of the object.
Definition at line 231 of file Drawable.cpp.
sf::Vector2f sf::String::GetCharacterPos | ( | std::size_t | Index | ) | const |
Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied)
Index | : Index of the character |
Definition at line 153 of file String.cpp.
|
inherited |
const Font & sf::String::GetFont | ( | ) | const |
|
protectedinherited |
Get the inverse transform matrix of the drawable.
Definition at line 350 of file Drawable.cpp.
|
protectedinherited |
Get the transform matrix of the drawable.
Definition at line 334 of file Drawable.cpp.
|
inherited |
Get the position of the object.
Definition at line 213 of file Drawable.cpp.
FloatRect sf::String::GetRect | ( | ) | const |
Get the string rectangle on screen.
Definition at line 195 of file String.cpp.
|
inherited |
Get the orientation of the object.
Rotation is always in the range [0, 360]
Definition at line 240 of file Drawable.cpp.
|
inherited |
Get the current scale of the object.
Definition at line 222 of file Drawable.cpp.
float sf::String::GetSize | ( | ) | const |
Get the size of the characters.
Definition at line 133 of file String.cpp.
unsigned long sf::String::GetStyle | ( | ) | const |
Get the style of the text.
Definition at line 142 of file String.cpp.
const Unicode::Text & sf::String::GetText | ( | ) | const |
Get the text (the returned text can be converted implicitely to any kind of string)
Definition at line 115 of file String.cpp.
|
inherited |
Move the object of a given offset (take 2 values)
OffsetX | : X offset |
OffsetY | : Y offset |
Definition at line 268 of file Drawable.cpp.
|
inherited |
Move the object of a given offset (take a 2D vector)
Offset | : Amount of units to move the object of |
Definition at line 278 of file Drawable.cpp.
|
protectedvirtual |
/see Drawable::Render
/see sfDrawable::Render
Implements sf::Drawable.
Definition at line 213 of file String.cpp.
|
inherited |
Rotate the object.
Angle | : Angle of rotation, in degrees |
Definition at line 306 of file Drawable.cpp.
|
inherited |
Scale the object (take 2 values)
FactorX | : Scaling factor on X (must be strictly positive) |
FactorY | : Scaling factor on Y (must be strictly positive) |
Definition at line 287 of file Drawable.cpp.
|
inherited |
Scale the object (take a 2D vector)
Factor | : Scaling factors (both values must be strictly positive) |
Definition at line 297 of file Drawable.cpp.
|
inherited |
Set the blending mode for the object.
The default blend mode is Blend::Alpha
Mode | : New blending mode |
The default blend mode is Blend::Alpha
Definition at line 204 of file Drawable.cpp.
|
inherited |
Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).
The default center is (0, 0)
CenterX | : X coordinate of the center |
CenterY | : Y coordinate of the center |
The default center is (0, 0)
Definition at line 157 of file Drawable.cpp.
|
inherited |
Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).
The default center is (0, 0)
Center | : New center |
The default center is (0, 0)
Definition at line 171 of file Drawable.cpp.
|
inherited |
Set the color of the object.
The default color is white
Col | : New color |
The default color is white
Definition at line 194 of file Drawable.cpp.
void sf::String::SetFont | ( | const Font & | CharFont | ) |
|
inherited |
Set the position of the object (take 2 values)
X | : New X coordinate |
Y | : New Y coordinate |
Definition at line 65 of file Drawable.cpp.
|
inherited |
Set the position of the object (take a 2D vector)
Position | : New position |
Definition at line 75 of file Drawable.cpp.
|
inherited |
Set the orientation of the object.
Rotation | : Angle of rotation, in degrees |
Definition at line 180 of file Drawable.cpp.
|
inherited |
Set the scale of the object (take 2 values)
ScaleX | : New horizontal scale (must be strictly positive) |
ScaleY | : New vertical scale (must be strictly positive) |
Definition at line 107 of file Drawable.cpp.
|
inherited |
Set the scale of the object (take a 2D vector)
Scale | : New scale (both values must be strictly positive) |
Definition at line 117 of file Drawable.cpp.
|
inherited |
Set the X scale factor of the object.
X | : New X scale factor |
Definition at line 127 of file Drawable.cpp.
|
inherited |
Set the Y scale factor of the object.
Y | : New Y scale factor |
Definition at line 141 of file Drawable.cpp.
void sf::String::SetSize | ( | float | Size | ) |
Set the size of the string The default size is 30.
Set the size of the string.
Size | : New size, in pixels |
Definition at line 88 of file String.cpp.
void sf::String::SetStyle | ( | unsigned long | TextStyle | ) |
Set the style of the text The default style is Regular.
TextStyle | : New text style, (combination of Style enum values) |
Definition at line 102 of file String.cpp.
void sf::String::SetText | ( | const Unicode::Text & | Text | ) |
Set the text (from any kind of string)
Text | : New text |
Definition at line 65 of file String.cpp.
|
inherited |
Set the X position of the object.
X | : New X coordinate |
Definition at line 85 of file Drawable.cpp.
|
inherited |
Set the Y position of the object.
Y | : New Y coordinate |
Definition at line 96 of file Drawable.cpp.
|
inherited |
Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point)
Point | : Point to transform |
Definition at line 325 of file Drawable.cpp.
|
inherited |
Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point)
Point | : Point to transform |
Definition at line 316 of file Drawable.cpp.