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

The IBoneTransformConstraint graph node interface.


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

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

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.

SetScaleBlendFactor(factor)

Set the scale blend factor.

Boolean SetScaleBlendFactor(Number factor)

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

GetScaleBlendFactor()

Get the scale blend factor.

Number GetScaleBlendFactor()

Returns
Number The scale blend factor.

SetShearBlendFactor(factor)

Set the shear blend factor.

Boolean SetShearBlendFactor(Number factor)

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

GetShearBlendFactor()

Get the shear blend factor.

Number GetShearBlendFactor()

Returns
Number The shear blend factor.

SetPositionOffset(offsetX, offsetY)

Set the position offset.

Boolean SetPositionOffset(Number offsetX, Number offsetY)

Parameters
offsetXThe position X offset.
offsetYThe position Y offset.
Returns
Boolean true if successful.

SetPositionOffsetX(offsetX)

Set the position X offset.

Boolean SetPositionOffsetX(Number offsetX)

Parameters
offsetXThe position X offset.
Returns
Boolean true if successful.

SetPositionOffsetY(offsetY)

Set the position Y offset.

Boolean SetPositionOffsetY(Number offsetY)

Parameters
offsetYThe position Y offset.
Returns
Boolean true if successful.

GetPositionOffsetX()

Get the position X offset.

Number GetPositionOffsetX()

Returns
Number The position X offset.

GetPositionOffsetY()

Get the position Y offset.

Number GetPositionOffsetY()

Returns
Number The position Y 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.

SetScaleOffset(offsetX, offsetY)

Set the scale offset.

Boolean SetScaleOffset(Number offsetX, Number offsetY)

Parameters
offsetXThe scale X offset.
offsetYThe scale Y offset.
Returns
Boolean true if successful.

SetScaleOffsetX(offsetX)

Set the scale X offset.

Boolean SetScaleOffsetX(Number offsetX)

Parameters
offsetXThe scale X offset.
Returns
Boolean true if successful.

SetScaleOffsetY(offsetY)

Set the scale Y offset.

Boolean SetScaleOffsetY(Number offsetY)

Parameters
offsetYThe scale Y offset.
Returns
Boolean true if successful.

GetScaleOffsetX()

Get the scale X offset.

Number GetScaleOffsetX()

Returns
Number The scale X offset.

GetScaleOffsetY()

Get the scale Y offset.

Number GetScaleOffsetY()

Returns
Number The scale Y offset.

SetShearOffsetY(offsetY)

Set the shear Y offset.

Boolean SetShearOffsetY(Number offsetY)

Parameters
offsetYThe shear Y offset.
Returns
Boolean true if successful.

GetShearOffsetY()

Get the shear Y offset.

Number GetShearOffsetY()

Returns
Number The shear Y offset.

SetLocal(isLocal)

Set if transforms are calculated in local space.

Boolean SetLocal(Boolean isLocal)

Parameters
isLocaltrue if in local space, false if in world space.
Returns
Boolean true if successful.

IsLocal()

Check if transforms are calculated in local space.

Boolean IsLocal()

Returns
Boolean true if in local space, false if in world space.

SetRelative(isRelative)

Set if transforms are calculated relative to the bones' parents.

Boolean SetRelative(Boolean isRelative)

Parameters
isRelativetrue if relative.
Returns
Boolean true if successful.

IsRelative()

Check if transforms are calculated relative to the bones' parents.

Boolean IsRelative()

Returns
Boolean true if relative.