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

#include <plCoordinateInterface.h>

Inheritance diagram for plCoordinateInterface:
plObjInterface plSynchedObject hsKeyedObject plCreatable plFilterCoordInterface

Public Types

enum  plCoordinateProperties { kDisable, kCanEverDelayTransform, kDelayedTransformEval, 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

 plCoordinateInterface ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const hsMatrix44getLocalToParent () const
const hsMatrix44getParentToLocal () const
const hsMatrix44getLocalToWorld () const
const hsMatrix44getWorldToLocal () const
void setLocalToParent (const hsMatrix44 &xform)
void setParentToLocal (const hsMatrix44 &xform)
void setLocalToWorld (const hsMatrix44 &xform)
void setWorldToLocal (const hsMatrix44 &xform)
const std::vector< plKey > & getChildren () const
std::vector< plKey > & getChildren ()
void addChild (plKey child)
void delChild (size_t idx)
void clearChildren ()
void setParent (plKey parent)
plKey getParent () const
- 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)

Additional Inherited Members

- Protected Attributes inherited from plObjInterface
plKey fOwner
hsBitVector fProps

Member Enumeration Documentation

Enumerator:
kDisable 
kCanEverDelayTransform 
kDelayedTransformEval 
kNumProps 

Constructor & Destructor Documentation

plCoordinateInterface::plCoordinateInterface ( )

Member Function Documentation

void plCoordinateInterface::addChild ( plKey  child)
void plCoordinateInterface::clearChildren ( )
void plCoordinateInterface::delChild ( size_t  idx)
const std::vector<plKey>& plCoordinateInterface::getChildren ( ) const
std::vector<plKey>& plCoordinateInterface::getChildren ( )
const hsMatrix44& plCoordinateInterface::getLocalToParent ( ) const
const hsMatrix44& plCoordinateInterface::getLocalToWorld ( ) const
plKey plCoordinateInterface::getParent ( ) const

Get parent coordinate interface

const hsMatrix44& plCoordinateInterface::getParentToLocal ( ) const
const hsMatrix44& plCoordinateInterface::getWorldToLocal ( ) const
virtual void plCoordinateInterface::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 plFilterCoordInterface.

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

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

void plCoordinateInterface::setLocalToParent ( const hsMatrix44 xform)
void plCoordinateInterface::setLocalToWorld ( const hsMatrix44 xform)
void plCoordinateInterface::setParent ( plKey  parent)

Set parent coordinate interface

void plCoordinateInterface::setParentToLocal ( const hsMatrix44 xform)
void plCoordinateInterface::setWorldToLocal ( const hsMatrix44 xform)
virtual void plCoordinateInterface::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 plFilterCoordInterface.


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