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

The IPlaneTouchArea graph node interface.

This interface represents a flat rectangular or elliptical input object in world space, with unit size dimensions around the origin.

Use the Graph::IScalable base interface to set an overall scaling factor for the plane, i.e. define its actual size.


Table members

Inherited


Murl.Graph.IScalable

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

GetTransformInterface()

Get the constant Graph::ITransform interface. This method returns a constant pointer to the node's Graph::ITransform interface, to be able to query the node's transformation matrix and depth order.

Murl.Graph.ITransform GetTransformInterface()

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

GetTouchAreaInterface()

Get the constant Graph::ITouchArea interface. This method returns a constant pointer to the node's Graph::ITouchArea interface, to be able to access the node's base touch area functionality.

Murl.Graph.ITouchArea GetTouchAreaInterface()

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

SetShape(shape)

Set the shape of the touch area.

Boolean SetShape(Murl.IEnums.TouchAreaShape shape)

Parameters
shapeThe shape to use.
Returns
Boolean true if successful.

GetShape()

Get the shape of the touch area.

Murl.IEnums.TouchAreaShape GetShape()

Returns
Murl.IEnums.TouchAreaShape The touch area's shape.

SetFrameSize(sizeX, sizeY)

Set the size of the display rectangle.

Boolean SetFrameSize(Number sizeX, Number sizeY)

Parameters
sizeXThe rectangle width.
sizeYThe rectangle height.
Returns
Boolean true if successful.

SetFrameSizeX(sizeX)

Set the width of the display rectangle.

Boolean SetFrameSizeX(Number sizeX)

Parameters
sizeXThe rectangle width.
Returns
Boolean true if successful.

SetFrameSizeY(sizeY)

Set the height of the display rectangle.

Boolean SetFrameSizeY(Number sizeY)

Parameters
sizeYThe rectangle height.
Returns
Boolean true if successful.

GetFrameSizeX()

Get the width of the display rectangle.

Number GetFrameSizeX()

Returns
Number The rectangle width.

GetFrameSizeY()

Get the height of the display rectangle.

Number GetFrameSizeY()

Returns
Number The rectangle height.

SetContainerAlignment(alignmentX, alignmentY)

Set the horizontal container alignment. The given alignment values specify how the touch area is actually positioned with respect to the node's world position.

Boolean SetContainerAlignment(Murl.IEnums.AlignmentX alignmentX, Murl.IEnums.AlignmentY alignmentY)

Parameters
alignmentXThe horizontal container alignment.
alignmentYThe vertical container alignment.
Returns
Boolean true if successful.

SetContainerAlignmentX(alignmentX)

Set the horizontal container alignment. See SetContainerAlignment().

Boolean SetContainerAlignmentX(Murl.IEnums.AlignmentX alignmentX)

Parameters
alignmentXThe horizontal container alignment.
Returns
Boolean true if successful.

SetContainerAlignmentY(alignmentY)

Set the vertical container alignment. See SetContainerAlignment().

Boolean SetContainerAlignmentY(Murl.IEnums.AlignmentY alignmentY)

Parameters
alignmentYThe vertical container alignment.
Returns
Boolean true if successful.

GetContainerAlignmentX()

Get the horizontal container alignment.

Murl.IEnums.AlignmentX GetContainerAlignmentX()

Returns
Murl.IEnums.AlignmentX The horizontal container alignment.

GetContainerAlignmentY()

Get the vertical container alignment.

Murl.IEnums.AlignmentY GetContainerAlignmentY()

Returns
Murl.IEnums.AlignmentY The vertical container alignment.

SetBorder(borderX, borderY)

Set the horizontal and vertical borders used for alignment.

Boolean SetBorder(Number borderX, Number borderY)

Parameters
borderXThe horizontal border.
borderYThe vertical border.
Returns
Boolean true if successful.

SetBorderX(borderX)

Set the horizontal border used for alignment.

Boolean SetBorderX(Number borderX)

Parameters
borderXThe horizontal border.
Returns
Boolean true if successful.

SetBorderY(borderY)

Set the vertical border used for alignment.

Boolean SetBorderY(Number borderY)

Parameters
borderYThe vertical border.
Returns
Boolean true if successful.

GetBorderX()

Get the horizontal border used for alignment.

Number GetBorderX()

Returns
Number The horizontal border.

GetBorderY()

Get the vertical border used for alignment.

Number GetBorderY()

Returns
Number The vertical border.