This reference page is linked to from the following overview topics: Incremental Improvements.
Detailed Description
Interface into the biped master controller.
This contains functions supporting new biped features.
#include <Biped12Api.h>
Public Member Functions |
|
|
Knuckles
|
|
|
When Knuckles is set to true, the hand is shrunk, the fingers have 4 links, splay out from the hand, and ThumbMinusOne is set to true. When Knuckles is set to false, the fingers and hands appear as in 3ds Max 2009, and ThumbMinusOne is set to false. |
|
| virtual BOOL | GetKnuckles () const =0 |
| Queries the value of Knuckles. |
|
| virtual void | SetKnuckles (BOOL bEnabled)=0 |
| Sets Knuckles. |
|
|
ShortThumb
|
|
|
If ShortThumb is true, the thumb has one less link than the other fingers, except when there is only one link per finger. If ShortThumb is false, the thumb has the same number of links as the fingers. |
|
| virtual BOOL | GetShortThumb () const =0 |
| Queries the value of ShortThumb. |
|
| virtual void | SetShortThumb (BOOL bEnabled)=0 |
| Sets ShortThumb. |
|
|
Layer Retargeting
|
|
|
The following functions are used for retargeting biped layer animation, either to the base layer or to a reference biped. |
|
| virtual bool | GetLimbRetargetState (int keytrack)=0 |
| Gets the layer retarget state for a limb.
|
|
| virtual void | SetLimbRetargetState (int keytrack, bool bEnabled)=0 |
| Sets the layer retarget state for a limb.
|
|
| virtual INode * | GetRetargetReferenceBiped ()=0 |
| Gets the retarget reference biped. |
|
| virtual bool | SetRetargetReferenceBiped (INode *node)=0 |
| Sets the retarget reference biped. |
|
| virtual void | RetargetToBaseLayer (bool IK_Only)=0 |
| Retargets the current biped layer to its
base layer. |
|
| virtual void | RetargetToReferenceBiped (bool IK_Only)=0 |
| Retargets the current biped layer to the
reference biped. |
|
Biped Interface Access |
|
| static const ULONG | I_BIPMASTER12 = 0x9172 |
| Biped interface identifier. |
|
| static BIPExport IBipMaster12 * | GetBipMaster12Interface (Animatable &anim) |
| Gets the Biped interface. |
|
Member Function Documentation
| static BIPExport IBipMaster12* GetBipMaster12Interface | ( | Animatable & | anim | ) | [static] |
Gets the Biped interface.
- Parameters:
-
[in] anim - the Animatable whose Biped interface is returned
- Returns:
- the Biped interface
| virtual BOOL GetKnuckles | ( | ) | const [pure virtual] |
Queries the value of Knuckles.
- Returns:
- true if Knuckles is on, false if not
| virtual void SetKnuckles | ( | BOOL | bEnabled | ) | [pure virtual] |
Sets Knuckles.
- Precondition:
- must be in figure mode
- ForeFeet must be false
- Parameters:
-
[in] bEnabled - sets Knuckles to the value of bEnabled
| virtual BOOL GetShortThumb | ( | ) | const [pure virtual] |
Queries the value of ShortThumb.
- Returns:
- true if ShortThumb is on, false if not
| virtual void SetShortThumb | ( | BOOL | bEnabled | ) | [pure virtual] |
Sets ShortThumb.
- Precondition:
- must be in figure mode
- Knuckles must be true
- Parameters:
-
[in] bEnabled - sets ShortThumb to the value of bEnabled
| virtual bool GetLimbRetargetState | ( | int | keytrack | ) | [pure virtual] |
Gets the layer retarget state for a limb.
- Parameters:
-
[in] keytrack - KEY_LARM or KEY_RARM or KEY_LLEG or KEY_RLEG
- Returns:
- true if the limb's retarget state is on, false if not
| virtual void SetLimbRetargetState | ( | int | keytrack, |
| bool | bEnabled | ||
| ) | [pure virtual] |
Sets the layer retarget state for a limb.
- Parameters:
-
[in] keytrack - KEY_LARM or KEY_RARM or KEY_LLEG or KEY_RLEG [in] bEnabled - sets the limb retarget state to the value of bEnabled.
| virtual INode* GetRetargetReferenceBiped | ( | ) | [pure virtual] |
Gets the retarget reference biped.
- Returns:
- the retarget reference biped if there is one, NULL if not
| virtual bool SetRetargetReferenceBiped | ( | INode * | node | ) | [pure virtual] |
Sets the retarget reference biped.
- Parameters:
-
[in] node - sets the reference biped to the node, which must be any node from a different biped.
- See also:
- RetargetToReferenceBiped(bool IK_Only)
- Returns:
- true if the reference biped was set correctly, false if not
| virtual void RetargetToBaseLayer | ( | bool | IK_Only | ) | [pure virtual] |
Retargets the current biped layer to its base layer.
For every limb whose retarget state is active, calculates the hand/foot position at every key, maintaining IK constraints to the base layer.
- Precondition:
- A layer must be active
- See also:
- SetLayerActive(int index, bool onOff)
- Parameters:
-
[in] IK_Only - When IK_Only is on, the biped's constrained hands and feet are retargeted only during the frames on which they are IK controlled. When IK_Only is off, the hands and feet are retargeted during both IK and FK keys.
| virtual void RetargetToReferenceBiped | ( | bool | IK_Only | ) | [pure virtual] |
Retargets the current biped layer to the reference biped.
For every limb whose retarget state is active, calculates the hand/foot position at every key, maintaining IK constraints to the retarget biped.
- Precondition:
- A retarget biped must be specified.
- See also:
- SetRetargetReferenceBiped()
- Parameters:
-
[in] IK_Only - When IK_Only is on, the biped's constrained hands and feet are retargeted only during the frames on which they are IK controlled. When IK_Only is off, the hands and feet are retargeted during both IK and FK keys.
Member Data Documentation
const ULONG I_BIPMASTER12
= 0x9172 [static] |
Biped interface identifier.
