Detailed Description
Interface to the IK Key Property.
This class defines the interface to the IK key property. This property has a property ID of IKeyProperty::kIKProp. A pointer to IKeyProperty whose propertyID is kIKProp can be safely cast to a pointer to an IIKKeyProp:
if (ptr->GetPropID() == IKeyProperty::kIKProp) IIKKeyProp* ikProp = (IIKKeyProp*)ptr;
#include <istdplug.h>
Public Types |
|
| enum | EnumIKSpace { kBodySpace, kObjectSpace } |
|
The enum type for the space with regard to which the IK goal is interpreted. More... |
|
Public Member Functions |
|
| PropID | GetPropID () const |
| The Property ID of this interface. |
|
| virtual float | GetIKBlend () const =0 |
| Get the IK Blend attribute of the property.
|
|
| virtual EnumIKSpace | GetIKSpace () const =0 |
| Get the IK Space attribute of the property.
|
|
| virtual bool | GetPivotOn () const =0 |
| Get the Pivot On attribute of the property.
|
|
| virtual Point3 | GetWorldPivot () const =0 |
| Get the World Pivot attribute of the
property. |
|
| virtual INode * | GetPivotNode () const =0 |
| Get the Pivot Node attribute of the
property. |
|
| virtual bool | SetIKBlend () const |
| When passed in IKeyControl2::SetKeyProp(),
it tells whether to set value to the IK Blend attribute. |
|
| virtual bool | SetIKSpace () const |
| When passed in IKeyControl2::SetKeyProp(),
it tells whether to set value to the IK Space attribute. |
|
| virtual bool | SetPivotOn () const |
| When passed in IKeyControl2::SetKeyProp(),
it tells whether to set value to the Pivot On attribute. |
|
| virtual bool | SetWorldPivot () const |
| When passed in IKeyControl2::SetKeyProp(),
it tells whether to set value to the World Pivot attribute.
|
|
| virtual bool | SetPivotNode () const |
| When passed in IKeyControl2::SetKeyProp(),
it tells whether to set value to the Pivot Node attribute. |
|
Member Enumeration Documentation
| enum EnumIKSpace |
The enum type for the space with regard to which the IK goal is interpreted.
- Enumerator:
-
kBodySpace The body space is the parent space of the start bone shifted by the position of the start bone.
kObjectSpace The object space if the parent space of the IK goal object.
{
kBodySpace,
kObjectSpace,
};
Member Function Documentation
| PropID GetPropID | ( | ) | const [inline, virtual] |
The Property ID of this interface.
- See also:
- IKeyProperty::GetPropID
Implements IKeyProperty.
{ return IKeyProperty::kIKProp; }
| virtual float GetIKBlend | ( | ) | const [pure virtual] |
Get the IK Blend attribute of the property.
It should be in the range of [0,1].
Implemented in ISetIKKeyProp.
| virtual EnumIKSpace GetIKSpace | ( | ) | const [pure virtual] |
Get the IK Space attribute of the property.
Implemented in ISetIKKeyProp.
| virtual bool GetPivotOn | ( | ) | const [pure virtual] |
Get the Pivot On attribute of the property.
Implemented in ISetIKKeyProp.
| virtual Point3 GetWorldPivot | ( | ) | const [pure virtual] |
Get the World Pivot attribute of the property.
Implemented in ISetIKKeyProp.
| virtual INode* GetPivotNode | ( | ) | const [pure virtual] |
Get the Pivot Node attribute of the property.
Implemented in ISetIKKeyProp.
| virtual bool SetIKBlend | ( | ) | const [inline, virtual] |
When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the IK Blend attribute.
If it is true, GetIKBlend() will be used as the target of the set value.
{ return false; }
| virtual bool SetIKSpace | ( | ) | const [inline, virtual] |
When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the IK Space attribute.
If it is true, GetIKSpace() will be used as the target of the set value.
{ return false; }
| virtual bool SetPivotOn | ( | ) | const [inline, virtual] |
When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the Pivot On attribute.
If it is true, GetPivotOn() will be used as the target of the set value.
{ return false; }
| virtual bool SetWorldPivot | ( | ) | const [inline, virtual] |
When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the World Pivot attribute.
If it is true, GetWorldPivot() will be used as the target of the set value.
{ return false; }
| virtual bool SetPivotNode | ( | ) | const [inline, virtual] |
When passed in IKeyControl2::SetKeyProp(), it tells whether to set value to the Pivot Node attribute.
If it is true, GetPivotNode() will be used as the target of the set value.
{ return false; }
