Detailed Description
- See also:
- : Class IKCmdOps, Class IIKChainControl
class IKChainActions : public FPStaticInterface
- Description:
- This class is only available in release 5 or later. The
program interface to actions on IK chain nodes, which IKCmdOps::CreateIKChain()
returns. An macro is defined to obtain a pointer to the
interface:
IKChainActions* ikchainAction = GET_IKCHAIN_FP_INTERFACE;
It should be a valid pointer provided the IK system is successfully loaded.
The methods are mainly designed to connect to the UI and script. However, they can be called programmatically as well. The action methods, those that return FPStatus, assume that a unique IK chain node is currently selected and apply action to it. Before an action method is called, IsSnapEnabled() must be called to test whether a unique IK chain node is being selected. Such as:
if (ikchainAction->IsSnapEnabled()) ikchainAction->SetPreferredAngles();
#include <iiksys.h>
Inheritance diagram for
IKChainActions:
Public Member Functions |
|
| virtual FPStatus | SnapAction ()=0 |
| virtual FPStatus | IKSnapAction ()=0 |
| virtual FPStatus | FKSnapAction ()=0 |
| virtual BOOL | IsSnapEnabled ()=0 |
| virtual FPStatus | ToggleEnabled ()=0 |
| virtual FPStatus | SetPreferredAngles ()=0 |
| virtual FPStatus | AssumePreferredAngles ()=0 |
Member Function Documentation
| virtual FPStatus SnapAction | ( | ) | [pure virtual] |
- Remarks:
- It applies IKSnapAction()
if IK Enabled is currently off, and FKSnapAction()
if IK Enabled is on.
| virtual FPStatus IKSnapAction | ( | ) | [pure virtual] |
- Remarks:
- Applies IK Snapping, which sets IK goal and other parameters,
such as the swivel angle, according to the current state of the
bone chain. Moreover, it invokes SetPreferredAngles().
| virtual FPStatus FKSnapAction | ( | ) | [pure virtual] |
- Remarks:
- Applies FK Snapping, which assigns the currently active joint
angles to the corresponding FK angles. Moreover, it invokes
SetPreferredAngles().
| virtual BOOL IsSnapEnabled | ( | ) | [pure virtual] |
| virtual FPStatus ToggleEnabled | ( | ) | [pure virtual] |
- Remarks:
- Toggles IK Enabled state. If the AutoSnap parameter of the IK
chain is true, it will invoke SnapAction()
before toggling the Enabled state.
| virtual FPStatus SetPreferredAngles | ( | ) | [pure virtual] |
- Remarks:
- It sets the preferred angles of all bones on the chain to the
corresponding joint angles currently in force, which can be FK or
IK depending the state of Enabled.
| virtual FPStatus AssumePreferredAngles | ( | ) | [pure virtual] |
- Remarks:
- It assigns the preferred angles to the corresponding FK angles and then turn off IK Enabled.
