Murl::Graph::IBoneTransformConstraint Interface Referenceabstract

The IBoneTransformConstraint graph node interface. More...

#include "murl_graph_i_bone_transform_constraint.h"

Inheritance diagram for Murl::Graph::IBoneTransformConstraint:

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 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 SetScaleBlendFactor (const Vector &factor)=0
 Set the scale blend factor. More...
 
virtual Bool SetScaleBlendFactor (Real x, Real y, Real z)=0
 Set the scale blend factor. More...
 
virtual Bool SetScaleBlendFactor (Real f)=0
 Set the scale blend factor. More...
 
virtual Bool SetScaleBlendFactorX (Real x)=0
 Set the X component of the scale blend factor. More...
 
virtual Bool SetScaleBlendFactorY (Real y)=0
 Set the Y component of the scale blend factor. More...
 
virtual Bool SetScaleBlendFactorZ (Real z)=0
 Set the Z component of the scale blend factor. More...
 
virtual const VectorGetScaleBlendFactor () const =0
 Get the scale blend factor. More...
 
virtual Real GetScaleBlendFactorX () const =0
 Get the X component of the scale blend factor. More...
 
virtual Real GetScaleBlendFactorY () const =0
 Get the Y component of the scale blend factor. More...
 
virtual Real GetScaleBlendFactorZ () const =0
 Get the Z component of the scale blend factor. More...
 
virtual Bool SetShearBlendFactor (Real factor)=0
 Set the shear blend factor. More...
 
virtual Real GetShearBlendFactor () const =0
 Get the shear blend factor. More...
 
virtual Bool SetPositionOffset (Real offsetX, Real offsetY)=0
 Set the position offset. More...
 
virtual Bool SetPositionOffsetX (Real offsetX)=0
 Set the position X offset. More...
 
virtual Bool SetPositionOffsetY (Real offsetY)=0
 Set the position Y offset. More...
 
virtual Real GetPositionOffsetX () const =0
 Get the position X offset. More...
 
virtual Real GetPositionOffsetY () const =0
 Get the position Y 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 SetScaleOffset (Real offsetX, Real offsetY)=0
 Set the scale offset. More...
 
virtual Bool SetScaleOffsetX (Real offsetX)=0
 Set the scale X offset. More...
 
virtual Bool SetScaleOffsetY (Real offsetY)=0
 Set the scale Y offset. More...
 
virtual Real GetScaleOffsetX () const =0
 Get the scale X offset. More...
 
virtual Real GetScaleOffsetY () const =0
 Get the scale Y offset. More...
 
virtual Bool SetShearOffsetY (Real offsetY)=0
 Set the shear Y offset. More...
 
virtual Real GetShearOffsetY () const =0
 Get the shear Y offset. More...
 
virtual Bool SetLocal (Bool isLocal)=0
 Set if transforms are calculated in local space. More...
 
virtual Bool IsLocal () const =0
 Check if transforms are calculated in local space. More...
 
virtual Bool SetRelative (Bool isRelative)=0
 Set if transforms are calculated relative to the bones' parents. More...
 
virtual Bool IsRelative () const =0
 Check if transforms are calculated relative to the bones' parents. More...
 

Detailed Description

The IBoneTransformConstraint graph node interface.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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

◆ SetPositionBlendFactor() [1/3]

virtual Bool Murl::Graph::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::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::IBoneTransformConstraint::GetPositionBlendFactor ( ) const
pure virtual

Get the position blend factor.

Returns
The position blend factor.

◆ GetPositionBlendFactorX()

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

Get the X component of the position blend factor.

Returns
The x component.

◆ GetPositionBlendFactorY()

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

Get the Y component of the position blend factor.

Returns
The y component.

◆ GetPositionBlendFactorZ()

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

Get the Z component of the position blend factor.

Returns
The z component.

◆ SetRotationBlendFactor()

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

Set the rotation blend factor.

Parameters
factorThe rotation blend factor.
Returns
true if successful.

◆ GetRotationBlendFactor()

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

Get the rotation blend factor.

Returns
The rotation blend factor.

◆ SetScaleBlendFactor() [1/3]

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleBlendFactor ( const Vector factor)
pure virtual

Set the scale blend factor.

Parameters
factorThe scale blend factor.
Returns
true if successful.

◆ SetScaleBlendFactor() [2/3]

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleBlendFactor ( Real  x,
Real  y,
Real  z 
)
pure virtual

Set the scale blend factor.

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

◆ SetScaleBlendFactor() [3/3]

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleBlendFactor ( Real  f)
pure virtual

Set the scale blend factor.

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

◆ SetScaleBlendFactorX()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleBlendFactorX ( Real  x)
pure virtual

Set the X component of the scale blend factor.

Parameters
xThe x component.
Returns
true if successful.

◆ SetScaleBlendFactorY()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleBlendFactorY ( Real  y)
pure virtual

Set the Y component of the scale blend factor.

