TextAttributes
Functions
void |
|
TextAttributes const & |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
void |
|
double |
|
void |
Detailed Description
-
class TextAttributes
This class represents all the information related to displaying a piece of text associated with an Entity.
Public Functions
-
TextAttributes()
-
TextAttributes(TextAttributes const &that)
-
~TextAttributes()
-
void Set(TextAttributes const &that)
-
TextAttributes const &operator=(TextAttributes const &that)
-
void GetInsertionPoint(Point &out_point) const
Gets the lower left corner insertion point for the text. Returned to the user.
-
void GetInsertionPoint(float &out_x, float &out_y, float &out_z) const
Gets the lower left corner insertion point for the text. Returned to the user.
-
void SetInsertionPoint(Point const &in_point)
Sets the lower left corner insertion point for the text. This will replace an existing insertion point.
-
void SetInsertionPoint(float in_x, float in_y, float in_z)
Sets the lower left corner insertion point for the text. This will replace an existing insertion point.
-
void GetFontSize(float &out_size) const
Gets the font size for the text. Returned to the user.
-
void SetFontSize(float const in_size)
Sets the font size of the text. This will replace an existing font size.
-
void GetFontSizeUnits(Font::Size::Units &out_units) const
Gets the font size units for the text. Returned to the user.
-
void SetFontSizeUnits(Font::Size::Units const in_units)
Sets the font size units for the text. This will replace the existing font size units.
-
void GetFontName(char *out_font_name) const
Gets the font name for the text. Returned to the user.
-
void SetFontName(char const *in_font_name)
Sets the font name for the text. This will replace an existing font name.
-
void GetOrientation(Orientation &out_orientation) const
Gets the Orientation for the text. Returned to the user.
-
void SetOrientation(Orientation const &in_orientation)
Sets the Orientation for the text. This will replace an existing Orientation.
-
void GetRGBColor(RGBColor &out_color) const
Gets the color information for the text. Returned to the user.
-
void GetRGBColor(float &out_r, float &out_g, float &out_b) const
Gets the color information for the text. Returned to the user.
-
void SetRGBColor(RGBColor const &in_color)
Sets the color information for the text. This will replace an existing color.
-
void SetRGBColor(float in_r, float in_g, float in_b)
Sets the color information for the text. This will replace an existing color.
-
bool IsBold() const
Return the option text bold to screen value.
-
bool IsItalic() const
Return the option text italic to screen value.
-
bool IsUnderlined() const
Return the option text underlined to screen value.
-
bool IsStrikedThrough() const
Return the option text striked out to screen value.
-
bool IsOverlined() const
Return the option text overlined to screen value.
-
bool IsStreched() const
Return the option text streched to screen value.
-
bool IsWired() const
Return true if the original font is a wirefame font.
-
bool IsFixedWidth() const
Return true if the original font is not proportional (each glyph has the same width).
-
void SetFormat(char const &in_format)
Sets format for the text. This will replace an existing format.
-
double WidthScale() const
Return width scale value.
-
void SetWidthScale(double const width_scale)
Set width scale value.
-
TextAttributes()