Murl Engine Lua Addon API  Version 1.0 beta
Murl.Input.ITouchArea

The ITouchArea interface.

The ITouchArea object can be created by the ITouchableHandler object.


Table members

Methods


SetActiveFaces(faces)

Set which faces of the touch area are active.

Boolean SetActiveFaces(Murl.IEnums.PolygonFaces faces)

Parameters
facesOne of the available IEnums::PolygonFaces enumeration values.
Returns
Boolean true if successful.

GetActiveFaces()

Check which faces of the touch area are active.

Murl.IEnums.PolygonFaces GetActiveFaces()

Returns
Murl.IEnums.PolygonFaces One of the available IEnums::PolygonFaces enumeration values.

SetOutCoord(x1, y1, x2, y2)

Set the button's output coordinate range. This method sets the button's start and end output coordinates. In contrast to a button event's local intersection point, which always represents the actual intersection in object-space 3D coordinates, an event's output coordinate represents a 2D intersection on the button's clickable surface. This can be interpreted analogously to a renderable geometry, with 3D vertex coordinates and 2D texture coordinates.

Boolean SetOutCoord(Number x1, Number y1, Number x2, Number y2)

Parameters
x1The start coordinate in X direction.
y1The start coordinate in Y direction.
x2The end coordinate in X direction.
y2The end coordinate in Y direction.
Returns
Boolean true if successful.

SetOutCoord1(x1, y1)

Set the button's output coordinate start. See SetOutCoord().

Boolean SetOutCoord1(Number x1, Number y1)

Parameters
x1The start coordinate in X direction.
y1The start coordinate in Y direction.
Returns
Boolean true if successful.

SetOutCoord2(x2, y2)

Set the button's output coordinate end. See SetOutCoord().

Boolean SetOutCoord2(Number x2, Number y2)

Parameters
x2The end coordinate in X direction.
y2The end coordinate in Y direction.
Returns
Boolean true if successful.

SetOutCoordX1(x1)

Set the button's horizontal start output coordinate. See SetOutCoord().

Boolean SetOutCoordX1(Number x1)

Parameters
x1The start coordinate in X direction.
Returns
Boolean true if successful.

SetOutCoordY1(y1)

Set the button's vertical start output coordinates. See SetOutCoord().

Boolean SetOutCoordY1(Number y1)

Parameters
y1The start coordinate in Y direction.
Returns
Boolean true if successful.

SetOutCoordX2(x2)

Set the button's horizontal end output coordinate. See SetOutCoord().

Boolean SetOutCoordX2(Number x2)

Parameters
x2The end coordinate in X direction.
Returns
Boolean true if successful.

SetOutCoordY2(y2)

Set the button's vertical end output coordinates. See SetOutCoord().

Boolean SetOutCoordY2(Number y2)

Parameters
y2The end coordinate in Y direction.
Returns
Boolean true if successful.

GetOutCoordX1()

Get the button's horizontal start output coordinate. See SetOutCoord().

Number GetOutCoordX1()

Returns
Number The start coordinate in X direction.

GetOutCoordY1()

Get the button's vertical start output coordinate. See SetOutCoord().

Number GetOutCoordY1()

Returns
Number The start coordinate in Y direction.

GetOutCoordX2()

Get the button's horizontal end output coordinate. See SetOutCoord().

Number GetOutCoordX2()

Returns
Number The end coordinate in X direction.

GetOutCoordY2()

Get the button's vertical end output coordinate. See SetOutCoord().

Number GetOutCoordY2()

Returns
Number The end coordinate in Y direction.

SetResponseButton(button)

Set the response button.

SetResponseButton(Murl.IEnums.MouseButton button)

Parameters
buttonThe response button.

GetResponseButton()

Get the response button.

Murl.IEnums.MouseButton GetResponseButton()

Returns
Murl.IEnums.MouseButton The response button.

SetPassEventsEnabled(enable)

Set the pass events state.

SetPassEventsEnabled(Boolean enable)

Parameters
enabletrue for enable passing events.

IsPassEventsEnabled()

Check the pass events state.

Boolean IsPassEventsEnabled()

Returns
Boolean true if enabled.