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

The ITextStyleImage graph node interface.


Table members

Inherited


Murl.Graph.ITagged

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

GetAtlasResourceTarget()

Get a constant Graph::IAtlasResourceTarget container. This method returns a constant pointer to a Graph::IAtlasResourceTarget container, which allows to query the atlas resources referenced by a node implementing this interface.

Murl.Graph.IGenericResourceTarget.ResourceIAtlas GetAtlasResourceTarget()

Returns
Murl.Graph.IGenericResourceTarget.ResourceIAtlas The constant Graph::IAtlasResourceTarget container, or null if not available

SetRectangleName(rectangleName)

Set the current atlas rectangle by name. If the given name is empty, the rectangle is explicitly set via a given index (see SetIndex()). This method fails if no atlas resource is set, or the given name is not found within the atlas resource.

Boolean SetRectangleName(String rectangleName)

Parameters
rectangleNameThe rectangle name.
Returns
Boolean true if successful.

GetRectangleName()

Get the current rectangle's name. This method returns an empty string when no atlas resource is defined or the currently active rectangle is unnamed.

String GetRectangleName()

Returns
String The rectangle name if available.

SetRectangleIndex(index)

Set the current rectangle index.

Boolean SetRectangleIndex(Integer index)

Parameters
indexThe signed index to set.
Returns
Boolean true if successful.

GetRectangleIndex()

Get the current rectangle index.

Integer GetRectangleIndex()

Returns
Integer The current index.

SetScaleFactor(s)

Set th scaling factor.

Boolean SetScaleFactor(Number s)

Parameters
sThe scale factor.
Returns
Boolean true if successful.

GetScaleFactor()

Get the scaling factor.

Number GetScaleFactor()

Returns
Number The scale factor.

SetMaterialSlot(slot)

Set the material slot used for rendering.

Boolean SetMaterialSlot(Integer slot)

Parameters
slotThe material slot.
Returns
Boolean true if successful.

GetMaterialSlot()

Get the material slot used for rendering.

Integer GetMaterialSlot()

Returns
Integer The material slot.

SetTextureSlot(unit, slot)

Set the texture slot used for rendering.

Boolean SetTextureSlot(Integer unit, Integer slot)

Parameters
unitThe texture unit for which to set the slot.
slotThe texture slot.
Returns
Boolean true if successful.

GetTextureSlot(unit)

Get the texture slot used for rendering.

Integer GetTextureSlot(Integer unit)

Parameters
unitThe texture unit for which to query the slot.
Returns
Integer The texture slot.

GetFrameSizeX()

Get the width of the currently displayed atlas rectangle.

Number GetFrameSizeX()

Returns
Number The current atlas rectangle width.

GetFrameSizeY()

Get the height of the currently displayed atlas rectangle.

Number GetFrameSizeY()

Returns
Number The current atlas rectangle height.