ParticleChannelMask.h

Functions
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.
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 (const Interface_ID &channel)
	See PFExport void SetReadChannels()
PFExport bool	RemoveChannel (const 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 (const Interface_ID &channel) const
	has channels methods.
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
static PFExport int	NumStandardParticleChannels ()
	maximum number of available standard particle channels (constant)
static PFExport const ParticleChannelMask &	Null ()
	empty mask

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

Detailed Description

Function Documentation

ParticleChannelMask() [1/3]

PFExport ParticleChannelMask

(

)

constructors/destructor/assigning

ParticleChannelMask() [2/3]

PFExport ParticleChannelMask

(

const ParticleChannelMask &

)

constructors/destructor/assigning

ParticleChannelMask() [3/3]

PFExport ParticleChannelMask	(	DWORD	readMask,
		DWORD	writeMask )

constructors/destructor/assigning

operator=()

PFExport ParticleChannelMask & operator=

(

const ParticleChannelMask &

)

constructors/destructor/assigning

~ParticleChannelMask()

PFExport ~ParticleChannelMask

(

)

constructors/destructor/assigning

operator==()

PFExport int operator==

(

const ParticleChannelMask &

)

const

Test for equality.

operator!=()

PFExport int operator!=

(

const ParticleChannelMask &

)

const

Test for equality.

SetReadChannels()

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

SetWriteChannels()

PFExport void SetWriteChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

SetChannels()

PFExport bool SetChannels	(	int	numChannels,
		Interface_ID *	channels )

See PFExport void SetReadChannels()

AddReadChannels()

PFExport void AddReadChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

RemoveReadChannels()

PFExport void RemoveReadChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

AddWriteChannels()

PFExport void AddWriteChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

RemoveWriteChannels()

PFExport void RemoveWriteChannels

(

DWORD

channelsFlag

)

See PFExport void SetReadChannels()

AddChannel()

PFExport bool AddChannel

(

const Interface_ID &

channel

)

See PFExport void SetReadChannels()

RemoveChannel()

PFExport bool RemoveChannel

(

const Interface_ID &

channel

)

See PFExport void SetReadChannels()

GetNumChannels()

PFExport const int GetNumChannels

(

)

const

get channels methods

GetChannel()

PFExport const Interface_ID GetChannel

(

int

i

)

const

HasChannel()

PFExport const bool HasChannel

(

const Interface_ID &

channel

)

const

has channels methods.

Returns true if the channel is present

HasReadChannels()

PFExport const bool HasReadChannels

(

DWORD

channelsFlag

)

const

returns true if all readChannels are present

HasWriteChannels()

PFExport const bool HasWriteChannels

(

DWORD

channelsFlag

)

const

returns true if all writeChannels are present

NumStandardParticleChannels()

PFExport int NumStandardParticleChannels ( )

static

maximum number of available standard particle channels (constant)

Null()

PFExport const ParticleChannelMask & Null ( )

static

empty mask

Variable Documentation

m_readFlag

DWORD m_readFlag

protected

m_writeFlag

DWORD m_writeFlag

protected

m_numSRChannelsValid

bool m_numSRChannelsValid

mutableprotected

m_numSWChannelsValid

bool m_numSWChannelsValid

protected

m_numStandardReadChannels

int m_numStandardReadChannels

mutableprotected

m_numStandardWriteChannels

int m_numStandardWriteChannels

protected

m_numCustomChannels

int m_numCustomChannels

protected

m_customChannels

Interface_ID* m_customChannels

protected

kChannelsCast

const DWORD kChannelsCast

staticprotected

kNumStandardParticleChannels

const int kNumStandardParticleChannels

staticprotected

kNull

const ParticleChannelMask kNull

staticprotected