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

#include <plFogEnvironment.h>

Inheritance diagram for plFogEnvironment:
hsKeyedObject plCreatable

Public Types

enum  FogType { kLinearFog, kExpFog, kExp2Fog, kNoFog }

Public Member Functions

 plFogEnvironment ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
- Public Member Functions inherited from hsKeyedObject
void init (const plString &name)
plKey getKey () const
void setKey (plKey key)
- 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)

Static Public Attributes

static const char *const FogTypeNames []

Protected Member Functions

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

Protected Attributes

unsigned char fType
float fStart
float fEnd
float fDensity
hsColorRGBA fColor

Member Enumeration Documentation

Enumerator:
kLinearFog 
kExpFog 
kExp2Fog 
kNoFog 

Constructor & Destructor Documentation

plFogEnvironment::plFogEnvironment ( )

Member Function Documentation

virtual void plFogEnvironment::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 hsKeyedObject.

virtual void plFogEnvironment::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().

Reimplemented from hsKeyedObject.

virtual void plFogEnvironment::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 hsKeyedObject.

virtual void plFogEnvironment::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 hsKeyedObject.

Member Data Documentation

hsColorRGBA plFogEnvironment::fColor
protected
float plFogEnvironment::fDensity
protected
float plFogEnvironment::fEnd
protected
const char* const plFogEnvironment::FogTypeNames[]
static
float plFogEnvironment::fStart
protected
unsigned char plFogEnvironment::fType
protected

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