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

The IBonePathConstraint graph node interface.


Table members

Inherited


Murl.Graph.IDeformable

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

GetBoneConstraintInterface()

Get the constant Graph::IBoneConstraint interface. This method returns a constant pointer to the node's Graph::IBoneConstraint interface, to be able to query the base constraint parameters.

Murl.Graph.IBoneConstraint GetBoneConstraintInterface()

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

GetMeshResourceTarget()

Get a constant Graph::IMeshResourceTarget container. This method returns a constant pointer to a Graph::IMeshResourceTarget container, which allows to query the path mesh resource.

Murl.Graph.IGenericResourceTarget.ResourceIMesh GetMeshResourceTarget()

Returns
Murl.Graph.IGenericResourceTarget.ResourceIMesh The constant Graph::IMeshResourceTarget container, or null if not available

SetPositionBlendFactor(factor)

Set the position blend factor.

Boolean SetPositionBlendFactor(Number factor)

Parameters
factorThe position blend factor.
Returns
Boolean true if successful.

GetPositionBlendFactor()

Get the position blend factor.

Number GetPositionBlendFactor()

Returns
Number The position blend factor.

SetRotationBlendFactor(factor)

Set the rotation blend factor.

Boolean SetRotationBlendFactor(Number factor)

Parameters
factorThe rotation blend factor.
Returns
Boolean true if successful.

GetRotationBlendFactor()

Get the rotation blend factor.

Number GetRotationBlendFactor()

Returns
Number The rotation blend factor.

SetPositionOffset(offset)

Set the position offset.

Boolean SetPositionOffset(Number offset)

Parameters
offsetThe position offset.
Returns
Boolean true if successful.

GetPositionOffset()

Get the position offset.

Number GetPositionOffset()

Returns
Number The position offset.

SetRotationOffset(offset)

Set the rotation offset.

Boolean SetRotationOffset(Number offset)

Parameters
offsetThe rotation offset.
Returns
Boolean true if successful.

GetRotationOffset()

Get the rotation offset.

Number GetRotationOffset()

Returns
Number The rotation offset.

SetSpacing(spacing)

Set the spacing value.

Boolean SetSpacing(Number spacing)

Parameters
spacingThe spacing value.
Returns
Boolean true if successful.

GetSpacing()

Get the spacing value.

Number GetSpacing()

Returns
Number The spacing value.

SetPositionMode(mode)

Set the position mode.

Boolean SetPositionMode(Murl.IEnums.PathPositionMode mode)

Parameters
modeThe position mode.
Returns
Boolean true if successful.

GetPositionMode()

Get the position mode.

Murl.IEnums.PathPositionMode GetPositionMode()

Returns
Murl.IEnums.PathPositionMode The position mode.

SetRotationMode(mode)

Set the rotation mode.

Boolean SetRotationMode(Murl.IEnums.PathRotationMode mode)

Parameters
modeThe rotation mode.
Returns
Boolean true if successful.

GetRotationMode()

Get the rotation mode.

Murl.IEnums.PathRotationMode GetRotationMode()

Returns
Murl.IEnums.PathRotationMode The rotation mode.

SetSpacingMode(mode)

Set the spacing mode.

Boolean SetSpacingMode(Murl.IEnums.PathSpacingMode mode)

Parameters
modeThe spacing mode.
Returns
Boolean true if successful.

GetSpacingMode()

Get the spacing mode.

Murl.IEnums.PathSpacingMode GetSpacingMode()

Returns
Murl.IEnums.PathSpacingMode The spacing mode.

SetMovementMode(mode)

Set the movement mode.

Boolean SetMovementMode(Murl.IEnums.PathMovementMode mode)

Parameters
modeThe movement mode.
Returns
Boolean true if successful.

GetMovementMode()

Get the movement mode.

Murl.IEnums.PathMovementMode GetMovementMode()

Returns
Murl.IEnums.PathMovementMode The movement mode.

SetClosed(isClosed)

Set if the path is closed.

Boolean SetClosed(Boolean isClosed)

Parameters
isClosedtrue if closed.
Returns
Boolean true if successful.

IsClosed()

Check if the path is closed.

Boolean IsClosed()

Returns
Boolean true if closed.

SetMaxNumberOfBonesPerVertex(maxNumBones)

Set the maximum number of bones per vertex for vertex skinning.

Boolean SetMaxNumberOfBonesPerVertex(Integer maxNumBones)

Parameters
maxNumBonesThe maximum number of bones.
Returns
Boolean true if successful.

GetMaxNumberOfBonesPerVertex()

Get the maximum number of bones per vertex for vertex skinning.

Integer GetMaxNumberOfBonesPerVertex()

Returns
Integer The maximum number of bones.