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

#include <plSceneObject.h>

Inheritance diagram for plSceneObject:
plSynchedObject hsKeyedObject plCreatable

Public Member Functions

virtual ~plSceneObject ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plKey getDrawInterface () const
plKey getSimInterface () const
plKey getCoordInterface () const
plKey getAudioInterface () const
plKey getSceneNode () const
void setDrawInterface (plKey intf)
void setSimInterface (plKey intf)
void setCoordInterface (plKey intf)
void setAudioInterface (plKey intf)
void setSceneNode (plKey node)
const std::vector< plKey > & getInterfaces () const
std::vector< plKey > & getInterfaces ()
void addInterface (plKey intf)
void delInterface (size_t idx)
void clearInterfaces ()
const std::vector< plKey > & getModifiers () const
std::vector< plKey > & getModifiers ()
void addModifier (plKey intf)
void delModifier (size_t idx)
void clearModifiers ()
- 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)

Public Attributes

plKey fDrawIntf
plKey fSimIntf
plKey fCoordIntf
plKey fAudioIntf
std::vector< plKeyfInterfaces
std::vector< plKeyfModifiers
plKey fSceneNode

Protected Member Functions

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

Additional Inherited Members

- 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
}
- Protected Attributes inherited from plSynchedObject
unsigned int fSynchFlags
std::vector< plStringfSDLExcludeList
std::vector< plStringfSDLVolatileList

Constructor & Destructor Documentation

virtual plSceneObject::~plSceneObject ( )
virtual

Member Function Documentation

void plSceneObject::addInterface ( plKey  intf)
void plSceneObject::addModifier ( plKey  intf)
void plSceneObject::clearInterfaces ( )
void plSceneObject::clearModifiers ( )
void plSceneObject::delInterface ( size_t  idx)
void plSceneObject::delModifier ( size_t  idx)
plKey plSceneObject::getAudioInterface ( ) const
plKey plSceneObject::getCoordInterface ( ) const
plKey plSceneObject::getDrawInterface ( ) const
const std::vector<plKey>& plSceneObject::getInterfaces ( ) const
std::vector<plKey>& plSceneObject::getInterfaces ( )
const std::vector<plKey>& plSceneObject::getModifiers ( ) const
std::vector<plKey>& plSceneObject::getModifiers ( )
plKey plSceneObject::getSceneNode ( ) const
plKey plSceneObject::getSimInterface ( ) const
virtual void plSceneObject::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 plSynchedObject.

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

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

void plSceneObject::setAudioInterface ( plKey  intf)
void plSceneObject::setCoordInterface ( plKey  intf)
void plSceneObject::setDrawInterface ( plKey  intf)
void plSceneObject::setSceneNode ( plKey  node)
void plSceneObject::setSimInterface ( plKey  intf)
virtual void plSceneObject::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 plSynchedObject.

Member Data Documentation

plKey plSceneObject::fAudioIntf
plKey plSceneObject::fCoordIntf
plKey plSceneObject::fDrawIntf
std::vector<plKey> plSceneObject::fInterfaces
std::vector<plKey> plSceneObject::fModifiers
plKey plSceneObject::fSceneNode
plKey plSceneObject::fSimIntf

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