NodeAndAnims Class Reference
 
 
 
NodeAndAnims Class Reference

#include <XMLAnimTreeEntry.h>

Inheritance diagram for NodeAndAnims:
FPMixinInterface FPInterface BaseInterface InterfaceServer MaxHeapOperators

Class Description

A class that holds a node and a list of anims under that node that can be used for loading,saving, mapping animation, or putting specific tracks into the mixer.

Provides a lower level of control than just specify a node by itself. This class gets filled out via the ILoadSaveAnimation::SetUpAnimsForSave, ILoadSaveAnimation::SetUpAnimsForLoad, and ILoadSaveAnimation::SetUpAnimsForMapping. It's the users responsibility to delete this item by calling DeleteThis, since it doesn't delete it's own data on deconstruction.

See also:
ILoadSaveAnimation::SetUpAnimsForSave
ILoadSaveAnimation::SetUpAnimsForLoad
ILoadSaveAnimation::SetUpAnimsForMap
IMixer8::AddMaxMixer
XMLAnimTreeEntryList

Public Types

enum   { getList, getNode }

Public Member Functions

  NodeAndAnims ()
DllExport  NodeAndAnims (const NodeAndAnims &)
  Copy constructor.
DllExport XMLAnimTreeEntryList GetList () const
  Get the XMLAnimTreeEntry list.
DllExport INode GetNode () const
  Get the node.
DllExport void  DeleteThis ()
  Deletes the data held by the NodeAnim, in particular the list object. Must be called once the list is done being used.
BEGIN_FUNCTION_MAP  FN_0 (getList, TYPE_INTERFACE, GetListFP)
  Function Map.
  FN_0 (getNode, TYPE_INODE, GetNode)
END_FUNCTION_MAP DllExport
FPInterfaceDesc
GetDesc ()
LifetimeType  LifetimeControl ()
BaseInterface AcquireInterface ()
DllExport void  ReleaseInterface ()
bool  operator== (const NodeAndAnims &b) const

Friends

class  XMLAnimLabelWindow
class  XMLAnimMapDlg
class  AnimFileLoader
class  AnimFileCreator
class  XMLAnim
class  NodeAndAnimsImp
class  ILoadSaveAnimation_Imp

Member Enumeration Documentation


Constructor & Destructor Documentation

NodeAndAnims ( ) [inline]
:node(NULL),IKNodeName(NULL),list(NULL){};
DllExport NodeAndAnims ( const NodeAndAnims )

Copy constructor.


Member Function Documentation

DllExport XMLAnimTreeEntryList* GetList ( ) const [inline]

Get the XMLAnimTreeEntry list.

Returns:
The XMLAnimTreeEntryList object
{return list;}
DllExport INode* GetNode ( ) const [inline]

Get the node.

Returns:
The node
{return node;}
DllExport void DeleteThis ( )

Deletes the data held by the NodeAnim, in particular the list object. Must be called once the list is done being used.

BEGIN_FUNCTION_MAP FN_0 ( getList  ,
TYPE_INTERFACE  ,
GetListFP   
)

Function Map.

!

FN_0 ( getNode  ,
TYPE_INODE  ,
GetNode   
)
END_FUNCTION_MAP DllExport FPInterfaceDesc* GetDesc ( ) [virtual]
LifetimeType LifetimeControl ( ) [inline, virtual]

!

Reimplemented from FPMixinInterface.

{ return wantsRelease; }
BaseInterface* AcquireInterface ( ) [inline, virtual]

!

Reimplemented from BaseInterface.

{ return this; }
DllExport void ReleaseInterface ( ) [virtual]
bool operator== ( const NodeAndAnims b ) const [inline]
Remarks:
Compares this class instance to another one
        {
                return node == b.node && IKNodeName == b.IKNodeName && list == b.list;
        }

Friends And Related Function Documentation

friend class XMLAnimLabelWindow [friend]
friend class XMLAnimMapDlg [friend]
friend class AnimFileLoader [friend]
friend class AnimFileCreator [friend]
friend class XMLAnim [friend]
friend class NodeAndAnimsImp [friend]
friend class ILoadSaveAnimation_Imp [friend]