Murl::Graph::IBonePathConstraint Interface Referenceabstract

The IBonePathConstraint graph node interface. More...

#include "murl_graph_i_bone_path_constraint.h"

Inheritance diagram for Murl::Graph::IBonePathConstraint:

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual ITransformGetTransformInterface ()=0
 Get the mutable Graph::ITransform interface. More...
 
virtual const ITransformGetTransformInterface () const =0
 Get the constant Graph::ITransform interface. More...
 
virtual IBoneConstraintGetBoneConstraintInterface ()=0
 Get the mutable Graph::IBoneConstraint interface. More...
 
virtual const IBoneConstraintGetBoneConstraintInterface () const =0
 Get the constant Graph::IBoneConstraint interface. More...
 
virtual IMeshResourceTargetGetMeshResourceTarget ()=0
 Get a mutable Graph::IMeshResourceTarget container. More...
 
virtual const IMeshResourceTargetGetMeshResourceTarget () const =0
 Get a constant Graph::IMeshResourceTarget container. More...
 
virtual Bool SetPositionBlendFactor (const Vector &factor)=0
 Set the position blend factor. More...
 
virtual Bool SetPositionBlendFactor (Real x, Real y, Real z)=0
 Set the position blend factor. More...
 
virtual Bool SetPositionBlendFactor (Real f)=0
 Set the position blend factor. More...
 
virtual Bool SetPositionBlendFactorX (Real x)=0
 Set the X component of the position blend factor. More...
 
virtual Bool SetPositionBlendFactorY (Real y)=0
 Set the Y component of the position blend factor. More...
 
virtual Bool SetPositionBlendFactorZ (Real z)=0
 Set the Z component of the position blend factor. More...
 
virtual const VectorGetPositionBlendFactor () const =0
 Get the position blend factor. More...
 
virtual Real GetPositionBlendFactorX () const =0
 Get the X component of the position blend factor. More...
 
virtual Real GetPositionBlendFactorY () const =0
 Get the Y component of the position blend factor. More...
 
virtual Real GetPositionBlendFactorZ () const =0
 Get the Z component of the position blend factor. More...
 
virtual Bool SetRotationBlendFactor (Real factor)=0
 Set the rotation blend factor. More...
 
virtual Real GetRotationBlendFactor () const =0
 Get the rotation blend factor. More...
 
virtual Bool SetPositionOffset (Real offset)=0
 Set the position offset. More...
 
virtual Real GetPositionOffset () const =0
 Get the position offset. More...
 
virtual Bool SetRotationOffset (Real offset)=0
 Set the rotation offset. More...
 
virtual Real GetRotationOffset () const =0
 Get the rotation offset. More...
 
virtual Bool SetSpacing (Real spacing)=0
 Set the spacing value. More...
 
virtual Real GetSpacing () const =0
 Get the spacing value. More...
 
virtual Bool SetPositionMode (IEnums::PathPositionMode mode)=0
 Set the position mode. More...
 
virtual IEnums::PathPositionMode GetPositionMode () const =0
 Get the position mode. More...
 
virtual Bool SetRotationMode (IEnums::PathRotationMode mode)=0
 Set the rotation mode. More...
 
virtual IEnums::PathRotationMode GetRotationMode () const =0
 Get the rotation mode. More...
 
virtual Bool SetSpacingMode (IEnums::PathSpacingMode mode)=0
 Set the spacing mode. More...
 
virtual IEnums::PathSpacingMode GetSpacingMode () const =0
 Get the spacing mode. More...
 
virtual Bool SetMovementMode (IEnums::PathMovementMode mode)=0
 Set the movement mode. More...
 
virtual IEnums::PathMovementMode GetMovementMode () const =0
 Get the movement mode. More...
 
virtual Bool SetClosed (Bool isClosed)=0
 Set if the path is closed. More...
 
virtual Bool IsClosed () const =0
 Check if the path is closed. More...
 
virtual Bool SetMaxNumberOfBonesPerVertex (UInt32 maxNumBones)=0
 Set the maximum number of bones per vertex for vertex skinning. More...
 
virtual UInt32 GetMaxNumberOfBonesPerVertex () const =0
 Get the maximum number of bones per vertex for vertex skinning. More...
 
- Public Member Functions inherited from Murl::Graph::IDeformable
virtual UInt32 GetNumberOfDeformStages () const =0
 Get the number of deform stages present. More...
 
virtual Bool SetDeformTimeAndFactor (UInt32 stageIndex, Real time, Real factor)=0
 Set the time and blend factor for a given stage. More...
 
