Functions | Variables

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 (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.
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

Function Documentation

PFExport ParticleChannelMask ( ) [inherited]

constructors/destructor/assigning

PFExport ParticleChannelMask ( const ParticleChannelMask ) [inherited]

constructors/destructor/assigning

PFExport ParticleChannelMask ( DWORD  readMask,
DWORD  writeMask 
) [inherited]

constructors/destructor/assigning

PFExport ParticleChannelMask & operator= ( const ParticleChannelMask ) [inherited]

constructors/destructor/assigning

PFExport ~ParticleChannelMask ( ) [inherited]

constructors/destructor/assigning

PFExport int operator== ( const ParticleChannelMask ) const [inherited]

Test for equality.

PFExport int operator!= ( const ParticleChannelMask ) const [inherited]

Test for equality.

PFExport void SetReadChannels ( DWORD  channelsFlag ) [inherited]

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 ) [inherited]

See PFExport void SetReadChannels()

PFExport bool SetChannels ( int  numChannels,
Interface_ID channels 
) [inherited]

See PFExport void SetReadChannels()

PFExport void AddReadChannels ( DWORD  channelsFlag ) [inherited]

See PFExport void SetReadChannels()

PFExport void RemoveReadChannels ( DWORD  channelsFlag ) [inherited]

See PFExport void SetReadChannels()

PFExport void AddWriteChannels ( DWORD  channelsFlag ) [inherited]

See PFExport void SetReadChannels()

PFExport void RemoveWriteChannels ( DWORD  channelsFlag ) [inherited]

See PFExport void SetReadChannels()

PFExport bool AddChannel ( Interface_ID channel ) [inherited]

See PFExport void SetReadChannels()

PFExport bool RemoveChannel ( Interface_ID channel ) [inherited]

See PFExport void SetReadChannels()

PFExport const int GetNumChannels ( ) const [inherited]

get channels methods

PFExport const Interface_ID GetChannel ( int  i ) const [inherited]
PFExport const bool HasChannel ( Interface_ID channel ) const [inherited]

has channels methods.

Returns true if the channel is present

PFExport const bool HasReadChannels ( DWORD  channelsFlag ) const [inherited]

returns true if all readChannels are present

PFExport const bool HasWriteChannels ( DWORD  channelsFlag ) const [inherited]

returns true if all writeChannels are present

PFExport static int NumStandardParticleChannels ( ) [static, inherited]

maximum number of available standard particle channels (constant)

PFExport static const ParticleChannelMask & Null ( ) [static, inherited]

Variable Documentation

DWORD m_readFlag [protected, inherited]
DWORD m_writeFlag [protected, inherited]
bool m_numSRChannelsValid [mutable, protected, inherited]
bool m_numSWChannelsValid [mutable, protected, inherited]
int m_numStandardReadChannels [mutable, protected, inherited]
int m_numStandardWriteChannels [mutable, protected, inherited]
int m_numCustomChannels [protected, inherited]
Interface_ID* m_customChannels [protected, inherited]
const DWORD kChannelsCast [static, protected, inherited]
const int kNumStandardParticleChannels [static, protected, inherited]
const ParticleChannelMask kNull [static, protected, inherited]