IFXAnimationModifierParam |
The IFXAnimationModifierParam interface manages the IFXModel-level attibutes for the IFXAnimationModifier. This interface is supported by the CIFXAnimationModifierParam component only.
Methods
|
Interface Methods |
Description |
|
Stops all mixers |
|
|
Plays top and any paused mixers |
|
|
Adds a mixer to the top of the stack |
|
|
Adds a mixer to the bottom of the stack |
|
|
Removes the top mixer on the stack |
|
|
Removes the bottom mixer on the stack |
|
|
Gets the indexed mixer's time relative to its original time value |
|
|
Sets the indexed mixer's time relative to its original time value |
|
|
Accesses Root Lock property |
|
|
Accesses the Time Scale property and adjusts playback speed for all mixers |
|
|
Transitions over BlendTime as opposed to manually updated BlendFraction |
|
|
Indicates the transition time for blending |
|
|
Transitions from current blend, from last to next |
|
|
Accesses Playing property |
|
|
Controls concatenation of motion |
|
|
Controls selective axial lock |
|
|
Stores displacement along axis |
|
|
Gets the number of mixers on the Animation queue |
|
|
Gets the number of the stored mixers recently removed from the queue |
|
|
Drives the motion of a singleton-deformable object instead of the superset that animates a skeleton with deformable skin |
|
|
Gets IFXSkeletonMixer indexed relative to head of the queue |
|
|
Gets the indexed IFXSkeletonMixer without reference counting |
|
|
Gets the previously removed indexed IFXSkeletonMixer without reference counting |
|
|
Gets a bone's transform relative to its parent |
|
|
Sets a bone's transform relative to its parent |
|
|
Sets a bone's transform in absolute world space |
|
|
Advances time in all running mixers |
|
|
Indicates first update has occurred |
|
|
Caches root transform |
This method stops all mixers.
Parameters:
None
This method plays top and any paused mixers.
Parameters:
None
This method adds a mixer to the top of the stack.
Parameters:
|
name |
Name of the parameter |
|
*timeOffset |
Applies when the motion starts playing |
|
*timeScale |
Changes the speed of the playback |
|
*loop |
Repeats the animation outside the original limits |
|
*sync |
Adjusts time alignment to match the adjacent synchronized mixers on the basis of percent completed |
|
tail=false |
Queues the motion to the bottom of the stack |
This method adds a mixer to the bottom of the stack. (Same as Push() with tail=true)
Parameters:
|
name |
Name of the parameter |
|
*timeOffset |
Applies when the motion starts playing |
|
*timeScale |
Changes the speed of the playback |
|
*loop |
Repeats the animation outside the original limits |
|
*sync |
Adjusts time alignment to match the adjacent synchronized mixers on the basis of percent completed |
This method removes the top mixer on the stack.
|
tail=false |
Queues the motion to the bottom of the stack. The default is to pop from the top of the stack |
This method removes the bottom mixer on the stack. (Same as Pop() with tail=true)
Parameters:
None
This method gets the indexed mixer's time relative to its original unoffset min/max.
Parameters:
|
index |
Index number of mixer |
|
*localtime |
Pointer to the mixer's original time values |
This method sets the indexed mixer's time relative to its original unoffset min/max.
Parameters:
|
index |
Index number of mixer |
|
localtime |
The mixer's original time values |
This method accesses Root Lock property. This stops translation of the root bone.
Parameters:
None
Return Values:
BOOL&
This method accesses the Time Scale property and adjusts playback speed for all mixers.
Parameters:
None
Return Values:
F32&
This method transitions over BlendTime as opposed to manually updated BlendFraction.
Parameters:
None
Return Values:
BOOL&
This method indicates the transition time for blending.
Parameters:
None
Return Values:
F32&
This method transitions from current blend, from last to next. Blending stops when greater than 1.0.
Parameters:
None
Return Values:
F32&
This method accesses Playing property, which will indicate if mixers can play, parallelling Play and Pause().
Parameters:
None
Return Values:
BOOL&
This method controls concatenation of motion by position by using bit toggles in enum IFXAnimationModifierParam::Cat.
Parameters:
None
Return Values:
U32
This method stores displacement along an axis.
Parameters:
None
Return Values:
IFXVector3
This method controls selective axial lock and is more flexible than RootLock.
Parameters:
None
Return Values:
U32
Gets the number of mixers in the Animation queue.
Parameters:
None
Return Values:
U32
This method gets the number of the stored mixers recently removed from the queue.
Parameters:
None
Return Values:
U32
This method is set to True when operating as single-track, also known as "KeyFrame mode." When set to True, the motion of a singleton-deformable object is driven instead of the superset that animates a skeleton with deformable skin.
Parameters:
None
Return Values:
BOOL
This method gets IFXSkeletonMixer indexed relative to head of the queue.
Parameters:
|
index |
Index number of mixer |
Return Values:
IFXSkeletonMixer *
This method gets the indexed IFXSkeletonMixer without reference counting. Only valid for immediate use.
Parameters:
|
index |
Index number of mixer |
Return Values:
IFXSkeletonMixer *
This method gets IFXBonesManager. Only valid for the life of this param.
Parameters:
None
Return Values:
IFXBonesManagerInterface *
This method gets the previously removed indexed IFXSkeletonMixer without reference counting. Only valid for immediate use.
Parameters:
|
index |
Index number of mixer |
Return Values:
IFXSkeletonMixer *
This method gets a bone's transform relative to it's parent. All transform access is copy-based, not direct access.
Parameters:
|
boneID |
Bone ID number |
|
pMatrix16 |
Pointer to the Matrix number |
This method sets a bone's transform relative to it's parent. All transform access is copy-based, not direct access.
Parameters:
|
boneID |
Bone ID number |
|
pMatrix16 |
Pointer to the Matrix number |
This method sets a bone's transform in absolute world space. All transform access is copy-based, not direct access.
Parameters:
|
boneID |
Bone ID number |
|
pMatrix16 |
Pointer to the Matrix number |
Internal use: Advances time in all running mixers.
Parameters:
None
Internal use: Indicates whether first update has occurred (flag set by modifier).
Parameters:
None
Return Values:
BOOL
Internal use: Caches root transform.
Parameters:
None
Return Values:
IFXTransform &
§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.