virtual Real GetDeformTime (UInt32 stageIndex) const =0
 Get the deform time set for a given stage. More...
 
virtual Real GetDeformFactor (UInt32 stageIndex) const =0
 Get the deform factor set for a given stage. More...
 

Detailed Description

The IBonePathConstraint graph node interface.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IBonePathConstraint::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::IBonePathConstraint::GetNodeInterface ( ) const
pure virtual

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.

Returns
The constant Graph::INode interface, or null if not available

◆ GetTransformInterface() [1/2]

virtual ITransform* Murl::Graph::IBonePathConstraint::GetTransformInterface ( )
pure virtual

Get the mutable Graph::ITransform interface.

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

Returns
The mutable Graph::ITransform interface, or null if not available

◆ GetTransformInterface() [2/2]

virtual const ITransform* Murl::Graph::IBonePathConstraint::GetTransformInterface ( ) const
pure virtual

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.

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

◆ GetBoneConstraintInterface() [1/2]

virtual IBoneConstraint* Murl::Graph::IBonePathConstraint::GetBoneConstraintInterface ( )
pure virtual

Get the mutable Graph::IBoneConstraint interface.

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

Returns
The mutable Graph::IBoneConstraint interface, or null if not available

◆ GetBoneConstraintInterface() [2/2]

virtual const IBoneConstraint* Murl::Graph::IBonePathConstraint::GetBoneConstraintInterface ( ) const
pure virtual

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.

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

◆ GetMeshResourceTarget() [1/2]

virtual IMeshResourceTarget* Murl::Graph::IBonePathConstraint::GetMeshResourceTarget ( )
pure virtual

Get a mutable Graph::IMeshResourceTarget container.

This method returns a mutable pointer to a Graph::IMeshResourceTarget container, which allows to add, remove or query the path mesh resource.

Returns
The mutable Graph::IMeshResourceTarget container, or null if not available

◆ GetMeshResourceTarget() [2/2]

virtual const IMeshResourceTarget* Murl::Graph::IBonePathConstraint::GetMeshResourceTarget ( ) const
pure virtual

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.

Returns
The constant Graph::IMeshResourceTarget container, or null if not available

◆ SetPositionBlendFactor() [1/3]

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionBlendFactor ( const Vector factor)
pure virtual

Set the position blend factor.

Parameters
factorThe position blend factor.
Returns
true if successful.

◆ SetPositionBlendFactor() [2/3]

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionBlendFactor ( Real  x,
Real  y,
Real  z 
)
pure virtual

Set the position blend factor.

Parameters
xThe x component.
yThe y component.
zThe z component.
Returns
true if successful.

◆ SetPositionBlendFactor() [3/3]

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionBlendFactor ( Real  f)
pure virtual

Set the position blend factor.

Parameters
fThe common blend factor for all three components (X, Y and Z).
Returns
true if successful.

◆ SetPositionBlendFactorX()

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionBlendFactorX ( Real  x)
pure virtual

Set the X component of the position blend factor.

Parameters
xThe x component.
Returns
true if successful.

◆ SetPositionBlendFactorY()

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionBlendFactorY ( Real  y)
pure virtual

Set the Y component of the position blend factor.

Parameters
yThe y component.
Returns
true if successful.

◆ SetPositionBlendFactorZ()

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionBlendFactorZ ( Real  z)
pure virtual

Set the Z component of the position blend factor.

Parameters
zThe z component.
Returns
true if successful.

◆ GetPositionBlendFactor()

virtual const Vector& Murl::Graph::IBonePathConstraint::GetPositionBlendFactor ( ) const
pure virtual

Get the position blend factor.

Returns
The position blend factor.

◆ GetPositionBlendFactorX()

virtual Real Murl::Graph::IBonePathConstraint::GetPositionBlendFactorX ( ) const
pure virtual

Get the X component of the position blend factor.

Returns
The x component.

◆ GetPositionBlendFactorY()

virtual Real Murl::Graph::IBonePathConstraint::GetPositionBlendFactorY ( ) const
pure virtual

Get the Y component of the position blend factor.

Returns
The y component.

◆ GetPositionBlendFactorZ()

virtual Real Murl::Graph::IBonePathConstraint::GetPositionBlendFactorZ ( ) const
pure virtual

Get the Z component of the position blend factor.

Returns
The z component.

◆ SetRotationBlendFactor()

virtual Bool Murl::Graph::IBonePathConstraint::SetRotationBlendFactor ( Real  factor)
pure virtual

