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

#include <plOccluder.h>

Inheritance diagram for plOccluder:
plObjInterface plSynchedObject hsKeyedObject plCreatable plMobileOccluder

Public Member Functions

 plOccluder ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
float getPriority () const
hsBounds3Ext getWorldBounds () const
plKey getSceneNode () const
void setPriority (float priority)
void setWorldBounds (const hsBounds3Ext &bounds)
void setSceneNode (plKey node)
const std::vector< plCullPoly > & getPolys () const
std::vector< plCullPoly > & getPolys ()
void addPoly (const plCullPoly &poly)
void delPoly (size_t idx)
void clearPolys ()
const std::vector< plKey > & getVisRegions () const
std::vector< plKey > & getVisRegions ()
void addVisRegion (plKey region)
void delVisRegion (size_t idx)
void clearVisRegions ()
- 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

std::vector< plCullPolyfPolys
std::vector< plKeyfVisRegions
float fPriority
hsBounds3Ext fWorldBounds
plKey fSceneNode
- Protected Attributes inherited from plObjInterface
plKey fOwner
hsBitVector fProps
- Protected Attributes inherited from plSynchedObject
unsigned int fSynchFlags
std::vector< plStringfSDLExcludeList
std::vector< plStringfSDLVolatileList

Additional Inherited Members

- Public Types inherited from plObjInterface
enum  { kDisable }

Constructor & Destructor Documentation

plOccluder::plOccluder ( )

Member Function Documentation

void plOccluder::addPoly ( const plCullPoly poly)
void plOccluder::addVisRegion ( plKey  region)
void plOccluder::clearPolys ( )
void plOccluder::clearVisRegions ( )
void plOccluder::delPoly ( size_t  idx)
void plOccluder::delVisRegion ( size_t  idx)
const std::vector<plCullPoly>& plOccluder::getPolys ( ) const
std::vector<plCullPoly>& plOccluder::getPolys ( )
float plOccluder::getPriority ( ) const
plKey plOccluder::getSceneNode ( ) const
const std::vector<plKey>& plOccluder::getVisRegions ( ) const
std::vector<plKey>& plOccluder::getVisRegions ( )
hsBounds3Ext plOccluder::getWorldBounds ( ) const
virtual void plOccluder::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.

Reimplemented in plMobileOccluder.

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

Reimplemented in plMobileOccluder.

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

Reimplemented in plMobileOccluder.

void plOccluder::setPriority ( float  priority)
void plOccluder::setSceneNode ( plKey  node)
void plOccluder::setWorldBounds ( const hsBounds3Ext bounds)
virtual void plOccluder::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.

Reimplemented in plMobileOccluder.

Member Data Documentation

std::vector<plCullPoly> plOccluder::fPolys
protected
float plOccluder::fPriority
protected
plKey plOccluder::fSceneNode
protected
std::vector<plKey> plOccluder::fVisRegions
protected
hsBounds3Ext plOccluder::fWorldBounds
protected

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