The ITextStyleLayer graph node interface. More...

#include <murl_graph_i_text_style_layer.h>

Detailed Description

The ITextStyleLayer graph node interface.

Inheritance diagram for Murl::Graph::ITextStyleLayer:

Public Member Functions
virtual INode *	GetNodeInterface ()=0
	Get the mutable Graph::INode interface. More...

virtual const INode *	GetNodeInterface () const =0
	Get the constant Graph::INode interface. More...

virtual ITextStyleLayerNodeTarget *	GetSubTextStyleLayerNodeTarget ()=0
	Get the mutable container holding the optional child layers. More...

virtual const ITextStyleLayerNodeTarget *	GetSubTextStyleLayerNodeTarget () const =0
	Get the constant container holding the optional child layers. More...

virtual Bool	SetLayerType (IEnums::LayerType type)=0
	Set the type of this layer. More...

virtual IEnums::LayerType	GetLayerType () const =0
	Get the layer type. More...

virtual Bool	SetLayerRenderOperation (IEnums::AluOperation layerOperation)=0
	Set the render operation for this layer. More...

virtual IEnums::AluOperation	GetLayerRenderOperation () const =0
	Get the render operation. 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	SetTextColorOperation (IEnums::AluOperation textColorOperation)=0
	Set the color operation to apply to text rendered in this layer. More...

virtual IEnums::AluOperation	GetTextColorOperation () const =0
	Get the text color operation. 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 Bool	SetBackgroundColorOperation (IEnums::AluOperation backgroundColorOperation)=0
	Set the color operation to apply to this layers background. More...

virtual IEnums::AluOperation	GetBackgroundColorOperation () const =0
	Get the background color operation. 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	SetEmboldingOperation (IEnums::AluOperation emboldingOperation)=0
	Set the embolding operation. More...

virtual IEnums::AluOperation	GetEmboldingOperation () const =0
	Get the embolding operation. 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	SetBlurOperation (IEnums::AluOperation blurOperation)=0
	Set the blur operation. More...

virtual IEnums::AluOperation	GetBlurOperation () const =0
	Get the blur operation. More...

virtual Bool	SetOffset (Real offsetX, Real offsetY)=0
	Set horizontal and vertical offsets used for outline rendering. More...

virtual Bool	SetOffsetX (Real offsetX)=0
	Set the horizontal offset used for outline rendering. More...

virtual Bool	SetOffsetY (Real offsetY)=0
	Set the vertical offset used for outline rendering. More...

virtual Real	GetOffsetX () const =0
	Get the horizontal offset used for outline rendering. More...

virtual Real	GetOffsetY () const =0
	Get the vertical offset used for outline rendering. More...

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::ITextStyleLayer::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::ITextStyleLayer::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

◆ GetSubTextStyleLayerNodeTarget() [1/2]

virtual ITextStyleLayerNodeTarget* Murl::Graph::ITextStyleLayer::GetSubTextStyleLayerNodeTarget ( )

pure virtual

Get the mutable container holding the optional child layers.

This method returns a mutable pointer to the node's Graph::ITextStyleLayerNodeTarget sub container, which is used to store multiple sub-layers.

Returns: The mutable Graph::ITextStyleLayerNodeTarget container, or null if not available.

◆ GetSubTextStyleLayerNodeTarget() [2/2]

virtual const ITextStyleLayerNodeTarget* Murl::Graph::ITextStyleLayer::GetSubTextStyleLayerNodeTarget ( ) const

pure virtual

Get the constant container holding the optional child layers.

This method returns a constant pointer to the node's Graph::ITextStyleLayerNodeTarget sub container, which is used to store multiple sub-layers.

Returns: The constant Graph::ITextStyleLayerNodeTarget container, or null if not available.

◆ SetLayerType()

virtual Bool Murl::Graph::ITextStyleLayer::SetLayerType ( IEnums::LayerType type )

pure virtual

Set the type of this layer.

Parameters

textColor The layer type.

Returns: true if successful.

◆ GetLayerType()

virtual IEnums::LayerType Murl::Graph::ITextStyleLayer::GetLayerType ( ) const

pure virtual

Get the layer type.

Returns: The layer type.

◆ SetLayerRenderOperation()

virtual Bool Murl::Graph::ITextStyleLayer::SetLayerRenderOperation ( IEnums::AluOperation layerOperation )

pure virtual

Set the render operation for this layer.

Parameters

layerOperation The render operation.

Returns: true if successful.

◆ GetLayerRenderOperation()

virtual IEnums::AluOperation Murl::Graph::ITextStyleLayer::GetLayerRenderOperation ( ) const

pure virtual

Get the render operation.

Returns: The render operation.

◆ SetTextColor()

virtual Bool Murl::Graph::ITextStyleLayer::SetTextColor ( const Color & textColor )

pure virtual

Set the foreground (text) color used for rendering the text.

Parameters

textColor The text color.

Returns: true if successful.

◆ GetTextColor()

virtual const Color& Murl::Graph::ITextStyleLayer::GetTextColor ( ) const

pure virtual

Get the text color.

Returns: The text color.

◆ SetTextColorOperation()

virtual Bool Murl::Graph::ITextStyleLayer::SetTextColorOperation ( IEnums::AluOperation textColorOperation )

pure virtual

Set the color operation to apply to text rendered in this layer.

Parameters

textColorOperation The color operation.

Returns: true if successful.

◆ GetTextColorOperation()

