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

#include <plCameraModifier.h>

Inheritance diagram for plCameraModifier:
plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Classes

class  CamTrans

Public Member Functions

 plCameraModifier ()
virtual ~plCameraModifier ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
void clearTrans ()
void clearMessageQueue ()
void clearFOVInstructions ()
- 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

void DeleteTrans ()
virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

hsVector3 fFrom
hsVector3 fAt
plKey fBrain
std::vector< CamTrans * > fTrans
float fFOVw
float fFOVh
std::vector< plMessage * > fMessageQueue
std::vector< plKeyfSenderQueue
std::vector< plCameraMsg * > fFOVInstructions
bool fAnimated
bool fStartAnimOnPush
bool fStopAnimOnPop
bool fResetAnimOnPop
- 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

plCameraModifier::plCameraModifier ( )
virtual plCameraModifier::~plCameraModifier ( )
virtual

Member Function Documentation

void plCameraModifier::clearFOVInstructions ( )
void plCameraModifier::clearMessageQueue ( )
void plCameraModifier::clearTrans ( )
void plCameraModifier::DeleteTrans ( )
protected
virtual void plCameraModifier::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 plCameraModifier::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 plCameraModifier::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.

virtual void plCameraModifier::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

bool plCameraModifier::fAnimated
protected
hsVector3 plCameraModifier::fAt
protected
plKey plCameraModifier::fBrain
protected
float plCameraModifier::fFOVh
protected
std::vector<plCameraMsg*> plCameraModifier::fFOVInstructions
protected
float plCameraModifier::fFOVw
protected
hsVector3 plCameraModifier::fFrom
protected
std::vector<plMessage*> plCameraModifier::fMessageQueue
protected
bool plCameraModifier::fResetAnimOnPop
protected
std::vector<plKey> plCameraModifier::fSenderQueue
protected
bool plCameraModifier::fStartAnimOnPush
protected
bool plCameraModifier::fStopAnimOnPop
protected
std::vector<CamTrans*> plCameraModifier::fTrans
protected

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