PathedInterior Class Reference#include <pathedInterior.h>
Inheritance diagram for PathedInterior: 
[legend]
|
Public Types |
| enum | UpdateMasks {
NewTargetMask = Parent::NextFreeMask,
NewPositionMask = Parent::NextFreeMask << 1,
NextFreeMask = Parent::NextFreeMask << 2
} |
Public Member Functions |
| | PathedInterior () |
| | ~PathedInterior () |
| PathedInterior * | getNext () |
| void | processTick (const Move *move) |
| | Processes a move event and updates object state once every 32 milliseconds.
|
| void | setStopped () |
| void | resolvePathKey () |
| bool | onNewDataBlock (GameBaseData *dptr) |
| | Called when a new datablock is set.
|
| bool | buildPolyList (AbstractPolyList *polyList, const Box3F &box, const SphereF &sphere) |
| | Builds a list of polygons which intersect a bounding volume.
|
| bool | readPI (Stream &) |
| bool | writePI (Stream &) const |
| PathedInterior * | clone () const |
| | DECLARE_CONOBJECT (PathedInterior) |
| void | setPathPosition (S32 newPosition) |
| void | setTargetPosition (S32 targetPosition) |
| void | computeNextPathStep (U32 timeDelta) |
| Box3F | getExtrudedBox () |
| Point3F | getVelocity () |
| void | advance (F64 timeDelta) |
| U32 | packUpdate (NetConnection *conn, U32 mask, BitStream *stream) |
| | Instructs this object to pack its state for transfer over the network.
|
| void | unpackUpdate (NetConnection *conn, BitStream *stream) |
| | Instructs this object to read state data previously packed with packUpdate.
|
Static Public Member Functions |
| static PathedInterior * | getClientPathedInteriors () |
| static void | initPersistFields () |
| | Register dynamic fields in a subclass of ConsoleObject.
|
Protected Member Functions |
| bool | prepRenderImage (SceneState *state, const U32 stateKey, const U32 startZone, const bool modifyBaseZoneState) |
| | Called when the SceneGraph is ready for the registration of RenderImages.
|
| void | renderObject (SceneState *state, SceneRenderImage *image) |
| | Called when the object is supposed to render itself.
|
| void | renderShadowVolumes (SceneState *state) |
| bool | onAdd () |
| | Called when the object is added to the sim.
|
| void | onRemove () |
| | Called when the object is removed from the sim.
|
| bool | onSceneAdd (SceneGraph *graph) |
| | Called when this is added to the SceneGraph.
|
| void | onSceneRemove () |
| | Called when this is removed from the SceneGraph.
|
Protected Attributes |
| StringTableEntry | mName |
| S32 | mPathIndex |
| Vector< StringTableEntry > | mTriggers |
| Point3F | mOffset |
| Box3F | mExtrudedBox |
| bool | mStopped |
| AUDIOHANDLE | mSustainHandle |
| StringTableEntry | mInteriorResName |
| S32 | mInteriorResIndex |
| Resource< InteriorResource > | mInteriorRes |
| Interior * | mInterior |
| Vector< ColorI > | mVertexColorsNormal |
| Vector< ColorI > | mVertexColorsAlarm |
| LM_HANDLE | mLMHandle |
| MatrixF | mBaseTransform |
| Point3F | mBaseScale |
| U32 | mPathKey |
| F64 | mCurrentPosition |
| S32 | mTargetPosition |
| Point3F | mCurrentVelocity |
| PathedInterior * | mNextClientPI |
Static Protected Attributes |
| static PathedInterior * | mClientPathedInteriors |
Private Types |
| typedef GameBase | Parent |
Private Member Functions |
| U32 | getPathKey () |
Private Attributes |
| PathedInteriorData * | mDataBlock |
Friends |
| class | InteriorInstance |
| class | EditGeometry |
| class | EditInteriorResource |
Member Typedef Documentation
Member Enumeration Documentation
- Enumerator:
-
| NewTargetMask |
|
| NewPositionMask |
|
| NextFreeMask |
|
Constructor & Destructor Documentation
| PathedInterior::PathedInterior |
( |
|
) |
|
| PathedInterior::~PathedInterior |
( |
|
) |
|
Member Function Documentation
| U32 PathedInterior::getPathKey |
( |
|
) |
[private] |
| bool PathedInterior::prepRenderImage |
( |
SceneState * |
state, |
|
|
const U32 |
stateKey, |
|
|
const U32 |
startZone, |
|
|
const bool |
modifyBaseZoneState | |
|
) |
| | [protected, virtual] |
Called when the SceneGraph is ready for the registration of RenderImages.
- See also:
- SceneState
- Parameters:
-
| state | SceneState |
| stateKey | State key of the current SceneState |
| startZone | Base zone index |
| modifyBaseZoneState | If true, the object needs to modify the zone state. |
Reimplemented from SceneObject.
Called when the object is supposed to render itself.
- Parameters:
-
| state | Current rendering state. |
- See also:
- SceneState
- Parameters:
-
| image | Image associated with this object to render. |
- See also:
- SceneRenderImage
Reimplemented from SceneObject.
| void PathedInterior::renderShadowVolumes |
( |
SceneState * |
state |
) |
[protected] |
| bool PathedInterior::onAdd |
( |
|
) |
[protected, virtual] |
Called when the object is added to the sim.
Reimplemented from GameBase.
| void PathedInterior::onRemove |
( |
|
) |
[protected, virtual] |
Called when the object is removed from the sim.
Reimplemented from GameBase.
| bool PathedInterior::onSceneAdd |
( |
SceneGraph * |
graph |
) |
[protected, virtual] |
| void PathedInterior::onSceneRemove |
( |
|
) |
[protected, virtual] |
| static PathedInterior* PathedInterior::getClientPathedInteriors |
( |
|
) |
[inline, static] |
| void PathedInterior::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 GameBase.
| void PathedInterior::setStopped |
( |
|
) |
[inline] |
| void PathedInterior::resolvePathKey |
( |
|
) |
|
| bool PathedInterior::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 GameBase.
Builds a list of polygons which intersect a bounding volume.
This will use either the sphere or the box, not both, the SceneObject implimentation ignores sphere.
- See also:
- AbstractPolyList
- Parameters:
-
| polyList | Poly list build (out) |
| box | Box bounding volume |
| sphere | Sphere bounding volume |
Reimplemented from SceneObject.
| bool PathedInterior::readPI |
( |
Stream & |
|
) |
|
| bool PathedInterior::writePI |
( |
Stream & |
|
) |
const |
| static void PathedInterior::initPersistFields |
( |
|
) |
[static] |
| void PathedInterior::setPathPosition |
( |
S32 |
newPosition |
) |
|
| void PathedInterior::setTargetPosition |
( |
S32 |
targetPosition |
) |
|
| void PathedInterior::computeNextPathStep |
( |
U32 |
timeDelta |
) |
|
| Box3F PathedInterior::getExtrudedBox |
( |
|
) |
[inline] |
| Point3F PathedInterior::getVelocity |
( |
|
) |
|
| void PathedInterior::advance |
( |
F64 |
timeDelta |
) |
|
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 GameBase.
Instructs this object to read state data previously packed with packUpdate.
- Parameters:
-
| conn | Net connection being used |
| stream | stream to read from |
Reimplemented from GameBase.
Friends And Related Function Documentation
friend class EditGeometry [friend] |
friend class EditInteriorResource [friend] |
Field Documentation
|
Torque Game Engine Documentation