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

#include <plCrossfade.h>

Inheritance diagram for plCrossfade:
plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Member Functions

 plCrossfade ()
virtual ~plCrossfade ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
unsigned short getFirstIdx () const
unsigned short getSecondIdx () const
unsigned int getStartType () const
unsigned int getEndType () const
unsigned int getFlags () const
bool isRegistered () const
void setFirstIdx (unsigned short idx)
void setSecondIdx (unsigned short idx)
void setStartType (unsigned int type)
void setEndType (unsigned int type)
void setFlags (unsigned int flags)
void setRegistered (bool registered)
- 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)

Protected Attributes

unsigned short fFirstIdx
unsigned short fSecondIdx
unsigned int fStartType
unsigned int fEndType
unsigned int fFlags
bool fRegistered
- Protected Attributes inherited from plSingleModifier
hsBitVector fFlags
plKey fTarget

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
}

Constructor & Destructor Documentation

plCrossfade::plCrossfade ( )
virtual plCrossfade::~plCrossfade ( )
virtual

Member Function Documentation

unsigned int plCrossfade::getEndType ( ) const
unsigned short plCrossfade::getFirstIdx ( ) const
unsigned int plCrossfade::getFlags ( ) const

Reimplemented from plSynchedObject.

unsigned short plCrossfade::getSecondIdx ( ) const
unsigned int plCrossfade::getStartType ( ) const
virtual void plCrossfade::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 plCrossfade::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.

bool plCrossfade::isRegistered ( ) const
virtual void plCrossfade::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 plCrossfade::setEndType ( unsigned int  type)
void plCrossfade::setFirstIdx ( unsigned short  idx)
void plCrossfade::setFlags ( unsigned int  flags)
void plCrossfade::setRegistered ( bool  registered)
void plCrossfade::setSecondIdx ( unsigned short  idx)
void plCrossfade::setStartType ( unsigned int  type)
virtual void plCrossfade::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.

Member Data Documentation

unsigned int plCrossfade::fEndType
protected
unsigned short plCrossfade::fFirstIdx
protected
unsigned int plCrossfade::fFlags
protected
bool plCrossfade::fRegistered
protected
unsigned short plCrossfade::fSecondIdx
protected
unsigned int plCrossfade::fStartType
protected

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