Detailed Description

The list of XMLAnimTreeEntry tracks, that will then be loaded onto, or saved out, or put into the mixer.

The class is contains pointers to the XMLAnimTreeEntry objects and allocates and deletes these objects itself. This class is contained within the NodeAndAnims object.

See also:: XMLAnimTreeEntry; NodeAndAnims

#include <XMLAnimTreeEntry.h>

Inheritance diagram for XMLAnimTreeEntryList:

[legend]

List of all members.

Public Types
enum	{ getEntry, count, zeroCount, shrink, deleteItems, findAnim, findName }
Public Member Functions
DllExport	XMLAnimTreeEntryList ()
	Constructor.
DllExport	~XMLAnimTreeEntryList ()
	Deconstructor.
DllExport XMLAnimTreeEntry *	operator[] (const int index)
	Returns the i'th XMLAnimTreeEntry.
DllExport int	Count () const
	How many items in the list.
DllExport void	ZeroCount ()
	Zeroes out the list and deletes the XLMAnimTreeEntries in the list.
DllExport void	Shrink ()
	Shrinks the internal Tab that holds the items.
DllExport int	Delete (int start, int num)
	Delete the specified items out of the list. Also deletes the XMLAnimTreeEntry objects themselves.
DllExport void	DeleteData ()
	Deletes all of the XMLAnimTreeEntries in the list.
DllExport int	FindAnim (Animatable *anim, int start=0)
	Find the specified anim in the list.
DllExport int	Find (XMLAnimTreeEntry *which)
	Find this particular XMLAnimTreeEntry based off it's pointer value.
DllExport int	Find (MSTR &name, int unique)
DllExport void	FindParents (int index, Tab< int > &parentIndices)
DllExport void	FindChildren (int index, Tab< int > &childIndices)
	Fnd the subAnim children of the specified item.
BEGIN_FUNCTION_MAP	FN_1 (getEntry, TYPE_INTERFACE, GetEntry, TYPE_INT)
	FN_0 (count, TYPE_INT, Count)
	VFN_0 (zeroCount, ZeroCount)
	VFN_0 (shrink, Shrink)
	FN_2 (deleteItems, TYPE_INT, Delete, TYPE_INT, TYPE_INT)
	FN_2 (findAnim, TYPE_INT, FindAnimFP, TYPE_REFTARG, TYPE_INT)
	FN_2 (findName, TYPE_INT, FindNameFP, TYPE_STRING, TYPE_INT)
END_FUNCTION_MAP DllExport FPInterfaceDesc *	GetDesc ()
LifetimeType	LifetimeControl ()
BaseInterface *	AcquireInterface ()
DllExport void	ReleaseInterface ()
Friends
class	XMLAnimTreeEntry
class	XMLAnimLabelWindow
class	XMLAnimMapDlg
class	AnimFileLoader
class	AnimFileCreator
class	XMLAnim
class	XMLTreeListEnum
class	XMLAnimTreeEntryListImp

Member Enumeration Documentation

anonymous enum

Search for all occurrences

!

Enumerator:

getEntry	Search for all occurrences
count	Search for all occurrences
zeroCount	Search for all occurrences
shrink	Search for all occurrences
deleteItems	Search for all occurrences
findAnim	Search for all occurrences
findName	Search for all occurrences

{ getEntry,count,zeroCount,shrink,deleteItems,findAnim,findName};

Constructor & Destructor Documentation

DllExport XMLAnimTreeEntryList ( )

Constructor.

DllExport ~XMLAnimTreeEntryList ( )

Deconstructor.

Member Function Documentation

DllExport XMLAnimTreeEntry* operator[] ( const int index )

Returns the i'th XMLAnimTreeEntry.

Parameters:

[in] index The index of the item you want

Returns:: The item for tha index, NULL if the index is out of range

DllExport int Count ( ) const

Search for all occurrences

How many items in the list.

Returns:: The number of items in the list

Reimplemented from Tab< XMLAnimTreeEntry * >.

DllExport void ZeroCount ( )

Search for all occurrences

Zeroes out the list and deletes the XLMAnimTreeEntries in the list.

Reimplemented from Tab< XMLAnimTreeEntry * >.

DllExport void Shrink ( )

Search for all occurrences

Shrinks the internal Tab that holds the items.

Reimplemented from Tab< XMLAnimTreeEntry * >.

DllExport int Delete	(	int	start,
		int	num
	)

Search for all occurrences

Delete the specified items out of the list. Also deletes the XMLAnimTreeEntry objects themselves.

Parameters:

[in]	start	The first item to delete
[in]	num	The number of items to delete from the start.

Returns:: The number of items left in the list

Reimplemented from Tab< XMLAnimTreeEntry * >.

DllExport void DeleteData ( )

Search for all occurrences

Deletes all of the XMLAnimTreeEntries in the list.

DllExport int FindAnim	(	Animatable *	anim,
		int	start = `0`
	)

Search for all occurrences

Find the specified anim in the list.

Parameters:

[in]	anim	The anim you want to find.
[in]	start	Where you want to start looking from

Returns:: The index where the entry is, -1 if not found

DllExport int Find ( XMLAnimTreeEntry * which )

Search for all occurrences

Find this particular XMLAnimTreeEntry based off it's pointer value.

DllExport int Find	(	MSTR &	name,
		int	unique
	)

Search for all occurrences

DllExport void FindParents	(	int	index,
		Tab< int > &	parentIndices
	)

Search for all occurrences

Parameters:

[in]	index	The index of the items subAnim parents you want to find.
[out]	parentIndices	The indices of the items parents. It will be empty if it has no subAnim parents.

DllExport void FindChildren	(	int	index,
		Tab< int > &	childIndices
	)

Search for all occurrences

Fnd the subAnim children of the specified item.

Parameters:

[in]	index	The index whose children you want to find.
[out]	childIndices	The indices of the items children. It will be empty if it has no subAnim children.