PathCamera Class Reference#include <pathCamera.h>
Inheritance diagram for PathCamera: 
[legend]
|
Public Types |
| 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.
|
| void | renderImage (SceneState *state, SceneRenderImage *) |
| 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 |
| enum | MaskBits {
WindowMask = Parent::NextFreeMask,
PositionMask = Parent::NextFreeMask + 1,
TargetMask = Parent::NextFreeMask + 2,
StateMask = Parent::NextFreeMask + 3,
NextFreeMask = Parent::NextFreeMask << 1
} |
| enum | Constants { NodeWindow = 20
} |
| typedef ShapeBase | Parent |
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 |
Data Structures |
| struct | StateDelta |
Member Typedef Documentation
Member Enumeration Documentation
- Enumerator:
-
| Forward |
|
| Backward |
|
| Stop |
|
| StateBits |
|
- Enumerator:
-
| WindowMask |
|
| PositionMask |
|
| TargetMask |
|
| StateMask |
|
| NextFreeMask |
|
Constructor & Destructor Documentation
| PathCamera::PathCamera |
( |
|
) |
|
| PathCamera::~PathCamera |
( |
|
) |
|
Member Function Documentation
| void PathCamera::advancePosition |
( |
S32 |
ms |
) |
[private] |
| static void PathCamera::initPersistFields |
( |
|
) |
[static] |
| static void PathCamera::consoleInit |
( |
|
) |
[static] |
Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.
- Deprecated:
- You should use ConsoleMethod and ConsoleFunction, not this, to register methods or commands.
- 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:
-
Reimplemented from ShapeBase.
| void PathCamera::onNode |
( |
S32 |
node |
) |
|
| void PathCamera::processTick |
( |
const Move * |
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 |
delta |
) |
[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.
- Todo:
- Find out what pos does
- Parameters:
-
| pos | TODO: Find out what this does |
| mat | Camera transform (out) |
Reimplemented from ShapeBase.
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.
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::popFront |
( |
|
) |
|
| void PathCamera::setPosition |
( |
F32 |
pos |
) |
|
| void PathCamera::setTarget |
( |
F32 |
pos |
) |
|
Field Documentation
|
Torque Game Engine Documentation