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

#include <plTransitionMsg.h>

Inheritance diagram for plTransitionMsg:
plMessageWithCallbacks plMessage plCreatable

Public Types

enum  { kFadeIn, kFadeOut, kFadeInNoSound, kFadeOutNoSound }

Public Member Functions

 plTransitionMsg ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
- Public Member Functions inherited from plMessageWithCallbacks
 plMessageWithCallbacks ()
virtual ~plMessageWithCallbacks ()
const std::vector< plMessage * > & getCallbacks () const
std::vector< plMessage * > & getCallbacks ()
void addCallback (plMessage *callback)
void delCallback (size_t idx)
void clearCallbacks ()
- Public Member Functions inherited from plMessage
 plMessage ()
plKey getSender () const
double getTimeStamp () const
unsigned int getBCastFlags () const
void setSender (plKey sender)
void setTimeStamp (double timestamp)
void setBCastFlags (unsigned int flags)
const std::vector< plKey > & getReceivers () const
std::vector< plKey > & getReceivers ()
void addReceiver (plKey receiver)
void delReceiver (size_t idx)
void clearReceivers ()
- 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

unsigned int fEffect
float fLengthInSecs
int fHoldUntilNext
- Protected Attributes inherited from plMessageWithCallbacks
std::vector< plMessage * > fCallbacks
- Protected Attributes inherited from plMessage
plKey fSender
std::vector< plKeyfReceivers
double fTimeStamp
unsigned int fBCastFlags

Member Enumeration Documentation

anonymous enum
Enumerator:
kFadeIn 
kFadeOut 
kFadeInNoSound 
kFadeOutNoSound 

Constructor & Destructor Documentation

plTransitionMsg::plTransitionMsg ( )

Member Function Documentation

virtual void plTransitionMsg::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 plMessageWithCallbacks.

virtual void plTransitionMsg::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 plMessageWithCallbacks.

virtual void plTransitionMsg::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 plMessageWithCallbacks.

virtual void plTransitionMsg::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 plMessageWithCallbacks.

Member Data Documentation

unsigned int plTransitionMsg::fEffect
protected
int plTransitionMsg::fHoldUntilNext
protected
float plTransitionMsg::fLengthInSecs
protected

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