Torque3D Documentation / _generateds / PathCamera

PathCamera

Engine/source/T3D/pathCamera.h

More...

Classes:

class
PathCamera::StateDelta

Public Types

enum
State {
  Forward 
  Backward 
  Stop 
  StateBits = 3
}

Private Types

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

ShapeBase

Parent

Private Attributes

StateDelta

delta 

PathCameraData *

mDataBlock 

S32

mNodeBase 

S32

mNodeCount 

F32

mPosition 

CameraSpline

mSpline 

S32

mState 

F32

mTarget 

bool

mTargetSet

Private Functions

void

advancePosition(S32 ms)

void

interpolateMat(F32 pos, MatrixF * mat)

Public Functions

PathCamera()

~PathCamera()

DECLARE_CALLBACK(void , onNode , (S32 node) )

DECLARE_CONOBJECT(PathCamera )

void

getCameraTransform(F32 * pos, MatrixF * mat)

Gets the camera to world space transform matrix.
void

interpolateTick(F32 delta)

Interpolates between tick events.
bool

onAdd()

Called when the object is added to the sim.
void

onEditorDisable()

Called when the editor is deactivated.
void

onEditorEnable()

Called when the editor is activated.
bool

onNewDataBlock(GameBaseData * dptr, bool reload)

Called when a new datablock is set.
void

onNode(S32 node)

void

onRemove()

Called when the object is removed from the sim.
U32

packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

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

popFront()

void

processTick(const Move * move)

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

pushBack(CameraSpline::Knot * knot)

void

pushFront(CameraSpline::Knot * knot)

void

reset(F32 speed)

void

setPosition(F32 pos)

void

setState(State s)

void

setTarget(F32 pos)

void

unpackUpdate(NetConnection * conn, BitStream * stream)

Instructs this object to read state data previously packed with packUpdate.
Public Static Functions
void

consoleInit()

void

initPersistFields()

Detailed Description
Public Types
State

Enumerator
Forward 
Backward 
Stop 
StateBits = 3
Private Types
Constants

Enumerator
NodeWindow = 128
MaskBits

Enumerator
WindowMask = Parent::NextFreeMask
PositionMask = Parent::NextFreeMask + 1
TargetMask = Parent::NextFreeMask + 2
StateMask = Parent::NextFreeMask + 3
NextFreeMask = Parent::NextFreeMask << 1
typedef ShapeBase Parent 

Private Attributes
StateDelta delta 

PathCameraData * mDataBlock 

S32 mNodeBase 

S32 mNodeCount 

F32 mPosition 

CameraSpline mSpline 

S32 mState 

F32 mTarget 

bool mTargetSet 

Private Functions
advancePosition(S32 ms)

interpolateMat(F32 pos, MatrixF * mat)

Public Functions
PathCamera()

~PathCamera()

DECLARE_CALLBACK(void , onNode , (S32 node) )

DECLARE_CONOBJECT(PathCamera )

getCameraTransform(F32 * pos, MatrixF * mat)

Reimplemented from: ShapeBase
interpolateTick(F32 delta)

Reimplemented from: GameBase
onAdd()

Reimplemented from: GameBase
onEditorDisable()

Reimplemented from: SimObject
onEditorEnable()

Reimplemented from: SimObject
onNewDataBlock(GameBaseData * dptr, bool reload)

Reimplemented from: GameBase
onNode(S32 node)

onRemove()

Reimplemented from: GameBase
packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

Reimplemented from: GameBase
popFront()

processTick(const Move * move)

Reimplemented from: GameBase
pushBack(CameraSpline::Knot * knot)

pushFront(CameraSpline::Knot * knot)

reset(F32 speed)

setPosition(F32 pos)

setState(State s)

setTarget(F32 pos)

unpackUpdate(NetConnection * conn, BitStream * stream)

Reimplemented from: GameBase
Public Static Functions
consoleInit()

initPersistFields()