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

#include <plDrawInterface.h>

Inheritance diagram for plDrawInterface:
plObjInterface plSynchedObject hsKeyedObject plCreatable plInstanceDrawInterface

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
size_t getNumDrawables () const
plKey getDrawable (size_t idx) const
int getDrawableKey (size_t idx) const
void clearDrawables ()
void addDrawable (plKey draw, int key)
void delDrawable (size_t idx)
const std::vector< plKey > & getRegions () const
std::vector< plKey > & getRegions ()
void addRegion (plKey obj)
void delRegion (size_t idx)
void clearRegions ()
- 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< plKeyfDrawables
std::vector< plKeyfRegions
std::vector< int > fDrawableKeys
- 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 }

Member Function Documentation

void plDrawInterface::addDrawable ( plKey  draw,
int  key 
)
void plDrawInterface::addRegion ( plKey  obj)
void plDrawInterface::clearDrawables ( )
void plDrawInterface::clearRegions ( )
void plDrawInterface::delDrawable ( size_t  idx)
void plDrawInterface::delRegion ( size_t  idx)
plKey plDrawInterface::getDrawable ( size_t  idx) const
int plDrawInterface::getDrawableKey ( size_t  idx) const
size_t plDrawInterface::getNumDrawables ( ) const
const std::vector<plKey>& plDrawInterface::getRegions ( ) const
std::vector<plKey>& plDrawInterface::getRegions ( )
virtual void plDrawInterface::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 plInstanceDrawInterface.

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

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

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

Member Data Documentation

std::vector<int> plDrawInterface::fDrawableKeys
protected
std::vector<plKey> plDrawInterface::fDrawables
protected
std::vector<plKey> plDrawInterface::fRegions
protected

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