Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.ITextTexture

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.


Table members

Inherited


Murl.Graph.IText

Methods


GetNodeInterface()

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.

Murl.Graph.INode GetNodeInterface()

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

GetTextureInterface()

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.

Murl.Graph.ITexture GetTextureInterface()

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

SetTextPosition(posX, posY)

Set the text position within the texture.

Boolean SetTextPosition(Number posX, Number posY)

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

SetTextPositionX(posX)

Set the horizontal text position within the texture.

Boolean SetTextPositionX(Number posX)

Parameters
posXThe horizontal text position.
Returns
Boolean true if successful.

SetTextPositionY(posY)

Set the vertical text position within the texture.

Boolean SetTextPositionY(Number posY)

Parameters
posYThe vertical text position.
Returns
Boolean true if successful.

GetTextPositionX()

Get the horizontal text position within the texture.

Number GetTextPositionX()

Returns
Number The horizontal text position.

GetTextPositionY()

Get the vertical text position within the texture.

Number GetTextPositionY()

Returns
Number The vertical text position.

SetTextSize(sizeX, sizeY)

Set the output text rectangle's size.

Boolean SetTextSize(Number sizeX, Number sizeY)

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

SetTextSizeX(sizeX)

Set the output text rectangle's horizontal size.

Boolean SetTextSizeX(Number sizeX)

Parameters
sizeXThe horizontal text size.
Returns
Boolean true if successful.

SetTextSizeY(sizeY)

Set the output text rectangle's vertical size.

Boolean SetTextSizeY(Number sizeY)

Parameters
sizeYThe vertical text size.
Returns
Boolean true if successful.

GetTextSizeX()

Get the output text rectangle's horizontal size.

Number GetTextSizeX()

Returns
Number The horizontal text size.

GetTextSizeY()

Get the output text rectangle's vertical size.

Number GetTextSizeY()

Returns
Number The vertical text size.

GetNumberOfPlaceholders()

Integer GetNumberOfPlaceholders()

Returns
Integer

GetPlaceholderId(index)

Integer GetPlaceholderId(Integer index)

Returns
Integer

GetPlaceholderPositionX(index)

Number GetPlaceholderPositionX(Integer index)

Returns
Number

GetPlaceholderPositionY(index)

Number GetPlaceholderPositionY(Integer index)

Returns
Number

GetPlaceholderSizeX(index)

Number GetPlaceholderSizeX(Integer index)

Returns
Number

GetPlaceholderSizeY(index)

Number GetPlaceholderSizeY(Integer index)

Returns
Number