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

#include <plAGAnim.h>

Inheritance diagram for plAgeGlobalAnim:
plAGAnim plSynchedObject hsKeyedObject plCreatable

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plString getVarName () const
void setVarName (const plString &name)
- Public Member Functions inherited from plAGAnim
 plAGAnim ()
virtual ~plAGAnim ()
const std::vector
< plAGApplicator * > & 
getApplicators () const
std::vector< plAGApplicator * > & getApplicators ()
void addApplicator (plAGApplicator *app)
void delApplicator (size_t idx)
void clearApplicators ()
float getBlend () const
float getStart () const
float getEnd () const
plString getName () const
void setBlend (float blend)
void setStart (float start)
void setEnd (float end)
void setName (const plString &name)
- 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

plString fGlobalVarName
- Protected Attributes inherited from plAGAnim
std::vector< plAGApplicator * > fApps
float fBlend
float fStart
float fEnd
plString fName
unsigned char fEoaFlag
- Protected Attributes inherited from plSynchedObject
unsigned int fSynchFlags
std::vector< plStringfSDLExcludeList
std::vector< plStringfSDLVolatileList

Additional Inherited Members

- Public Types inherited from plAGAnim
enum  BodyUsage {
  kBodyUnknown, kBodyUpper, kBodyFull, kBodyLower,
  kBodyMax
}

Member Function Documentation

plString plAgeGlobalAnim::getVarName ( ) const
virtual void plAgeGlobalAnim::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 plAGAnim.

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

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

void plAgeGlobalAnim::setVarName ( const plString name)
virtual void plAgeGlobalAnim::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 plAGAnim.

Member Data Documentation

plString plAgeGlobalAnim::fGlobalVarName
protected

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