Set the rotation blend factor.

Parameters
factorThe rotation blend factor.
Returns
true if successful.

◆ GetRotationBlendFactor()

virtual Real Murl::Graph::IBonePathConstraint::GetRotationBlendFactor ( ) const
pure virtual

Get the rotation blend factor.

Returns
The rotation blend factor.

◆ SetPositionOffset()

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionOffset ( Real  offset)
pure virtual

Set the position offset.

Parameters
offsetThe position offset.
Returns
true if successful.

◆ GetPositionOffset()

virtual Real Murl::Graph::IBonePathConstraint::GetPositionOffset ( ) const
pure virtual

Get the position offset.

Returns
The position offset.

◆ SetRotationOffset()

virtual Bool Murl::Graph::IBonePathConstraint::SetRotationOffset ( Real  offset)
pure virtual

Set the rotation offset.

Parameters
offsetThe rotation offset.
Returns
true if successful.

◆ GetRotationOffset()

virtual Real Murl::Graph::IBonePathConstraint::GetRotationOffset ( ) const
pure virtual

Get the rotation offset.

Returns
The rotation offset.

◆ SetSpacing()

virtual Bool Murl::Graph::IBonePathConstraint::SetSpacing ( Real  spacing)
pure virtual

Set the spacing value.

Parameters
spacingThe spacing value.
Returns
true if successful.

◆ GetSpacing()

virtual Real Murl::Graph::IBonePathConstraint::GetSpacing ( ) const
pure virtual

Get the spacing value.

Returns
The spacing value.

◆ SetPositionMode()

virtual Bool Murl::Graph::IBonePathConstraint::SetPositionMode ( IEnums::PathPositionMode  mode)
pure virtual

Set the position mode.

Parameters
modeThe position mode.
Returns
true if successful.

◆ GetPositionMode()

virtual IEnums::PathPositionMode Murl::Graph::IBonePathConstraint::GetPositionMode ( ) const
pure virtual

Get the position mode.

Returns
The position mode.

◆ SetRotationMode()

virtual Bool Murl::Graph::IBonePathConstraint::SetRotationMode ( IEnums::PathRotationMode  mode)
pure virtual

Set the rotation mode.

Parameters
modeThe rotation mode.
Returns
true if successful.

◆ GetRotationMode()

virtual IEnums::PathRotationMode Murl::Graph::IBonePathConstraint::GetRotationMode ( ) const
pure virtual

Get the rotation mode.

Returns
The rotation mode.

◆ SetSpacingMode()

virtual Bool Murl::Graph::IBonePathConstraint::SetSpacingMode ( IEnums::PathSpacingMode  mode)
pure virtual

Set the spacing mode.

Parameters
modeThe spacing mode.
Returns
true if successful.

◆ GetSpacingMode()

virtual IEnums::PathSpacingMode Murl::Graph::IBonePathConstraint::GetSpacingMode ( ) const
pure virtual

Get the spacing mode.

Returns
The spacing mode.

◆ SetMovementMode()

virtual Bool Murl::Graph::IBonePathConstraint::SetMovementMode ( IEnums::PathMovementMode  mode)
pure virtual

Set the movement mode.

Parameters
modeThe movement mode.
Returns
true if successful.

◆ GetMovementMode()

virtual IEnums::PathMovementMode Murl::Graph::IBonePathConstraint::GetMovementMode ( ) const
pure virtual

Get the movement mode.

Returns
The movement mode.

◆ SetClosed()

virtual Bool Murl::Graph::IBonePathConstraint::SetClosed ( Bool  isClosed)
pure virtual

Set if the path is closed.

Parameters
isClosedtrue if closed.
Returns
true if successful.

◆ IsClosed()

virtual Bool Murl::Graph::IBonePathConstraint::IsClosed ( ) const
pure virtual

Check if the path is closed.

Returns
true if closed.

◆ SetMaxNumberOfBonesPerVertex()

virtual Bool Murl::Graph::IBonePathConstraint::SetMaxNumberOfBonesPerVertex ( UInt32  maxNumBones)
pure virtual

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

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

◆ GetMaxNumberOfBonesPerVertex()

virtual UInt32 Murl::Graph::IBonePathConstraint::GetMaxNumberOfBonesPerVertex ( ) const
pure virtual

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

Returns
The maximum number of bones.

The documentation for this interface was generated from the following file:
  • murl_graph_i_bone_path_constraint.h


Copyright © 2011-2022 Spraylight GmbH.