IParticleChannelMeshMap.h

Module description

Functions
virtual int	GetNumMaps () const =0
	Returns the number of mapping channels in use. More...
virtual bool	MapSupport (int mp) const =0
	Returns true if the specified mapping channel is supported; otherwise false. More...
virtual IParticleChannelMapR *	GetMapReadChannel (int mp)=0
	Returns an interface if the specified mapping channel is supported; otherwise NULL. More...
FPInterfaceDesc *	GetDesc ()
virtual void	SetNumMaps (int ct, bool keep=false)=0
	Sets the number of texture maps used. More...
virtual void	SetMapSupport (int mp, bool support=true)=0
	Sets whether the specified mapping channels is supported or not. More...
virtual IParticleChannelMapW *	GetMapChannel (int mp)=0
	Returns an interface if the specified mapping channel is supported; otherwise NULL. More...
virtual IObject *	GetMapChannelObject (int mp) const =0
	returns an object if the specified mapping channel is supported; otherwise NULL More...
FPInterfaceDesc *	GetDesc ()

Function Documentation

int GetNumMaps ( ) const

pure virtual

Returns the number of mapping channels in use.

bool MapSupport ( int  mp ) const

pure virtual

Returns true if the specified mapping channel is supported; otherwise false.

Parameters

mp	Specifies the channel. See List of Mapping Channel Index Values.

IParticleChannelMapR * GetMapReadChannel ( int  mp )

pure virtual

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

Parameters

mp	Specifies the channel. See List of Mapping Channel Index Values.

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELMESHMAPR_INTERFACE); }

void SetNumMaps ( int  ct, bool  keep = false  )

pure virtual

Sets the number of texture maps used.

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

Parameters

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

void SetMapSupport ( int  mp, bool  support = true  )

pure virtual

Sets whether the specified mapping channels is supported or not.

Parameters

mp	Specifies the channel. See List of Mapping Channel Index Values.
support	True to indicate the channel is supported; otherwise false.

IParticleChannelMapW * GetMapChannel ( int  mp )

pure virtual

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

Parameters

mp	Specifies the channel. See List of Mapping Channel Index Values.

IObject * GetMapChannelObject ( int  mp ) const

pure virtual

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

Parameters

mp	Specifies the channel. See List of Mapping Channel Index Values.

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELMESHMAPW_INTERFACE); }