MtlBaseList Class Reference

#include <MtlBaseList.h>

Class Description

Simple list of MtlBase.

A simple list of MtlBases. All methods of this class are implemented by the system.

See also

Template Class Tab, Class MtlBase, Class Interface.

Note the following typedefs:

typedef MtlBase* MtlBaseHandle;

typedef Mtl* MtlHandle;

typedef Texmap* TexmapHandle;

Inheritance diagram for MtlBaseList:

Public Member Functions
CoreExport int	AddMtl (MtlBase *m, BOOL checkUnique=TRUE)
	Adds the specified MtlBase to the list. More...
CoreExport int	FindMtl (MtlBase *m)
	Finds the specified MtlBase in this material list and returns its index. More...
CoreExport int	FindMtlByName (MSTR &name)
	Finds the specified material by name and returns its index. More...
CoreExport void	RemoveEntry (int n)
	Removes the specified MtlBase from the list. More...
CoreExport void	Empty ()
	Removes all MtlBases from the list. More...
Public Member Functions inherited from Tab< MtlBaseHandle >
	Tab ()
	Default constructor. More...
	Tab (const Tab &tb)
	Copy constructor. More...
	~Tab ()
	Destructor. More...
void	Init ()
	Initializes a Tab instance. More...
int	Count () const
	Retrieves the number of items in the Tab. More...
void	ZeroCount ()
	Resets the number of used items to zero. More...
void	SetCount (int n, BOOL resize=TRUE)
	Sets the number of used items. More...
MtlBaseHandle *	Addr (const INT_PTR i) const
	Returns the address of the i-th item. More...
int	Insert (int at, int num, MtlBaseHandle *el)
	Inserts items in the Tab at a specified position. More...
int	Append (int num, MtlBaseHandle *el, int allocExtra=0)
	Appends items at the end of the Tab. More...
int	Delete (int start, int num)
	Deletes items from the Tab. More...
int	Resize (int num)
	Changes the number of items allocated in memory. More...
void	Shrink ()
	Frees unused Tab items to reduce memory footprint. More...
void	Sort (CompareFnc cmp)
	Sorts the array using the compare function. More...
Tab &	operator= (const Tab &tb)
	Assignment operator. More...
MtlBaseHandle &	operator[] (const INT_PTR i) const
	Accesses the i-th Tab item. More...

Additional Inherited Members
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Member Function Documentation

CoreExport int AddMtl	(	MtlBase *	m,
		BOOL	checkUnique = TRUE
	)

Adds the specified MtlBase to the list.

Parameters

[in]	m	- The MtlBase to add.
[in]	checkUnique	- If TRUE this method checks to make sure the MtlBase is unique, and will only add it if so.

Returns

Nonzero if the MtlBase was added; otherwise zero.

CoreExport int FindMtl

(

MtlBase *

m

)

Finds the specified MtlBase in this material list and returns its index.

Returns -1 if not found.

Parameters

[in]

m

- The MtlBase to find.

CoreExport int FindMtlByName

(

MSTR &

name

)

Finds the specified material by name and returns its index.

Returns -1 if not found.

Parameters

[in]

name

- The name to find.

CoreExport void RemoveEntry

(

int

n

)

Removes the specified MtlBase from the list.

Parameters

[in]

n

- The index of the MtlBase to remove.

CoreExport void Empty

(

)

Removes all MtlBases from the list.