MtlBaseList Class Reference

Search for all occurrences

---

Detailed 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;

#include <MtlBaseList.h>

Inheritance diagram for MtlBaseList:

List of all members.

Public Member Functions
CoreExport int	AddMtl (MtlBase *m, BOOL checkUnique=TRUE)
	Adds the specified MtlBase to the list.
CoreExport int	FindMtl (MtlBase *m)
	Finds the specified MtlBase in this material list and returns its index.
CoreExport int	FindMtlByName (MSTR &name)
	Finds the specified material by name and returns its index.
CoreExport void	RemoveEntry (int n)
	Removes the specified MtlBase from the list.
CoreExport void	Empty ()
	Removes all MtlBases from the list.

---

Member Function Documentation

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

Search for all occurrences

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

)

Search for all occurrences

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

)

Search for all occurrences

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

)

Search for all occurrences

Removes the specified MtlBase from the list.

Parameters:

[in]

n

- The index of the MtlBase to remove.

CoreExport void Empty

(

)

Search for all occurrences

Removes all MtlBases from the list.