IAnimTrack Class Reference

Interface of a parameter track object, a member of a track set. More...

#include <iTrackSet.h>

Inheritance diagram for IAnimTrack:

Public Types
enum	{   get_node , sub_anim_count , get_sub_anim , get_sub_anim_index ,   get_path_name , set }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
virtual INode *	GetNode () const =0
	Returns the node to which the parameter track belongs.
virtual int	SubAnimCount () const =0
	Returns the number of subanims for this track, from the node to the leaf controller.
virtual Animatable *	GetSubAnim (int index) const =0
	Returns the desired subanim.
virtual int	GetSubAnimIndex (int index) const =0
	Returns the desired subanim index.
virtual const MSTR &	GetPathName () const =0
	Returns a string describing the track, e.g.
virtual void	Set (const MCHAR *pathname)=0
	Sets the animation track from a string.
virtual Control *	GetLeafController () const =0
	Retrieves the leaf controller of a track.
FPInterfaceDesc *	GetDesc ()
virtual BaseInterface *	GetInterface (Interface_ID id)
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Static Public Member Functions
static IAnimTrack *	GetInterface (InterfaceServer &is)
	Retrieves the IAnimTrack interface from an object.
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Additional Inherited Members
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Detailed Description

Interface of a parameter track object, a member of a track set.

The IAnimTrack interface provides access to a member of a track set and
represents one track in the track view, for instance, the X position of a
node. A track is defined by a node and then a path of subanims, from the
node down to a leaf controller. For instance the track for the X position
of a node would keep the subAnims of the PRS control, then of the indePos and of the X position. At the moment only tracks that are under a node can belong to a track set.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
get_node
sub_anim_count
get_sub_anim
get_sub_anim_index
get_path_name
set

         {
        get_node,
        sub_anim_count,
        get_sub_anim,
        get_sub_anim_index,
        get_path_name,
        set
    };

Member Function Documentation

GetNode()

virtual INode * GetNode ( ) const

pure virtual

Returns the node to which the parameter track belongs.

Returns

- the node to which the parameter belongs

SubAnimCount()

virtual int SubAnimCount ( ) const

pure virtual

Returns the number of subanims for this track, from the node to the leaf controller.

Returns

- the number of subanims in this track

GetSubAnim()

virtual Animatable * GetSubAnim ( int  index ) const

pure virtual

Returns the desired subanim.

For instance GetSubAnim(0) on the track "Cone01\Transform\Position\X Position" would return the PRS controller under Cone01

Parameters

[in]

index

- zero-based index of the subanim

GetSubAnimIndex()

virtual int GetSubAnimIndex ( int  index ) const

pure virtual

Returns the desired subanim index.

For instance GetSubAnim(0) on the track "Cone01\Transform\Position\X Position" would return the subanim index of the PRS controller under Cone01

Parameters

[in]

index

- zero-based index of the subanim

GetPathName()

virtual const MSTR & GetPathName ( ) const

pure virtual

Returns a string describing the track, e.g.

"Cone01\Transform\Position\X Position"

Returns

- a string describing the track

Set()

virtual void Set ( const MCHAR *  pathname )

pure virtual

Sets the animation track from a string.

The string will be parsed as a node followed with a backslash-separated list of subanims

Parameters

[in]

pathname

- string describing the track

See also

IAnimTrack::GetSubAnim()

GetLeafController()

virtual Control * GetLeafController ( ) const

pure virtual

Retrieves the leaf controller of a track.

Returns

- Pointer to the controller or NULL

GetInterface() [1/2]

static IAnimTrack * GetInterface ( InterfaceServer &  is )

inlinestatic

Retrieves the IAnimTrack interface from an object.

Parameters

[in]

is

- Pointer to an object

Returns

- Pointer to the IAnimTrack interface of the object or NULL if the object does not support the animation track interface

                                                         {
        return static_cast<IAnimTrack*>(is.GetInterface(IID_ANIM_TRACK));
    };

GetDesc()

FPInterfaceDesc * GetDesc ( )

virtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

GetInterface() [2/2]

virtual BaseInterface * GetInterface ( Interface_ID  id )

inlinevirtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

{ if (id == FPMIXININTERFACE_ID) return this; else return FPInterface::GetInterface(id); }