torque Torque Game Engine Documentation
TGE Version 1.5.2
Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

Marker Class Reference

#include <simPath.h>

Inheritance diagram for Marker:

Inheritance graph
[legend]

Public Types

enum  {
  SmoothingTypeLinear,
  SmoothingTypeSpline,
  SmoothingTypeAccelerate
}
enum  {
  KnotTypeNormal,
  KnotTypePositionOnly,
  KnotTypeKink
}

Public Member Functions

 Marker ()
 ~Marker ()
 DECLARE_CONOBJECT (Marker)
void inspectPostApply ()
 Called after any property of the object is changed in the world editor.
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 void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

U32 mSeqNum
U32 mSmoothingType
U32 mKnotType
U32 mMSToNext

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.
bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
void onGroupAdd ()
 Called when the object is added to a SimGroup.
void onEditorEnable ()
 Called when the editor is activated.
void onEditorDisable ()
 Called when the editor is deactivated.

Private Types

typedef SceneObject Parent

Friends

class Path

Member Typedef Documentation

typedef SceneObject Marker::Parent [private]

Reimplemented from SceneObject.

Member Enumeration Documentation

anonymous enum

Enumerator:
SmoothingTypeLinear 
SmoothingTypeSpline 
SmoothingTypeAccelerate 

anonymous enum

Enumerator:
KnotTypeNormal 
KnotTypePositionOnly 
KnotTypeKink 

Constructor & Destructor Documentation

Marker::Marker (  ) 

Marker::~Marker (  ) 

Member Function Documentation

bool Marker::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.

void Marker::renderObject ( SceneState *  state,
SceneRenderImage *  image 
) [protected, virtual]

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.

bool Marker::onAdd (  )  [protected, virtual]

Called when the object is added to the sim.

Reimplemented from SceneObject.

void Marker::onRemove (  )  [protected, virtual]

Called when the object is removed from the sim.

Reimplemented from SceneObject.

void Marker::onGroupAdd (  )  [protected, virtual]

Called when the object is added to a SimGroup.

Reimplemented from SimObject.

void Marker::onEditorEnable (  )  [protected, virtual]

Called when the editor is activated.

Reimplemented from SimObject.

void Marker::onEditorDisable (  )  [protected, virtual]

Called when the editor is deactivated.

Reimplemented from SimObject.

Marker::DECLARE_CONOBJECT ( Marker   ) 

static void Marker::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from SceneObject.

void Marker::inspectPostApply (  )  [virtual]

Called after any property of the object is changed in the world editor.

See also:
inspectPreApply

Reimplemented from SceneObject.

U32 Marker::packUpdate ( NetConnection *  conn,
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 NetObject.

void Marker::unpackUpdate ( NetConnection *  conn,
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 NetObject.

Friends And Related Function Documentation

friend class Path [friend]

Field Documentation

U32 Marker::mSeqNum

U32 Marker::mSmoothingType

U32 Marker::mKnotType

U32 Marker::mMSToNext



All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen
© GarageGames.com Home Back to Top