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

#include <plAxisAnimModifier.h>

Inheritance diagram for plAxisAnimModifier:
plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Member Functions

 plAxisAnimModifier ()
virtual ~plAxisAnimModifier ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plKey getXAnim () const
plKey getYAnim () const
plKey getNotificationKey () const
plNotifyMsggetNotify () const
plString getAnimLabel () const
bool getAllOrNothing () const
void setXAnim (plKey anim)
void setYAnim (plKey anim)
void setNotificationKey (plKey notify)
void setAnimLabel (const plString &label)
void setAllOrNothing (bool value)
void setNotify (plNotifyMsg *msg)
- Public Member Functions inherited from plSingleModifier
bool getFlag (size_t flag) const
void setFlag (size_t flag, bool value)
virtual size_t getTargetsCount () const
virtual plKey getTarget (size_t) const
virtual void addTarget (plKey target)
virtual void removeTarget (plKey)

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 plSingleModifier
hsBitVector fFlags
plKey fTarget

Constructor & Destructor Documentation

plAxisAnimModifier::plAxisAnimModifier ( )
virtual plAxisAnimModifier::~plAxisAnimModifier ( )
virtual

Member Function Documentation

bool plAxisAnimModifier::getAllOrNothing ( ) const
plString plAxisAnimModifier::getAnimLabel ( ) const
plKey plAxisAnimModifier::getNotificationKey ( ) const
plNotifyMsg* plAxisAnimModifier::getNotify ( ) const
plKey plAxisAnimModifier::getXAnim ( ) const
plKey plAxisAnimModifier::getYAnim ( ) const
virtual void plAxisAnimModifier::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 plSingleModifier.

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

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

void plAxisAnimModifier::setAllOrNothing ( bool  value)
void plAxisAnimModifier::setAnimLabel ( const plString label)
void plAxisAnimModifier::setNotificationKey ( plKey  notify)
void plAxisAnimModifier::setNotify ( plNotifyMsg msg)
void plAxisAnimModifier::setXAnim ( plKey  anim)
void plAxisAnimModifier::setYAnim ( plKey  anim)
virtual void plAxisAnimModifier::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 plSingleModifier.


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