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

#include <plCameraBrain.h>

Inheritance diagram for plCameraBrain1:
plCameraBrain hsKeyedObject plCreatable plCameraBrain1_Avatar plCameraBrain1_Drive plCameraBrain1_Fixed plCameraBrain1_FirstPerson plCameraBrain1_Circle

Public Types

enum  {
  kCutPos, kCutPosOnce, kCutPOA, kCutPOAOnce,
  kAnimateFOV, kFollowLocalAvatar, kPanicVelocity, kRailComponent,
  kSubject, kCircleTarget, kMaintainLOS, kZoomEnabled,
  kIsTransitionCamera, kWorldspacePOA, kWorldspacePos, kCutPosWhilePan,
  kCutPOAWhilePan, kNonPhys, kNeverAnimateFOV, kIgnoreSubworldMovement,
  kFalling, kRunning, kVerticalWhenFalling, kSpeedUpWhenRunning,
  kFallingStopped, kBeginFalling
}

Public Member Functions

 plCameraBrain1 ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)

Protected Member Functions

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

Protected Attributes

plKey fSubject
plKey fRail
float fVelocity
float fAccel
float fDecel
float fPOAVelocity
float fPOAAccel
float fPOADecel
hsVector3 fPOAOffset
float fXPanLimit
float fZPanLimit
float fPanSpeed
float fZoomRate
float fZoomMax
float fZoomMin
hsBitVector fFlags
hsBitVector fEoaFlags

Member Enumeration Documentation

anonymous enum
Enumerator:
kCutPos 
kCutPosOnce 
kCutPOA 
kCutPOAOnce 
kAnimateFOV 
kFollowLocalAvatar 
kPanicVelocity 
kRailComponent 
kSubject 
kCircleTarget 
kMaintainLOS 
kZoomEnabled 
kIsTransitionCamera 
kWorldspacePOA 
kWorldspacePos 
kCutPosWhilePan 
kCutPOAWhilePan 
kNonPhys 
kNeverAnimateFOV 
kIgnoreSubworldMovement 
kFalling 
kRunning 
kVerticalWhenFalling 
kSpeedUpWhenRunning 
kFallingStopped 
kBeginFalling 

Constructor & Destructor Documentation

plCameraBrain1::plCameraBrain1 ( )

Member Function Documentation

virtual void plCameraBrain1::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 hsKeyedObject.

Reimplemented in plCameraBrain1_Circle, plCameraBrain1_Fixed, and plCameraBrain1_Avatar.

virtual void plCameraBrain1::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 hsKeyedObject.

Reimplemented in plCameraBrain1_Circle, plCameraBrain1_Fixed, and plCameraBrain1_Avatar.

virtual void plCameraBrain1::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 hsKeyedObject.

Reimplemented in plCameraBrain1_Circle, plCameraBrain1_Fixed, and plCameraBrain1_Avatar.

virtual void plCameraBrain1::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 hsKeyedObject.

Reimplemented in plCameraBrain1_Circle, plCameraBrain1_Fixed, and plCameraBrain1_Avatar.

Member Data Documentation

float plCameraBrain1::fAccel
protected
float plCameraBrain1::fDecel
protected
hsBitVector plCameraBrain1::fEoaFlags
protected
hsBitVector plCameraBrain1::fFlags
protected
float plCameraBrain1::fPanSpeed
protected
float plCameraBrain1::fPOAAccel
protected
float plCameraBrain1::fPOADecel
protected
hsVector3 plCameraBrain1::fPOAOffset
protected
float plCameraBrain1::fPOAVelocity
protected
plKey plCameraBrain1::fRail
protected
plKey plCameraBrain1::fSubject
protected
float plCameraBrain1::fVelocity
protected
float plCameraBrain1::fXPanLimit
protected
float plCameraBrain1::fZoomMax
protected
float plCameraBrain1::fZoomMin
protected
float plCameraBrain1::fZoomRate
protected
float plCameraBrain1::fZPanLimit
protected

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