Detailed Description
An interface to the new functionality for max 8 for clips in the mixer.
Contains functionality relating to the new functionality for max clips, including the name of the max map file, and the particular transition information needed to transition max clips. Inherits from IMXclip. The interface is accessed via IMXclip::GetClip8 or IMXclip::GetTransClip8 /see IMXtrack8::GetClip8 /see IMXtrack8::GetTransClip8
#include <IMixer8.h>
Inheritance diagram for IMXclip8:
Public Member Functions |
|
| virtual bool | IsMax ()=0 |
| Whether or not a max clip or a biped clip.
|
|
| virtual
const MaxSDK::AssetManagement::AssetUser & |
MaxMap ()=0 |
| The name of the possible map file for a max
clip. |
|
| virtual bool | LoadMaxAnimationFile (int loadOption, const MCHAR *filename, const MCHAR *mapfilename=NULL)=0 |
| Loads the clip with the given options and
animation files. |
|
| virtual void | SetTransitionYawPitchRoll (const bool yaw, const bool pitch, const bool roll)=0 |
| Set whether or not velocity blended nodes
yaw,pitch and roll angles will get accumulated or not. |
|
| virtual void | GetTransitionYawPitchRoll (bool &yaw, bool &pitch, bool &roll)=0 |
| Get whether or not velocity blended nodes
yaw,pitch and roll angles will get accumulated or not. |
|
| virtual void | SetTransitionYawPitchRollAngle (const float yaw, const float pitch, const float roll)=0 |
| Set the transition yaw,pitch and roll
angles. |
|
| virtual void | GetTransitionYawPitchRollAngle (float &yaw, float &pitch, float &roll)=0 |
| Get the transition yaw,pitch and roll
angles. |
|
| virtual void | SetTransitionXYZ (const bool x, const bool y, const bool z)=0 |
| Set whether or not velocity blended nodes
x,y, and z positions will get accumulated or not. |
|
| virtual void | GetTransitionXYZ (bool &x, bool &y, bool &z)=0 |
| Get whether or not velocity blended nodes
x,y and z positions will get accumulated. |
|
|
Transition Clip Information
|
|
| virtual void | GetVelocityBlends (INodeTab &nodeTab)=0 |
| Get the nodes that make up the velocity
blended nodes for a transition. Only works with max clips. |
|
| virtual void | SetVelocityBlends (const INodeTab &nodeTab)=0 |
| Set the nodes that make up the velocity
blended nodes. Only works with max clips. |
|
|
SubBlendNodes
|
|
| virtual void | GetSubBlendNodes (INodeTab &nodeTab)=0 |
| Get the nodes that make up the the sub
blended nodes. Only works with max clips. |
|
| virtual void | SetSubBlendNodes (const INodeTab &nodeTab)=0 |
| Set the nodes that make up the sub blended
nodes. Only works with max clips. |
|
| virtual void | GetSubBlendNodesParents (INodeTab &nodeTab)=0 |
| Get the nodes that make up the sub blended
nodes parents. Only works with max clips. |
|
| virtual void | SetSubBlendNodesParents (const INodeTab &nodeTab)=0 |
| Set the nodes that make up the sub blended
parent nodes. Only works with max clips. |
|
Member Function Documentation
| virtual bool IsMax | ( | ) | [pure virtual] |
Whether or not a max clip or a biped clip.
- Returns:
- Returns True if it's a max clip, false if it's a biped clip
| virtual const MaxSDK::AssetManagement::AssetUser& MaxMap | ( | ) | [pure virtual] |
The name of the possible map file for a max clip.
- Returns:
- the name of the map file if one exists, otherwise returns empty string
| virtual bool LoadMaxAnimationFile | ( | int | loadOption, |
| const MCHAR * | filename, | ||
| const MCHAR * | mapfilename =
NULL |
||
| ) | [pure virtual] |
Loads the clip with the given options and animation files.
Only works with max clips.
- Parameters:
-
[in] loadOption Must be one of the following defined in IMixer.h. RE_SOURCE_CLIP_ONLY, RE_SOURCE_INSTANCES, RE_SOURCE_FILEGROUP. RE_SOURCE_CLIP_ONLY: the file will be loaded into just this single clip. RE_SOURCE_INSTANCES: the file will be loaded into this clip and all instances of this clip. RE_SOURCE_FILEGROUP: the file will be loaded into this clip and all instances and adaptations of this clip. [in] filename The name of the max animation file(.xaf) to be loaded. It valid .xaf file must be supplied or the load will fail and the function will return false [in] mapfilename The name of the possible animation map file(.xmm) used for mapping the clip. This value may be NULL.
- Returns:
- True if the file was loaded successfully, else returns false
| virtual void GetVelocityBlends | ( | INodeTab & | nodeTab | ) | [pure virtual] |
Get the nodes that make up the velocity blended nodes for a transition. Only works with max clips.
- Parameters:
-
[out] nodeTab The nodes whose positions and orientations are accumulated and blended via velocity for this clips transition
| virtual void SetVelocityBlends | ( | const INodeTab & | nodeTab | ) | [pure virtual] |
Set the nodes that make up the velocity blended nodes. Only works with max clips.
- Parameters:
-
[in] nodeTab The nodes whose positions and orientations are accumulated and bleneded via their velocities in this clip
| virtual void GetSubBlendNodes | ( | INodeTab & | nodeTab | ) | [pure virtual] |
Get the nodes that make up the the sub blended nodes. Only works with max clips.
- Parameters:
-
[out] nodeTab Nodes who will get their positions and orientations blended in the coordinate space of their corresponding subBlendNode parent thats found by calling GetSubBlendNodesParents.
| virtual void SetSubBlendNodes | ( | const INodeTab & | nodeTab | ) | [pure virtual] |
Set the nodes that make up the sub blended nodes. Only works with max clips.
- Parameters:
-
[in] nodeTab Nodes who will get their positions and orientations blended in the coordinate space of their corresponding subBlendNode parent. You should call this functions first before calling SetSubBlendNodesParents.
| virtual void GetSubBlendNodesParents | ( | INodeTab & | nodeTab | ) | [pure virtual] |
Get the nodes that make up the sub blended nodes parents. Only works with max clips.
- Parameters:
-
[out] nodeTab An array of 'parent' nodes whose coordinate space the sub blend nodes will blend in.
| virtual void SetSubBlendNodesParents | ( | const INodeTab & | nodeTab | ) | [pure virtual] |
Set the nodes that make up the sub blended parent nodes. Only works with max clips.
- Parameters:
-
[in] nodeTab The nodes whose coordinate space the sub blend nodes will blend in . Should be called after SetSubBlendNodeParents, and there's a 1-1 correspondance between the the two arrays.
| virtual void SetTransitionYawPitchRoll | ( | const bool | yaw, |
| const bool | pitch, | ||
| const bool | roll | ||
| ) | [pure virtual] |
Set whether or not velocity blended nodes yaw,pitch and roll angles will get accumulated or not.
Only works with max clips.
- Parameters:
-
[in] yaw If true the yaw orientation (angle about local z)will get velocity blended, otherwise it will get blended normally. [in] pitch If true the pitch orientation(angle about local x) will get velocity blended, otherwise it will get blended normally. [in] roll If true the roll orientation(angle about local y) will get velocity blended, otherwise it will get blended normally.
| virtual void GetTransitionYawPitchRoll | ( | bool & | yaw, |
| bool & | pitch, | ||
| bool & | roll | ||
| ) | [pure virtual] |
Get whether or not velocity blended nodes yaw,pitch and roll angles will get accumulated or not.
Only works with max clips.
- Parameters:
-
[out] yaw If true the yaw orientation (angle about local z)gets velocity blended, otherwise it will get blended normally. [out] pitch If true the pitch orientation(angle about local x) gets velocity blended, otherwise it will get blended normally. [out] roll If true the roll orientation(angle about local y) gets velocity blended, otherwise it will get blended normally.
| virtual void SetTransitionYawPitchRollAngle | ( | const float | yaw, |
| const float | pitch, | ||
| const float | roll | ||
| ) | [pure virtual] |
Set the transition yaw,pitch and roll angles.
- Parameters:
-
[in] yaw The additional yaw angle the clip will transition around [in] pitch The additional pitch angle the clip with transition around [in] roll The additional roll angel the clip will transition around
| virtual void GetTransitionYawPitchRollAngle | ( | float & | yaw, |
| float & | pitch, | ||
| float & | roll | ||
| ) | [pure virtual] |
Get the transition yaw,pitch and roll angles.
- Parameters:
-
[out] yaw The additional yaw angle of the current transition. [out] pitch The additional pitch angle of the curren transition. [out] roll The additional roll angel of the current transition
| virtual void SetTransitionXYZ | ( | const bool | x, |
| const bool | y, | ||
| const bool | z | ||
| ) | [pure virtual] |
Set whether or not velocity blended nodes x,y, and z positions will get accumulated or not.
Only works with max clips.
- Parameters:
-
[in] x If true the x position, will get velocity blended, otherwise it will get blended normally. [in] y If true the y position, will get velocity blended, otherwise it will get blended normally. [in] z If true the z position, will get velocity blended, otherwise it will get blended normally.
| virtual void GetTransitionXYZ | ( | bool & | x, |
| bool & | y, | ||
| bool & | z | ||
| ) | [pure virtual] |
Get whether or not velocity blended nodes x,y and z positions will get accumulated.
- Parameters:
-
[out] x If true the x position gets velocity blended, otherwise it will get blended normally. [out] y If true the y position gets velocity blended, otherwise it will get blended normally. [out] z If true the z position gets velocity blended, otherwise it will get blended normally.
