The ITextTexture graph node interface. More...

#include "murl_graph_i_text_texture.h"

Inheritance diagram for Murl::Graph::ITextTexture:

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual ITextureGetTextureInterface ()=0
 Get the mutable Graph::ITexture interface. More...
 
virtual const ITextureGetTextureInterface () const =0
 Get the constant Graph::ITexture interface. More...
 
virtual Bool SetTextPosition (Real posX, Real posY)=0
 Set the text position within the texture. More...
 
virtual Bool SetTextPositionX (Real posX)=0
 Set the horizontal text position within the texture. More...
 
virtual Bool SetTextPositionY (Real posY)=0
 Set the vertical text position within the texture. More...
 
virtual Real GetTextPositionX () const =0
 Get the horizontal text position within the texture. More...
 
virtual Real GetTextPositionY () const =0
 Get the vertical text position within the texture. More...
 
virtual Bool SetTextSize (Real sizeX, Real sizeY)=0
 Set the output text rectangle's size. More...
 
virtual Bool SetTextSizeX (Real sizeX)=0
 Set the output text rectangle's horizontal size. More...
 
virtual Bool SetTextSizeY (Real sizeY)=0
 Set the output text rectangle's vertical size. More...
 
virtual Real GetTextSizeX () const =0
 Get the output text rectangle's horizontal size. More...
 
virtual Real GetTextSizeY () const =0
 Get the output text rectangle's vertical size. More...
 
- Public Member Functions inherited from Murl::Graph::IText
virtual IFontResourceTargetGetFontResourceTarget ()=0
 Get a mutable Graph::IFontResourceTarget container. More...
 
virtual const IFontResourceTargetGetFontResourceTarget () 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 StringGetSystemFontName () 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 ColorGetTextColor () const =0
 Get the text color. More...
 
virtual Bool SetBackgroundColor (const Color &backgroundColor)=0
 Set the background color used for rendering. More...
 
virtual const ColorGetBackgroundColor () const =0
 Get the background color. More...
 
virtual ITextNodeTargetGetParentTextNodeTarget ()=0
 Get the optional mutable Graph::ITextNodeTarget parent container. More...
 
virtual const ITextNodeTargetGetParentTextNodeTarget () const =0
 Get the optional constant Graph::ITextNodeTarget parent container. More...
 
virtual ITextureNodeTargetGetOutputTextureNodeTarget ()=0
 Get the optional mutable output Graph::ITextureNodeTarget container. More...
 
virtual const ITextureNodeTargetGetOutputTextureNodeTarget () const =0
 Get the optional constant output Graph::ITextureNodeTarget container. More...
 
virtual ITextResourceTargetGetTextResourceTarget ()=0
 Get a mutable Graph::ITextResourceTarget container. More...
 
virtual const ITextResourceTargetGetTextResourceTarget () 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 StringGetText () 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...
 

Detailed Description

The ITextTexture graph node interface.

This interface represents a texture used as a target for rendering text using a predefined system font, referenced by its identifier.

Use the Graph::IText base interface to access common text properties, such as spacing or leading, or the actual text to be shown.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::ITextTexture::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::ITextTexture::GetNodeInterface ( ) const
pure virtual

Get the constant Graph::INode interface.

This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Returns
The constant Graph::INode interface, or null if not available

◆ GetTextureInterface() [1/2]

virtual ITexture* Murl::Graph::ITextTexture::GetTextureInterface ( )
pure virtual

Get the mutable Graph::ITexture interface.

This method returns a mutable pointer to the node's Graph::ITexture interface, to be able to query or modify the node's texture properties.

Returns
The mutable Graph::ITexture interface, or null if not available

◆ GetTextureInterface() [2/2]

virtual const ITexture* Murl::Graph::ITextTexture::GetTextureInterface ( ) const
pure virtual

Get the constant Graph::ITexture interface.

This method returns a constant pointer to the node's Graph::ITexture interface, to be able to query the node's texture properties.

Returns
The constant Graph::ITexture interface, or null if not available

◆ SetTextPosition()

virtual Bool Murl::Graph::ITextTexture::SetTextPosition ( Real  posX,
Real  posY 
)
pure virtual

Set the text position within the texture.

Parameters
posXThe horizontal text position.
posYThe vertical text position.
Returns
true if successful.

◆ SetTextPositionX()

virtual Bool Murl::Graph::ITextTexture::SetTextPositionX ( Real  posX)
pure virtual

Set the horizontal text position within the texture.

Parameters
posXThe horizontal text position.
Returns
true if successful.

◆ SetTextPositionY()

virtual Bool Murl::Graph::ITextTexture::SetTextPositionY ( Real  posY)
pure virtual

Set the vertical text position within the texture.

Parameters
posYThe vertical text position.
Returns
true if successful.

◆ GetTextPositionX()

virtual Real Murl::Graph::ITextTexture::GetTextPositionX ( ) const
pure virtual

Get the horizontal text position within the texture.

Returns
The horizontal text position.

◆ GetTextPositionY()

virtual Real Murl::Graph::ITextTexture::GetTextPositionY ( ) const
pure virtual

Get the vertical text position within the texture.

Returns
The vertical text position.

◆ SetTextSize()

virtual Bool Murl::Graph::ITextTexture::SetTextSize ( Real  sizeX,
Real  sizeY 
)
pure virtual

Set the output text rectangle's size.

Parameters
sizeXThe horizontal text size.
sizeYThe vertical text size.
Returns
true if successful.

◆ SetTextSizeX()

virtual Bool Murl::Graph::ITextTexture::SetTextSizeX ( Real  sizeX)
pure virtual

Set the output text rectangle's horizontal size.

Parameters
sizeXThe horizontal text size.
Returns
true if successful.

◆ SetTextSizeY()

virtual Bool Murl::Graph::ITextTexture::SetTextSizeY ( Real  sizeY)
pure virtual

Set the output text rectangle's vertical size.

Parameters
sizeYThe vertical text size.
Returns
true if successful.

◆ GetTextSizeX()

virtual Real Murl::Graph::ITextTexture::GetTextSizeX ( ) const
pure virtual

Get the output text rectangle's horizontal size.

Returns
The horizontal text size.

◆ GetTextSizeY()

virtual Real Murl::Graph::ITextTexture::GetTextSizeY ( ) const
pure virtual

Get the output text rectangle's vertical size.

Returns
The vertical text size.

The documentation for this interface was generated from the following file:
  • murl_graph_i_text_texture.h


Copyright © 2011-2018 Spraylight GmbH.