virtual IEnums::AluOperation Murl::Graph::ITextStyleLayer::GetTextColorOperation ( ) const

pure virtual

Get the text color operation.

Returns: The color operation.

◆ SetBackgroundColor()

virtual Bool Murl::Graph::ITextStyleLayer::SetBackgroundColor ( const Color & backgroundColor )

pure virtual

Set the background color used for rendering.

Parameters

backgroundColor The background color.

Returns: true if successful.

◆ GetBackgroundColor()

virtual const Color& Murl::Graph::ITextStyleLayer::GetBackgroundColor ( ) const

pure virtual

Get the background color.

Returns: The background color.

◆ SetBackgroundColorOperation()

virtual Bool Murl::Graph::ITextStyleLayer::SetBackgroundColorOperation ( IEnums::AluOperation backgroundColorOperation )

pure virtual

Set the color operation to apply to this layers background.

Parameters

backgroundColorOperation The color operation.

Returns: true if successful.

◆ GetBackgroundColorOperation()

virtual IEnums::AluOperation Murl::Graph::ITextStyleLayer::GetBackgroundColorOperation ( ) const

pure virtual

Get the background color operation.

Returns: The color operation.

◆ SetEmbolding()

virtual Bool Murl::Graph::ITextStyleLayer::SetEmbolding ( Real strength )

pure virtual

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.

Parameters

strength The embolding strength value.

Returns: true if successful.

◆ GetEmbolding()

virtual Real Murl::Graph::ITextStyleLayer::GetEmbolding ( ) const

pure virtual

Get the embolding strength value.

Returns: The embolding strength value.

◆ SetEmboldingOperation()

virtual Bool Murl::Graph::ITextStyleLayer::SetEmboldingOperation ( IEnums::AluOperation emboldingOperation )

pure virtual

Set the embolding operation.

Parameters

emboldingOperation The embolding operation.

Returns: true if successful.

◆ GetEmboldingOperation()

virtual IEnums::AluOperation Murl::Graph::ITextStyleLayer::GetEmboldingOperation ( ) const

pure virtual

Get the embolding operation.

Returns: The embolding operation.

◆ SetBlur()

virtual Bool Murl::Graph::ITextStyleLayer::SetBlur ( Real strength )

pure virtual

Set the blur strength value.

Parameters

strength The positive blur strength value.

Returns: true if successful.

◆ GetBlur()

virtual Real Murl::Graph::ITextStyleLayer::GetBlur ( ) const

pure virtual

Get the blur strength value.

Returns: The blur strength value.

◆ SetBlurOperation()

virtual Bool Murl::Graph::ITextStyleLayer::SetBlurOperation ( IEnums::AluOperation blurOperation )

pure virtual

Set the blur operation.

Parameters

blurOperation The blur operation.

Returns: true if successful.

◆ GetBlurOperation()

virtual IEnums::AluOperation Murl::Graph::ITextStyleLayer::GetBlurOperation ( ) const

pure virtual

Get the blur operation.

Returns: The blur operation.

◆ SetOffset()

virtual Bool Murl::Graph::ITextStyleLayer::SetOffset	(	Real	offsetX,
		Real	offsetY
	)

pure virtual

Set horizontal and vertical offsets used for outline rendering.

Parameters

offsetX	The horizontal offset.
offsetY	The vertical offset.

Returns: true if successful.

◆ SetOffsetX()

virtual Bool Murl::Graph::ITextStyleLayer::SetOffsetX ( Real offsetX )

pure virtual

Set the horizontal offset used for outline rendering.

Parameters

offsetX The horizontal offset.

Returns: true if successful.

◆ SetOffsetY()

virtual Bool Murl::Graph::ITextStyleLayer::SetOffsetY ( Real offsetY )

pure virtual

Set the vertical offset used for outline rendering.

Parameters

offsetY The vertical offset.

Returns: true if successful.

◆ GetOffsetX()

virtual Real Murl::Graph::ITextStyleLayer::GetOffsetX ( ) const

pure virtual

Get the horizontal offset used for outline rendering.

Returns: The horizontal offset.

◆ GetOffsetY()

virtual Real Murl::Graph::ITextStyleLayer::GetOffsetY ( ) const

pure virtual

Get the vertical offset used for outline rendering.

Returns: The vertical offset.

The documentation for this interface was generated from the following file:

murl_graph_i_text_style_layer.h

Detailed Description

Public Member Functions

Member Function Documentation

◆ GetNodeInterface() [1/2]

◆ GetNodeInterface() [2/2]

◆ GetSubTextStyleLayerNodeTarget() [1/2]

◆ GetSubTextStyleLayerNodeTarget() [2/2]

◆ SetLayerType()

◆ GetLayerType()

◆ SetLayerRenderOperation()

◆ GetLayerRenderOperation()

◆ SetTextColor()

◆ GetTextColor()

◆ SetTextColorOperation()

◆ GetTextColorOperation()

◆ SetBackgroundColor()

◆ GetBackgroundColor()

◆ SetBackgroundColorOperation()

◆ GetBackgroundColorOperation()

◆ SetEmbolding()

◆ GetEmbolding()

◆ SetEmboldingOperation()

◆ GetEmboldingOperation()

◆ SetBlur()

◆ GetBlur()

◆ SetBlurOperation()

◆ GetBlurOperation()

◆ SetOffset()

◆ SetOffsetX()

◆ SetOffsetY()

◆ GetOffsetX()

◆ GetOffsetY()