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

The IListenerTransform graph node interface.

A listener node defined in the scene graph only defines the general behavior of a listener in the virtual world; to be able to move and rotate the listener, it is necessary to define an IListenerTransform node that refers to a specific listener. By separating a listener from its transform, it is possible to already use a listener before its actual world position and rotation are evaluated; this way, the listener can be quickly attached to e.g. a moving object that is supposed to be also audible throught that listener, by simply defining an IListenerTransform node as a child of the respective object.

See Graph::IListener for defining a specific listener for rendering.
See Graph::IListenerState for activating a listener for rendering.


Table members

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

GetListenerNodeTarget()

Get the constant Graph::IListenerNodeTarget container. This method returns a constant pointer to the node's Graph::IListenerNodeTarget container, which allows to query the listener this transform node refers to.

Murl.Graph.IGenericNodeTarget.GraphIListener GetListenerNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphIListener The mutable Graph::IListenerNodeTarget container, or null if not available.

GetAnchorNodeTarget()

Get the constant Graph::IAnchorNodeTarget container for the target position. This method returns a constant pointer to the node's Graph::IAnchorNodeTarget container, which allows to query the referenced Graph::IAnchor node used as a view target.

Murl.Graph.IGenericNodeTarget.GraphIAnchor GetAnchorNodeTarget()

Returns
Murl.Graph.IGenericNodeTarget.GraphIAnchor The constant Graph::IAnchorNodeTarget container, or null if not available

SetUpVector(upVector)

Set the target anchor up vector. The up vector is used to orient the view when a target anchor node is given.

Boolean SetUpVector(Murl.Math.Vector upVector)

Parameters
upVectorThe up vector.
Returns
Boolean true if successful.

GetUpVector()

Get the target anchor up vector.

Murl.Math.Vector GetUpVector()

Returns
Murl.Math.Vector The up vector.