IParticleChannelMeshMap.h

Functions
virtual int	GetNumMaps () const =0
	returns the number of mapping channels in use.
virtual bool	MapSupport (int mp) const =0
	returns true if the specified mapping channel is supported; otherwise false
virtual IParticleChannelMapR *	GetMapReadChannel (int mp)=0
	returns an interface if the specified mapping channel is supported; otherwise NULL
FPInterfaceDesc *	GetDesc ()
BEGIN_FUNCTION_MAP	VFN_2 (kSetNumMaps, SetNumMaps, TYPE_INT, TYPE_bool)
	VFN_2 (kSetMapSupport, SetMapSupport, TYPE_INT, TYPE_bool)
	FN_1 (kGetMapChannel, TYPE_INTERFACE, GetMapChannel, TYPE_INT)
	FN_1 (kGetMapChannelObject, TYPE_IOBJECT, GetMapChannelObject, TYPE_INT)
virtual void	SetNumMaps (int ct, bool keep=false)=0
	sets the number of texture maps used.
virtual void	SetMapSupport (int mp, bool support=true)=0
	sets whether the specified mapping channels is supported or not.
virtual IParticleChannelMapW *	GetMapChannel (int mp)=0
	returns an interface if the specified mapping channel is supported; otherwise NULL
virtual IObject *	GetMapChannelObject (int mp) const =0
	returns an object if the specified mapping channel is supported; otherwise NULL
FPInterfaceDesc *	GetDesc ()

---

Function Documentation

int GetNumMaps

(

)

const [pure virtual, inherited]

Search for all occurrences

returns the number of mapping channels in use.

bool MapSupport

(

int

mp

)

const [pure virtual, inherited]

Search for all occurrences

returns true if the specified mapping channel is supported; otherwise false

Parameters:

int	mp: specifies the channel. See List of Mapping Channel Index Values.

IParticleChannelMapR * GetMapReadChannel

(

int

mp

)

[pure virtual, inherited]

Search for all occurrences

returns an interface if the specified mapping channel is supported; otherwise NULL

Parameters:

int	mp: specifies the channel. See List of Mapping Channel Index Values.

FPInterfaceDesc * GetDesc

(

)

[inline, virtual, inherited]

Search for all occurrences

Remarks:

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELMESHMAPR_INTERFACE); }

BEGIN_FUNCTION_MAP VFN_2	(	kSetNumMaps	,
		SetNumMaps	,
		TYPE_INT	,
		TYPE_bool
	)		[inherited]

Search for all occurrences

VFN_2	(	kSetMapSupport	,
		SetMapSupport	,
		TYPE_INT	,
		TYPE_bool
	)		[inherited]

Search for all occurrences

FN_1	(	kGetMapChannel	,
		TYPE_INTERFACE	,
		GetMapChannel	,
		TYPE_INT
	)		[inherited]

Search for all occurrences

FN_1	(	kGetMapChannelObject	,
		TYPE_IOBJECT	,
		GetMapChannelObject	,
		TYPE_INT
	)		[inherited]

Search for all occurrences

void SetNumMaps	(	int	ct,
		bool	keep = false
	)		[pure virtual, inherited]

Search for all occurrences

sets the number of texture maps used.

Note that this call is made automatically if SetMapSupport() is called.

Parameters:

int	ct: the number of texture maps to use. This is a value between 0 and MAX_MESHMAPS-1.
bool	keep: true to keep the old mapping information after the resize; false to discard it.

void SetMapSupport	(	int	mp,
		bool	support = true
	)		[pure virtual, inherited]

Search for all occurrences

sets whether the specified mapping channels is supported or not.

Parameters:

int	mp: specifies the channel. See List of Mapping Channel Index Values.
bool	support: true to indicate the channel is supported; otherwise false.

IParticleChannelMapW * GetMapChannel

(

int

mp

)

[pure virtual, inherited]

Search for all occurrences

returns an interface if the specified mapping channel is supported; otherwise NULL

Parameters:

int	mp: specifies the channel. See List of Mapping Channel Index Values.

IObject * GetMapChannelObject

(

int

mp

)

const [pure virtual, inherited]

Search for all occurrences

returns an object if the specified mapping channel is supported; otherwise NULL

Parameters:

int	mp: specifies the channel. See List of Mapping Channel Index Values.

FPInterfaceDesc * GetDesc

(

)

[inline, virtual, inherited]

Search for all occurrences

Remarks:

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELMESHMAPW_INTERFACE); }