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

#include <plShadowMaster.h>

Inheritance diagram for plShadowMaster:
plObjInterface plSynchedObject hsKeyedObject plCreatable plDirectShadowMaster plPointShadowMaster

Public Types

enum  DrawProperties { kDisable, kSelfShadow, kNumProps }
- Public Types inherited from plObjInterface
enum  { kDisable }
- Public Types inherited from plSynchedObject
enum  Flags {
  kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8,
  kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40,
  kAllStateIsVolatile = 0x80
}
enum  SDLSendFlags {
  kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8,
  kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80
}

Public Member Functions

 plShadowMaster ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
float getAttenDist () const
float getMaxDist () const
float getMinDist () const
float getPower () const
unsigned int getMaxSize () const
unsigned int getMinSize () const
void setAttenDist (float dist)
void setDist (float min, float max)
void setPower (float power)
void setSize (unsigned int min, unsigned int max)
- Public Member Functions inherited from plObjInterface
 plObjInterface ()
bool getProperty (size_t prop) const
void setProperty (size_t prop, bool value)
plKey getOwner () const
void setOwner (plKey owner)
- Public Member Functions inherited from plSynchedObject
 plSynchedObject ()
int getFlags () const
void setFlags (int flags)
const std::vector< plString > & getExcludes () const
const std::vector< plString > & getVolatiles () const
void setExclude (const plString &sdl)
void setVolatile (const plString &sdl)
void clearExcludes ()
void clearVolatiles ()
- 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)

Protected Member Functions

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

Protected Attributes

float fAttenDist
float fMaxDist
float fMinDist
float fPower
unsigned int fMaxSize
unsigned int fMinSize
- Protected Attributes inherited from plObjInterface
plKey fOwner
hsBitVector fProps
- Protected Attributes inherited from plSynchedObject
unsigned int fSynchFlags
std::vector< plStringfSDLExcludeList
std::vector< plStringfSDLVolatileList

Member Enumeration Documentation

Enumerator:
kDisable 
kSelfShadow 
kNumProps 

Constructor & Destructor Documentation

plShadowMaster::plShadowMaster ( )

Member Function Documentation

float plShadowMaster::getAttenDist ( ) const
float plShadowMaster::getMaxDist ( ) const
unsigned int plShadowMaster::getMaxSize ( ) const
float plShadowMaster::getMinDist ( ) const
unsigned int plShadowMaster::getMinSize ( ) const
float plShadowMaster::getPower ( ) const
virtual void plShadowMaster::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 plObjInterface.

virtual void plShadowMaster::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 plObjInterface.

virtual void plShadowMaster::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 plObjInterface.

void plShadowMaster::setAttenDist ( float  dist)
void plShadowMaster::setDist ( float  min,
float  max 
)
void plShadowMaster::setPower ( float  power)
void plShadowMaster::setSize ( unsigned int  min,
unsigned int  max 
)
virtual void plShadowMaster::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 plObjInterface.

Member Data Documentation

float plShadowMaster::fAttenDist
protected
float plShadowMaster::fMaxDist
protected
unsigned int plShadowMaster::fMaxSize
protected
float plShadowMaster::fMinDist
protected
unsigned int plShadowMaster::fMinSize
protected
float plShadowMaster::fPower
protected

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