PathCamera Class Reference

#include <pathCamera.h>

Inheritance diagram for PathCamera:

Inheritance graph
[legend]
List of all members.

Public Types

 Forward
 Backward
 Stop
 StateBits = 3
enum  State {
  Forward,
  Backward,
  Stop,
  StateBits = 3
}

Public Member Functions

 DECLARE_CONOBJECT (PathCamera)
 PathCamera ()
 ~PathCamera ()
void onEditorEnable ()
 Called when the editor is activated.
void onEditorDisable ()
 Called when the editor is deactivated.
bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
bool onNewDataBlock (GameBaseData *dptr)
 Called when a new datablock is set.
void onNode (S32 node)
void processTick (const Move *)
 Processes a move event and updates object state once every 32 milliseconds.
void interpolateTick (F32 dt)
 Interpolates between tick events.
void getCameraTransform (F32 *pos, MatrixF *mat)
 Gets the camera transform.
U32 packUpdate (NetConnection *, U32 mask, BitStream *stream)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *, BitStream *stream)
 Instructs this object to read state data previously packed with packUpdate.
void reset (F32 speed=1)
void pushFront (CameraSpline::Knot *knot)
void pushBack (CameraSpline::Knot *knot)
void popFront ()
void setPosition (F32 pos)
void setTarget (F32 pos)
void setState (State s)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.
static void consoleInit ()
 Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.

Private Types

typedef ShapeBase Parent
 WindowMask = Parent::NextFreeMask
 PositionMask = Parent::NextFreeMask + 1
 TargetMask = Parent::NextFreeMask + 2
 StateMask = Parent::NextFreeMask + 3
 NextFreeMask = Parent::NextFreeMask << 1
 NodeWindow = 128
enum  MaskBits {
  WindowMask = Parent::NextFreeMask,
  PositionMask = Parent::NextFreeMask + 1,
  TargetMask = Parent::NextFreeMask + 2,
  StateMask = Parent::NextFreeMask + 3,
  NextFreeMask = Parent::NextFreeMask << 1
}
enum  Constants { NodeWindow = 128 }

Private Member Functions

void interpolateMat (F32 pos, MatrixF *mat)
void advancePosition (S32 ms)

Private Attributes

StateDelta delta
PathCameraData * mDataBlock
 Datablock.
CameraSpline mSpline
S32 mNodeBase
S32 mNodeCount
F32 mPosition
int mState
F32 mTarget
bool mTargetSet

Classes

struct  StateDelta

Member Typedef Documentation

typedef ShapeBase PathCamera::Parent [private]

Reimplemented from ShapeBase.

Member Enumeration Documentation

enum PathCamera::State

Enumerator:
Forward 
Backward 
Stop 
StateBits 

enum PathCamera::MaskBits [private]

Enumerator:
WindowMask 
PositionMask 
TargetMask 
StateMask 
NextFreeMask 

enum PathCamera::Constants [private]

Enumerator:
NodeWindow 

Constructor & Destructor Documentation

PathCamera::PathCamera (  ) 

PathCamera::~PathCamera (  ) 

Member Function Documentation

void PathCamera::interpolateMat ( F32  pos,
MatrixF *  mat 
) [private]

void PathCamera::advancePosition ( S32  ms  )  [private]

PathCamera::DECLARE_CONOBJECT ( PathCamera   ) 

static void PathCamera::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDeprecatedField(), addGroup(), endGroup()

Reimplemented from GameBase.

static void PathCamera::consoleInit (  )  [static]

Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.

See also:
console

Reimplemented from ShapeBase.

void PathCamera::onEditorEnable (  )  [virtual]

Called when the editor is activated.

Reimplemented from SimObject.

void PathCamera::onEditorDisable (  )  [virtual]

Called when the editor is deactivated.

Reimplemented from SimObject.

bool PathCamera::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from ShapeBase.

void PathCamera::onRemove (  )  [virtual]

Called when the object is removed from the sim.

Reimplemented from ShapeBase.

bool PathCamera::onNewDataBlock ( GameBaseData *  dptr  )  [virtual]

Called when a new datablock is set.

This allows subclasses to appropriately handle new datablocks.

See also:
setDataBlock()
Parameters:
dptr New datablock

Reimplemented from ShapeBase.

void PathCamera::onNode ( S32  node  ) 

void PathCamera::processTick ( const Move *   )  [virtual]

Processes a move event and updates object state once every 32 milliseconds.

This takes place both on the client and server, every 32 milliseconds (1 tick).

See also:
ProcessList
Parameters:
move Move event corresponding to this tick, or NULL.

Reimplemented from ShapeBase.

void PathCamera::interpolateTick ( F32  dt  )  [virtual]

Interpolates between tick events.

This takes place on the CLIENT ONLY.

Parameters:
delta Time since last call to interpolate

Reimplemented from GameBase.

void PathCamera::getCameraTransform ( F32 *  pos,
MatrixF *  mat 
) [virtual]

Gets the camera transform.

Parameters:
pos TODO: Find out what this does
mat Camera transform (out)

Reimplemented from ShapeBase.

U32 PathCamera::packUpdate ( NetConnection *  ,
U32  mask,
BitStream *  stream 
) [virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from ShapeBase.

void PathCamera::unpackUpdate ( NetConnection *  ,
BitStream *  stream 
) [virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from ShapeBase.

void PathCamera::reset ( F32  speed = 1  ) 

void PathCamera::pushFront ( CameraSpline::Knot *  knot  ) 

void PathCamera::pushBack ( CameraSpline::Knot *  knot  ) 

void PathCamera::popFront (  ) 

void PathCamera::setPosition ( F32  pos  ) 

void PathCamera::setTarget ( F32  pos  ) 

void PathCamera::setState ( State  s  ) 

Member Data Documentation

StateDelta PathCamera::delta [private]

PathCameraData* PathCamera::mDataBlock [private]

Datablock.

Reimplemented from ShapeBase.

CameraSpline PathCamera::mSpline [private]

S32 PathCamera::mNodeBase [private]

S32 PathCamera::mNodeCount [private]

F32 PathCamera::mPosition [private]

int PathCamera::mState [private]

F32 PathCamera::mTarget [private]

bool PathCamera::mTargetSet [private]

© GarageGames.com Home Back to Top
© GarageGames.com Home Back to Top