Detailed Description
XMLAnimTreeEntry class that's used for storing a controller track.
Class used to specify a controller/animation track that is then used by the load save and mixer systems. They will reside in the XMLAnimTreeEntryList.
- See also:
- XMLAnimTreeEntryList
#include <XMLAnimTreeEntry.h>
Public Types |
|
| enum |
Type { eNone = 0x0, eTransform = 0x1, eBaseObject = 0x2, eModObject = 0x4, eNoteTracks = 0x8, eVisTracks = 0x10, eMatMaps = 0x20, eMatParams = 0x40, eCustomAttributes = 0x80, eIK = 0x100, ePos = 0x200, eRot = 0x400, eScale = 0x800, ePosX = 0x1000, ePosY = 0x2000, ePosZ = 0x4000, eList = 0x8000, eKeyable = 0x10000, eRotX = 0x20000, eRotY = 0x40000, eRotZ = 0x80000, eScaleX = 0x100000, eScaleY = 0x200000, eScaleZ = 0x400000, eExposeWorldTransform = 0x800000, eLayer = 0x1000000 } |
|
Enum of type that a controllery can be, e.g position track, rotation y track, note track etc.. More... |
|
| enum | { getAnim, getClient, getSubNum, getName, getUnique, getMapName, getMapUnique, isType } |
Public Member Functions |
|
| DllExport Animatable * | GetAnim () const |
| The animatable track. |
|
| DllExport Animatable * | GetClient () const |
| The animatable track's parent. |
|
| DllExport int | GetSubNum () const |
| The sub anim number of the anim under the
client. |
|
| DllExport const MCHAR * | GetName () const |
| The name of the track. |
|
| DllExport int | GetUnique () const |
| Number used to specify how many other
controllers exist before this one in the
XMLAnimTreeEntryList with the same name. |
|
| DllExport const MCHAR * | GetMapName () const |
| The name of the track that this track is
mapped to. |
|
| DllExport int | GetMapUnique () const |
| Unique number for the track that it is
mapped to. |
|
| DllExport bool | IsType (int type) const |
| Returns true if the object is the passed in
type. |
|
| DllExport unsigned int | GetType () const |
| The possible type of the anim track as
defined in the enum Type definition. |
|
| BEGIN_FUNCTION_MAP | RO_PROP_FN (getAnim, GetAnimRef, TYPE_REFTARG) |
| RO_PROP_FN (getClient, GetClientRef, TYPE_REFTARG) | |
| RO_PROP_FN (getSubNum, GetSubNum, TYPE_INT) | |
| RO_PROP_FN (getName, GetName, TYPE_STRING) | |
| RO_PROP_FN (getUnique, GetUnique, TYPE_INT) | |
| RO_PROP_FN (getMapName, GetMapName, TYPE_STRING) | |
| RO_PROP_FN (getMapUnique, GetMapUnique, TYPE_INT) | |
| FN_1 (isType, TYPE_bool, IsType, TYPE_ENUM) | |
| END_FUNCTION_MAP
DllExport FPInterfaceDesc * |
GetDesc () |
| LifetimeType | LifetimeControl () |
| BaseInterface * | AcquireInterface () |
| DllExport void | ReleaseInterface () |
Friends |
|
| class | XMLAnimTreeEntryList |
| class | XMLAnimLabelWindow |
| class | XMLAnimMapDlg |
| class | AnimFileLoader |
| class | AnimFileCreator |
| class | XMLAnim |
| class | XMLTreeListEnum |
| class | XMLAnimTreeEntryImp |
Member Enumeration Documentation
| enum Type |
Enum of type that a controllery can be, e.g position track, rotation y track, note track etc..
Enum of type that they can be, The can be more than one type. eNone means it has no type, eTransform means that the track is a transform controller or a child of one, eBaseObject means that the track is under an object, eModObject means the track is under a modifier, eNoteTracks means the track is a NoteTrack, eVisTracks means the track is a visibility track, eMatMaps means the track is under a material map, eMatParams means the track is under a material parameter, eCustomAttributes means the track is under a custom attribute, eIK means the track is under an IK controller, ePos means that track is position controller or one of it's children, eRot means the track is a rotation controller or one of it's children, eScale means the track is a scaleController or one of it's children, ePosX means the track is a position x controller, ePosY means the track is a position y controller, ePosZ means the track is a position z controller, eList means the track is a list controller or one of it's children, eRotX means the track is a rotation x controller, eRotY means the track is a rotation y controller, eRotZ means the track is a rotation z controller, eKeyable means the track is keyable,eScaleX means the track is a scale controller, eScaleY means the track is a scale y controller, eScaleZ means the track is a scale z controller, eExposeWorldTransform means the track is the world TM of a node,eLayer means that the track is a layer controller or a child of one
- Enumerator:
{eNone = 0x0, eTransform = 0x1, eBaseObject = 0x2, eModObject = 0x4, eNoteTracks = 0x8,
eVisTracks = 0x10, eMatMaps = 0x20, eMatParams = 0x40, eCustomAttributes = 0x80,
eIK = 0x100, ePos = 0x200,eRot =0x400, eScale = 0x800, ePosX = 0x1000,
ePosY = 0x2000, ePosZ = 0x4000,eList = 0x8000,eKeyable = 0x10000,eRotX = 0x20000,eRotY = 0x40000,eRotZ = 0x80000,
eScaleX = 0x100000,eScaleY = 0x200000,eScaleZ = 0x400000,eExposeWorldTransform = 0x800000,eLayer = 0x1000000};
| anonymous enum |
!
Member Function Documentation
| DllExport Animatable* GetAnim | ( | ) | const [inline] |
| DllExport Animatable* GetClient | ( | ) | const [inline] |
The animatable track's parent.
- Returns:
- The animatable track's parent
{return client;}
| DllExport int GetSubNum | ( | ) | const [inline] |
The sub anim number of the anim under the client.
- Returns:
- The sub anim number of the anim under the client
{return subNum;}
| DllExport const MCHAR* GetName | ( | void | ) | const [inline] |
The name of the track.
This plus the unique identifier is used to uniquely identify a track.
- Returns:
- The name of the track. This plus the unique identifier is used to uniquely identify a track
{return name.data();}
| DllExport int GetUnique | ( | ) | const [inline] |
Number used to specify how many other controllers exist before this one in the XMLAnimTreeEntryList with the same name.
- Returns:
- The number used to specify how many other controllers exist before this one in the XMLAnimTreeEntryList with the same name
{return unique;}
| DllExport const MCHAR* GetMapName | ( | ) | const [inline] |
The name of the track that this track is mapped to.
- Returns:
- The name of the track that this track is mapped to
{return mapName.data();}
| DllExport int GetMapUnique | ( | ) | const [inline] |
Unique number for the track that it is mapped to.
- Returns:
- The unique number for the track that it is mapped to.
{return mapUnique;}
| DllExport bool IsType | ( | int | type | ) | const |
Returns true if the object is the passed in type.
- See also:
- XMLAnimTreeEntry::Type
- Parameters:
-
[in] type The type to check against
- Returns:
- True if that type, false otherwise
| DllExport unsigned int GetType | ( | ) | const [inline] |
The possible type of the anim track as defined in the enum Type definition.
Stored as an int instead of as an enum in order to speed up comparison operations.
- Returns:
- The type
{return type;}
| BEGIN_FUNCTION_MAP RO_PROP_FN | ( | getAnim | , |
| GetAnimRef | , | ||
| TYPE_REFTARG | |||
| ) |
| RO_PROP_FN | ( | getClient | , |
| GetClientRef | , | ||
| TYPE_REFTARG | |||
| ) |
| RO_PROP_FN | ( | getSubNum | , |
| GetSubNum | , | ||
| TYPE_INT | |||
| ) |
| RO_PROP_FN | ( | getName | , |
| GetName | , | ||
| TYPE_STRING | |||
| ) |
| RO_PROP_FN | ( | getUnique | , |
| GetUnique | , | ||
| TYPE_INT | |||
| ) |
| RO_PROP_FN | ( | getMapName | , |
| GetMapName | , | ||
| TYPE_STRING | |||
| ) |
| RO_PROP_FN | ( | getMapUnique | , |
| GetMapUnique | , | ||
| TYPE_INT | |||
| ) |
| FN_1 | ( | isType | , |
| TYPE_bool | , | ||
| IsType | , | ||
| TYPE_ENUM | |||
| ) |
| END_FUNCTION_MAP DllExport FPInterfaceDesc* GetDesc | ( | ) | [virtual] |
| LifetimeType LifetimeControl | ( | ) | [inline, virtual] |
| BaseInterface* AcquireInterface | ( | ) | [inline, virtual] |
| DllExport void ReleaseInterface | ( | ) | [virtual] |
Friends And Related Function Documentation
friend class XMLAnimTreeEntryList
[friend] |
friend class XMLAnimLabelWindow
[friend] |
friend class XMLAnimMapDlg
[friend] |
friend class AnimFileLoader
[friend] |
friend class AnimFileCreator
[friend] |
friend class XMLAnim [friend] |
friend class XMLTreeListEnum
[friend] |
friend class XMLAnimTreeEntryImp
[friend] |
