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. | |
String (const Unicode::Text &Text, const Font &CharFont=Font::GetDefaultFont(), float Size=30.f) | |
Construct the string from any kind of text. | |
void | SetText (const Unicode::Text &Text) |
Set the text (from any kind of string) | |
void | SetFont (const Font &CharFont) |
Set the font of the string. | |
void | SetSize (float Size) |
Set the size of the string The default size is 30. | |
void | SetStyle (unsigned long TextStyle) |
Set the style of the text The default style is Regular. | |
const Unicode::Text & | GetText () const |
Get the text (the returned text can be converted implicitely to any kind of string) | |
const Font & | GetFont () const |
Get the font used by the string. | |
float | GetSize () const |
Get the size of the characters. | |
unsigned long | GetStyle () const |
Get the style of the text. | |
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) | |
FloatRect | GetRect () const |
Get the string rectangle on screen. | |
void | SetPosition (float X, float Y) |
Set the position of the object (take 2 values) | |
void | SetPosition (const Vector2f &Position) |
Set the position of the object (take a 2D vector) | |
void | SetX (float X) |
Set the X position of the object. | |
void | SetY (float Y) |
Set the Y position of the object. | |
void | SetScale (float ScaleX, float ScaleY) |
Set the scale of the object (take 2 values) | |
void | SetScale (const Vector2f &Scale) |
Set the scale of the object (take a 2D vector) | |
void | SetScaleX (float FactorX) |
Set the X scale factor of the object. | |
void | SetScaleY (float FactorY) |
Set the Y scale factor of the object. | |
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). | |
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). | |
void | SetRotation (float Rotation) |
Set the orientation of the object. | |
void | SetColor (const Color &Col) |
Set the color of the object. | |
void | SetBlendMode (Blend::Mode Mode) |
Set the blending mode for the object. | |
const Vector2f & | GetPosition () const |
Get the position of the object. | |
const Vector2f & | GetScale () const |
Get the current scale of the object. | |
const Vector2f & | GetCenter () const |
Get the center of the object. | |
float | GetRotation () const |
Get the orientation of the object. | |
const Color & | GetColor () const |
Get the color of the object. | |
Blend::Mode | GetBlendMode () const |
Get the current blending mode. | |
void | Move (float OffsetX, float OffsetY) |
Move the object of a given offset (take 2 values) | |
void | Move (const Vector2f &Offset) |
Move the object of a given offset (take a 2D vector) | |
void | Scale (float FactorX, float FactorY) |
Scale the object (take 2 values) | |
void | Scale (const Vector2f &Factor) |
Scale the object (take a 2D vector) | |
void | Rotate (float Angle) |
Rotate the object. | |
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) | |
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) | |
Protected Member Functions | |
virtual void | Render (RenderTarget &Target) const |
/see Drawable::Render | |
const Matrix3 & | GetMatrix () const |
Get the transform matrix of the drawable. | |
const Matrix3 & | GetInverseMatrix () const |
Get the inverse transform matrix of the drawable. | |
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.
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.
|
explicit |
|
inherited |
Get the current blending mode.
|
inherited |
Get the center of the object.
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 |
|
inherited |
Get the color of the object.
|
protectedinherited |
Get the inverse transform matrix of the drawable.
|
protectedinherited |
Get the transform matrix of the drawable.
|
inherited |
Get the position of the object.
FloatRect sf::String::GetRect | ( | ) | const |
Get the string rectangle on screen.
|
inherited |
Get the orientation of the object.
Rotation is always in the range [0, 360]
|
inherited |
Get the current scale of the object.
float sf::String::GetSize | ( | ) | const |
Get the size of the characters.
unsigned long sf::String::GetStyle | ( | ) | const |
Get the style of the text.
const Unicode::Text& sf::String::GetText | ( | ) | const |
Get the text (the returned text can be converted implicitely to any kind of string)
|
inherited |
Move the object of a given offset (take 2 values)
OffsetX | : X offset |
OffsetY | : Y offset |
|
inherited |
Move the object of a given offset (take a 2D vector)
Offset | : Amount of units to move the object of |
|
protectedvirtual |
/see Drawable::Render
Implements sf::Drawable.
|
inherited |
Rotate the object.
Angle | : Angle of rotation, in degrees |
|
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) |
|
inherited |
Scale the object (take a 2D vector)
Factor | : Scaling factors (both values must be strictly positive) |
|
inherited |
Set the blending mode for the object.
The default blend mode is Blend::Alpha
Mode | : New blending mode |
|
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 |
|
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 |
|
inherited |
Set the color of the object.
The default color is white
Col | : New color |
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 |
|
inherited |
Set the position of the object (take a 2D vector)
Position | : New position |
|
inherited |
Set the orientation of the object.
Rotation | : Angle of rotation, in degrees |
|
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) |
|
inherited |
Set the scale of the object (take a 2D vector)
Scale | : New scale (both values must be strictly positive) |
|
inherited |
Set the X scale factor of the object.
X | : New X scale factor |
|
inherited |
Set the Y scale factor of the object.
Y | : New Y scale factor |
void sf::String::SetSize | ( | float | Size | ) |
Set the size of the string The default size is 30.
Size | : New size, in pixels |
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) |
void sf::String::SetText | ( | const Unicode::Text & | Text | ) |
Set the text (from any kind of string)
Text | : New text |
|
inherited |
Set the X position of the object.
X | : New X coordinate |
|
inherited |
Set the Y position of the object.
Y | : New Y coordinate |
|
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 |
|
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 |