ParticleChannelMask.h

Module description

Functions
PFExport	ParticleChannelMask ()
	constructors/destructor/assigning More...
PFExport	ParticleChannelMask (const ParticleChannelMask &)
	constructors/destructor/assigning More...
PFExport	ParticleChannelMask (DWORD readMask, DWORD writeMask)
	constructors/destructor/assigning More...
PFExport ParticleChannelMask &	operator= (const ParticleChannelMask &)
	constructors/destructor/assigning More...
PFExport	~ParticleChannelMask ()
	constructors/destructor/assigning More...
PFExport int	operator== (const ParticleChannelMask &) const
	Test for equality. More...
PFExport int	operator!= (const ParticleChannelMask &) const
	Test for equality. More...
PFExport void	SetReadChannels (DWORD channelsFlag)
	set standard read/write and custom channels methods. More...
PFExport void	SetWriteChannels (DWORD channelsFlag)
	See PFExport void SetReadChannels() More...
PFExport bool	SetChannels (int numChannels, Interface_ID *channels)
	See PFExport void SetReadChannels() More...
PFExport void	AddReadChannels (DWORD channelsFlag)
	See PFExport void SetReadChannels() More...
PFExport void	RemoveReadChannels (DWORD channelsFlag)
	See PFExport void SetReadChannels() More...
PFExport void	AddWriteChannels (DWORD channelsFlag)
	See PFExport void SetReadChannels() More...
PFExport void	RemoveWriteChannels (DWORD channelsFlag)
	See PFExport void SetReadChannels() More...
PFExport bool	AddChannel (Interface_ID &channel)
	See PFExport void SetReadChannels() More...
PFExport bool	RemoveChannel (Interface_ID &channel)
	See PFExport void SetReadChannels() More...
PFExport const int	GetNumChannels () const
	get channels methods More...
PFExport const Interface_ID	GetChannel (int i) const
PFExport const bool	HasChannel (Interface_ID &channel) const
	has channels methods. More...
PFExport const bool	HasReadChannels (DWORD channelsFlag) const
	returns true if all readChannels are present More...
PFExport const bool	HasWriteChannels (DWORD channelsFlag) const
	returns true if all writeChannels are present More...
static PFExport int	NumStandardParticleChannels ()
	maximum number of available standard particle channels (constant) More...
static PFExport const ParticleChannelMask &	Null ()
	empty mask More...

Variables
DWORD	m_readFlag
DWORD	m_writeFlag
bool	m_numSRChannelsValid
bool	m_numSWChannelsValid
int	m_numStandardReadChannels
int	m_numStandardWriteChannels
int	m_numCustomChannels
Interface_ID *	m_customChannels
static const DWORD	kChannelsCast
static const int	kNumStandardParticleChannels
static const ParticleChannelMask	kNull

Function Documentation

PFExport ParticleChannelMask

(

)

constructors/destructor/assigning

PFExport ParticleChannelMask

(

const ParticleChannelMask &

)

constructors/destructor/assigning

PFExport ParticleChannelMask	(	DWORD	readMask,
		DWORD	writeMask
	)

constructors/destructor/assigning

PFExport ParticleChannelMask & operator=

(

const ParticleChannelMask &

)

constructors/destructor/assigning

PFExport ~ParticleChannelMask

(

)

constructors/destructor/assigning

PFExport int operator==

(

const ParticleChannelMask &

)

const

Test for equality.

PFExport int operator!=

(

const ParticleChannelMask &

)

const

Test for equality.

PFExport void SetReadChannels

(

DWORD

channelsFlag

)

set standard read/write and custom channels methods.

If a custom particle channel is indeed a standard particle channel then it's stored as a flag

PFExport void SetWriteChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

PFExport bool SetChannels	(	int	numChannels,
		Interface_ID *	channels
	)

See PFExport void SetReadChannels()

PFExport void AddReadChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

PFExport void RemoveReadChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

PFExport void AddWriteChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

PFExport void RemoveWriteChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

PFExport bool AddChannel

(

Interface_ID &

channel

)

See PFExport void SetReadChannels()

PFExport bool RemoveChannel

(

Interface_ID &

channel

)

See PFExport void SetReadChannels()

PFExport const int GetNumChannels

(

)

const

get channels methods

PFExport const Interface_ID GetChannel

(

int

i

)

const

PFExport const bool HasChannel

(

Interface_ID &

channel

)

const

has channels methods.

Returns true if the channel is present

PFExport const bool HasReadChannels

(

DWORD

channelsFlag

)

const

returns true if all readChannels are present

PFExport const bool HasWriteChannels

(

DWORD

channelsFlag

)

const

returns true if all writeChannels are present

PFExport static int NumStandardParticleChannels ( )

static

maximum number of available standard particle channels (constant)

PFExport static const ParticleChannelMask & Null ( )

static

empty mask

Variable Documentation

DWORD m_readFlag

protected

DWORD m_writeFlag

protected

bool m_numSRChannelsValid

mutableprotected

bool m_numSWChannelsValid

mutableprotected

int m_numStandardReadChannels

mutableprotected

int m_numStandardWriteChannels

mutableprotected

int m_numCustomChannels

protected

Interface_ID* m_customChannels

protected

const DWORD kChannelsCast

staticprotected

const int kNumStandardParticleChannels

staticprotected

const ParticleChannelMask kNull

staticprotected