Parameters
yThe y component.
Returns
true if successful.

◆ SetScaleBlendFactorZ()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleBlendFactorZ ( Real  z)
pure virtual

Set the Z component of the scale blend factor.

Parameters
zThe z component.
Returns
true if successful.

◆ GetScaleBlendFactor()

virtual const Vector& Murl::Graph::IBoneTransformConstraint::GetScaleBlendFactor ( ) const
pure virtual

Get the scale blend factor.

Returns
The scale blend factor.

◆ GetScaleBlendFactorX()

virtual Real Murl::Graph::IBoneTransformConstraint::GetScaleBlendFactorX ( ) const
pure virtual

Get the X component of the scale blend factor.

Returns
The x component.

◆ GetScaleBlendFactorY()

virtual Real Murl::Graph::IBoneTransformConstraint::GetScaleBlendFactorY ( ) const
pure virtual

Get the Y component of the scale blend factor.

Returns
The y component.

◆ GetScaleBlendFactorZ()

virtual Real Murl::Graph::IBoneTransformConstraint::GetScaleBlendFactorZ ( ) const
pure virtual

Get the Z component of the scale blend factor.

Returns
The z component.

◆ SetShearBlendFactor()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetShearBlendFactor ( Real  factor)
pure virtual

Set the shear blend factor.

Parameters
factorThe shear blend factor.
Returns
true if successful.

◆ GetShearBlendFactor()

virtual Real Murl::Graph::IBoneTransformConstraint::GetShearBlendFactor ( ) const
pure virtual

Get the shear blend factor.

Returns
The shear blend factor.

◆ SetPositionOffset()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetPositionOffset ( Real  offsetX,
Real  offsetY 
)
pure virtual

Set the position offset.

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

◆ SetPositionOffsetX()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetPositionOffsetX ( Real  offsetX)
pure virtual

Set the position X offset.

Parameters
offsetXThe position X offset.
Returns
true if successful.

◆ SetPositionOffsetY()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetPositionOffsetY ( Real  offsetY)
pure virtual

Set the position Y offset.

Parameters
offsetYThe position Y offset.
Returns
true if successful.

◆ GetPositionOffsetX()

virtual Real Murl::Graph::IBoneTransformConstraint::GetPositionOffsetX ( ) const
pure virtual

Get the position X offset.

Returns
The position X offset.

◆ GetPositionOffsetY()

virtual Real Murl::Graph::IBoneTransformConstraint::GetPositionOffsetY ( ) const
pure virtual

Get the position Y offset.

Returns
The position Y offset.

◆ SetRotationOffset()

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

Set the rotation offset.

Parameters
offsetThe rotation offset.
Returns
true if successful.

◆ GetRotationOffset()

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

Get the rotation offset.

Returns
The rotation offset.

◆ SetScaleOffset()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleOffset ( Real  offsetX,
Real  offsetY 
)
pure virtual

Set the scale offset.

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

◆ SetScaleOffsetX()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleOffsetX ( Real  offsetX)
pure virtual

Set the scale X offset.

Parameters
offsetXThe scale X offset.
Returns
true if successful.

◆ SetScaleOffsetY()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetScaleOffsetY ( Real  offsetY)
pure virtual

Set the scale Y offset.

Parameters
offsetYThe scale Y offset.
Returns
true if successful.

◆ GetScaleOffsetX()

virtual Real Murl::Graph::IBoneTransformConstraint::GetScaleOffsetX ( ) const
pure virtual

Get the scale X offset.

Returns
The scale X offset.

◆ GetScaleOffsetY()

virtual Real Murl::Graph::IBoneTransformConstraint::GetScaleOffsetY ( ) const
pure virtual

Get the scale Y offset.

Returns
The scale Y offset.

◆ SetShearOffsetY()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetShearOffsetY ( Real  offsetY)
pure virtual

Set the shear Y offset.

Parameters
offsetYThe shear Y offset.
Returns
true if successful.

◆ GetShearOffsetY()

virtual Real Murl::Graph::IBoneTransformConstraint::GetShearOffsetY ( ) const
pure virtual

Get the shear Y offset.

Returns
The shear Y offset.

◆ SetLocal()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetLocal ( Bool  isLocal)
pure virtual

Set if transforms are calculated in local space.

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

◆ IsLocal()

virtual Bool Murl::Graph::IBoneTransformConstraint::IsLocal ( ) const
pure virtual

Check if transforms are calculated in local space.

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

◆ SetRelative()

virtual Bool Murl::Graph::IBoneTransformConstraint::SetRelative ( Bool  isRelative)
pure virtual

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

Parameters
isRelativetrue if relative.
Returns
true if successful.

◆ IsRelative()

virtual Bool Murl::Graph::IBoneTransformConstraint::IsRelative ( ) const
pure virtual

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

Returns
true if relative.

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


Copyright © 2011-2022 Spraylight GmbH.