![]() |
Murl Engine API
Version 2018.3
|
The IText property interface. More...
#include <murl_graph_i_text.h>
The IText property interface.
This interface represents a generic way to describe an object used for text output.
Public Member Functions | |
virtual IFontResourceTarget * | GetFontResourceTarget ()=0 |
Get a mutable Graph::IFontResourceTarget container. More... | |
virtual const IFontResourceTarget * | GetFontResourceTarget () const =0 |
Get a constant Graph::IFontResourceTarget container. More... | |
virtual Bool | SetSystemFontName (const String &fontName)=0 |
Set the ID of the system font used to render the text. More... | |
virtual const String & | GetSystemFontName () const =0 |
Get the ID of the system font used to render the text. More... | |
virtual Bool | SetFontType (IEnums::FontType fontType)=0 |
Set the type of font used for rendering. More... | |
virtual IEnums::FontType | GetFontType () const =0 |
Get the type of font used for rendering. More... | |
virtual Bool | SetFontSize (Real fontSize)=0 |
Set the font size. More... | |
virtual Real | GetFontSize () const =0 |
Get the font size. More... | |
virtual Bool | SetTextColor (const Color &textColor)=0 |
Set the foreground (text) color used for rendering the text. More... | |
virtual const Color & | GetTextColor () const =0 |
Get the text color. More... | |
virtual Bool | SetBackgroundColor (const Color &backgroundColor)=0 |
Set the background color used for rendering. More... | |
virtual const Color & | GetBackgroundColor () const =0 |
Get the background color. More... | |
virtual ITextNodeTarget * | GetParentTextNodeTarget ()=0 |
Get the optional mutable Graph::ITextNodeTarget parent container. More... | |
virtual const ITextNodeTarget * | GetParentTextNodeTarget () const =0 |
Get the optional constant Graph::ITextNodeTarget parent container. More... | |
virtual ITextureNodeTarget * | GetOutputTextureNodeTarget ()=0 |
Get the optional mutable output Graph::ITextureNodeTarget container. More... | |
virtual const ITextureNodeTarget * | GetOutputTextureNodeTarget () const =0 |
Get the optional constant output Graph::ITextureNodeTarget container. More... | |
virtual ITextResourceTarget * | GetTextResourceTarget ()=0 |
Get a mutable Graph::ITextResourceTarget container. More... | |
virtual const ITextResourceTarget * | GetTextResourceTarget () const =0 |
Get a constant Graph::ITextResourceTarget container. More... | |
virtual Bool | SetText (const String &text)=0 |
Set the text to be displayed. More... | |
virtual const String & | GetText () const =0 |
Get the displayed text. More... | |
virtual Bool | SetSpacing (Real spacing)=0 |
Set the character spacing value. More... | |
virtual Real | GetSpacing () const =0 |
Get the character spacing value. More... | |
virtual Bool | SetLeading (Real leading)=0 |
Set the leading value. More... | |
virtual Real | GetLeading () const =0 |
Get the leading value. More... | |
virtual Bool | SetEmbolding (Real strength)=0 |
Set the embolding strength value. More... | |
virtual Real | GetEmbolding () const =0 |
Get the embolding strength value. More... | |
virtual Bool | SetBlur (Real strength)=0 |
Set the blur strength value. More... | |
virtual Real | GetBlur () const =0 |
Get the blur strength value. More... | |
virtual Bool | SetSpaceWidthFactor (Real factor)=0 |
Set the space width factor. More... | |
virtual Real | GetSpaceWidthFactor () const =0 |
Get the space width factor. More... | |
virtual Bool | SetDigitWidthFactor (Real factor)=0 |
Set the digit width factor. More... | |
virtual Real | GetDigitWidthFactor () const =0 |
Get the digit width factor. More... | |
virtual Bool | SetSameDigitWidthEnabled (Bool enabled)=0 |
Enable/disable unified digit width. More... | |
virtual Bool | IsSameDigitWidthEnabled () const =0 |
Check if unified digit width is enabled. More... | |
virtual Bool | SetWordWrappingEnabled (Bool enabled)=0 |
Enable/disable word wrapping. More... | |
virtual Bool | IsWordWrappingEnabled () const =0 |
Check if word wrapping is enabled. More... | |
virtual Bool | SetTextAlignmentX (IEnums::TextAlignmentX alignment)=0 |
Set the horizontal text alignment. More... | |
virtual IEnums::TextAlignmentX | GetTextAlignmentX () const =0 |
Get the horizontal text alignment. More... | |
virtual Bool | SetTextAlignmentY (IEnums::TextAlignmentY alignment)=0 |
Set the vertical text alignment. More... | |
virtual IEnums::TextAlignmentY | GetTextAlignmentY () const =0 |
Get the vertical text alignment. More... | |
virtual Bool | QueryTextSize (const String &text, Real &sizeX, Real &sizeY) const =0 |
Query the dimensions of a given UTF8 text. More... | |
|
pure virtual |
Get a mutable Graph::IFontResourceTarget container.
This method returns a mutable pointer to a Graph::IFontResourceTarget container, which allows to add, remove or query the font resources referenced by a node implementing this interface.
|
pure virtual |
Get a constant Graph::IFontResourceTarget container.
This method returns a constant pointer to a Graph::IFontResourceTarget container, which allows to query the font resources referenced by a node implementing this interface.
Set the ID of the system font used to render the text.
fontName | A valid system font name, e.g. "SansBold". |
|
pure virtual |
Get the ID of the system font used to render the text.
|
pure virtual |
Set the type of font used for rendering.
If not specified, the actual font type is retrieved from the given values for either system font name or the font resource. Once initialized, the node's font type cannot be changed anymore.
fontType | The font type. |
|
pure virtual |
Get the type of font used for rendering.
Set the font size.
fontSize | The font size in system units. |
|
pure virtual |
Get the font size.
Set the foreground (text) color used for rendering the text.
textColor | The text color. |
|
pure virtual |
Get the text color.
Set the background color used for rendering.
backgroundColor | The background color. |
|
pure virtual |
Get the background color.
|
pure virtual |
Get the optional mutable Graph::ITextNodeTarget parent container.
This method returns a mutable pointer to a Graph::ITextNodeTarget container, which allows to add, remove or query the parent text node that is used as a source for the displayed text.
|
pure virtual |
Get the optional constant Graph::ITextNodeTarget parent container.
This method returns a constant pointer to a Graph::ITextNodeTarget container, which allows to query the parent text node that is used as a source for the displayed text.
|
pure virtual |
Get the optional mutable output Graph::ITextureNodeTarget container.
This method returns a mutable pointer to a Graph::ITextureNodeTarget container, which allows to add, remove or query the texture node that is used as an optional output surface for the displayed text.
|
pure virtual |
Get the optional constant output Graph::ITextureNodeTarget container.
This method returns a constant pointer to a Graph::ITextureNodeTarget container, which allows to query the texture node that is used as an optional output surface for the displayed text.
|
pure virtual |
Get a mutable Graph::ITextResourceTarget container.
This method returns a mutable pointer to a Graph::ITextResourceTarget container, which allows to add, remove or query the text resources referenced by a node implementing this interface.
|
pure virtual |
Get a constant Graph::ITextResourceTarget container.
This method returns a constant pointer to a Graph::ITextResourceTarget container, which allows to query the text resources referenced by a node implementing this interface.
Set the text to be displayed.
text | A string containing the text to be displayed. |
|
pure virtual |
Get the displayed text.
Set the character spacing value.
This method sets the character spacing used for output, i.e. the horizontal distance between neighbored characters. The given spacing value adds to the default value specified in the font used for rendering this text; a value of 0.0 represents the font's original spacing, a positive value increases the horizontal distance between characters, and a negative value decreases it.
Note: The given spacing value is not scaled by the font used; if e.g. a positive value is used for a large font, the same value used with a smaller version of that same font will result in a (relatively) larger distance between characters. It is however influenced by a possible additional scaling operation performed by a text rendering object.
spacing | The character spacing value. |
|
pure virtual |
Get the character spacing value.
Set the leading value.
This method sets the leading value used for output, i.e. the vertical distance between subsequent text lines. The given leading value adds to the default value specified in the font used for rendering this text; a value of 0.0 represents the font's original leading, a positive value increases the vertical distance between lines, and a negative value decreases it.
Note: The given leading value is not scaled by the font used; if e.g. a positive value is used for a large font, the same value used with a smaller version of that same font will result in a (relatively) larger distance between lines. It is however influenced by a possible additional scaling operation performed by a text rendering object.
leading | The leading value. |
|
pure virtual |
Get the leading value.
Set the embolding strength value.
The embolding strength determines the "boldness" or "weight" of the font's rendered glyphs. Positive values result in thicker lines, and negative values can be used to make the font "thinner". Useful values are in the range from -1 to +1, but can also lie beyond that range.
Note that not all types of fonts allow glyph embolding. If not supported, this method returns false.
strength | The embolding strength value. |
|
pure virtual |
Get the embolding strength value.
Set the blur strength value.
strength | The positive blur strength value. |
|
pure virtual |
Get the blur strength value.
Set the space width factor.
This method sets a factor used to control the actual width of the white space character. In some cases, it is useful to manually control the space character's width, when a font's default space width produces too small or too big a distance between subsequent words. A space width factor of 1.0 represents the original width defined by the font used for rendering.
factor | The space width factor. |
|
pure virtual |
Get the space width factor.
Set the digit width factor.
This method sets a factor used to control the horizontal advance of all digit characters of a font ('0'-'9'). A digit width factor of 1.0 represents the original width defined by the font used for rendering.
Note, that this value only influences distance and not visual width; a value of e.g. 0.1 will result in overlapping digits without actually scaling them.
factor | The digit width factor. |
|
pure virtual |
Get the digit width factor.
Enable/disable unified digit width.
For certain use cases, such as a score counter in an action game, it is useful to set a common width for all digits ('0'-'9'); doing so prevents the counter from jittering due to different digit widths.
enabled | If true, all digits use the same horizontal advance value. |
|
pure virtual |
Check if unified digit width is enabled.
Enable/disable word wrapping.
enabled | If true, word wrapping is enabled. |
|
pure virtual |
Check if word wrapping is enabled.
|
pure virtual |
Set the horizontal text alignment.
alignment | The horizontal text alignment. |
|
pure virtual |
Get the horizontal text alignment.
|
pure virtual |
Set the vertical text alignment.
alignment | The vertical text alignment. |
|
pure virtual |
Get the vertical text alignment.
|
pure virtual |
Query the dimensions of a given UTF8 text.
text | The text to query |
sizeX | A reference to a Real variable receiving the horizontal text size. |
sizeY | A reference to a Real variable receiving the vertical text size. |