libHSPlasma
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plParticleEmitter Class Reference

#include <plParticleEmitter.h>

Inheritance diagram for plParticleEmitter:
plCreatable

Public Types

enum  {
  kMatIsEmissive = 0x1, kNormalUp = 0x10, kNormalVelUpVel = 0x20, kNormalFromCenter = 0x40,
  kNormalDynamicMask = kNormalFromCenter | kNormalVelUpVel, kNormalPrecalcMask = kNormalDynamicMask | kNormalUp, kNormalViewFacing = 0x100, kNormalNearestLight = 0x200,
  kNeedsUpdate = 0x1000000, kBorrowedGenerator = 0x2000000, kOverrideLocalToWorld = 0x4000000, kOnReserve = 0x8000000,
  kOrientationUp = 0x10000000, kOrientationVelocityBased = 0x20000000, kOrientationVelocityStretch = 0x40000000, kOrientationVelocityFlow = 0x80000000,
  kOrientationVelocityMask, kOrientationMask = kOrientationVelocityMask | kOrientationUp
}

Public Member Functions

 plParticleEmitter ()
virtual ~plParticleEmitter ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
void setGenerator (plParticleGenerator *generator)
- Public Member Functions inherited from plCreatable
 plCreatable ()
virtual ~plCreatable ()
virtual short ClassIndex () const =0
short ClassIndex (PlasmaVer ver) const
virtual const char * ClassName () const
virtual bool ClassInstance (short) const
virtual bool isStub () const
virtual void prcWrite (pfPrcHelper *prc)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

unsigned int fMiscFlags
unsigned int fSpanIndex
unsigned int fMaxParticles
plParticleGeneratorfGenerator
hsColorRGBA fColor

Member Enumeration Documentation

anonymous enum
Enumerator:
kMatIsEmissive 
kNormalUp 
kNormalVelUpVel 
kNormalFromCenter 
kNormalDynamicMask 
kNormalPrecalcMask 
kNormalViewFacing 
kNormalNearestLight 
kNeedsUpdate 
kBorrowedGenerator 
kOverrideLocalToWorld 
kOnReserve 
kOrientationUp 
kOrientationVelocityBased 
kOrientationVelocityStretch 
kOrientationVelocityFlow 
kOrientationVelocityMask 
kOrientationMask 

Constructor & Destructor Documentation

plParticleEmitter::plParticleEmitter ( )
virtual plParticleEmitter::~plParticleEmitter ( )
virtual

Member Function Documentation

virtual void plParticleEmitter::IPrcParse ( const pfPrcTag tag,
plResManager mgr 
)
protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plCreatable.

virtual void plParticleEmitter::IPrcWrite ( pfPrcHelper prc)
protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Implements plCreatable.

virtual void plParticleEmitter::read ( hsStream ,
plResManager  
)
virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plCreatable.

void plParticleEmitter::setGenerator ( plParticleGenerator generator)
virtual void plParticleEmitter::write ( hsStream ,
plResManager  
)
virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plCreatable.

Member Data Documentation

hsColorRGBA plParticleEmitter::fColor
protected
plParticleGenerator* plParticleEmitter::fGenerator
protected
unsigned int plParticleEmitter::fMaxParticles
protected
unsigned int plParticleEmitter::fMiscFlags
protected
unsigned int plParticleEmitter::fSpanIndex
protected

The documentation for this class was generated from the following file: