MissionMarker Class Reference

#include <missionMarker.h>

Inheritance diagram for MissionMarker:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 MissionMarker ()
bool onNewDataBlock (GameBaseData *dptr)
 Called when a new datablock is set.
void setTransform (const MatrixF &mat)
 Sets the Object -> World transform.
bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
void onEditorEnable ()
 Called when the editor is activated.
void onEditorDisable ()
 Called when the editor is deactivated.
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.
 DECLARE_CONOBJECT (MissionMarker)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Protected Types

 PositionMask = Parent::NextFreeMask
 NextFreeMask = Parent::NextFreeMask << 1
enum  MaskBits {
  PositionMask = Parent::NextFreeMask,
  NextFreeMask = Parent::NextFreeMask << 1
}

Protected Attributes

MissionMarkerDatamDataBlock
 Datablock.
bool mAddedToScene

Private Types

typedef ShapeBase Parent

Member Typedef Documentation

typedef ShapeBase MissionMarker::Parent [private]

Reimplemented from ShapeBase.

Reimplemented in SpawnSphere, and CameraBookmark.


Member Enumeration Documentation

enum MissionMarker::MaskBits [protected]

Enumerator:
PositionMask 
NextFreeMask 


Constructor & Destructor Documentation

MissionMarker::MissionMarker (  ) 


Member Function Documentation

bool MissionMarker::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 MissionMarker::setTransform ( const MatrixF mat  )  [virtual]

Sets the Object -> World transform.

Parameters:
mat New transform matrix

Reimplemented from SceneObject.

bool MissionMarker::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from ShapeBase.

Reimplemented in SpawnSphere, and CameraBookmark.

void MissionMarker::onRemove (  )  [virtual]

Called when the object is removed from the sim.

Reimplemented from ShapeBase.

void MissionMarker::onEditorEnable (  )  [virtual]

Called when the editor is activated.

Reimplemented from SimObject.

void MissionMarker::onEditorDisable (  )  [virtual]

Called when the editor is deactivated.

Reimplemented from SimObject.

void MissionMarker::inspectPostApply (  )  [virtual]

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

See also:
inspectPreApply

Reimplemented from GameBase.

Reimplemented in SpawnSphere, and CameraBookmark.

U32 MissionMarker::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 ShapeBase.

Reimplemented in SpawnSphere, and CameraBookmark.

void MissionMarker::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 ShapeBase.

Reimplemented in SpawnSphere, and CameraBookmark.

MissionMarker::DECLARE_CONOBJECT ( MissionMarker   ) 

static void MissionMarker::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBase.

Reimplemented in SpawnSphere, and CameraBookmark.


Member Data Documentation

Datablock.

Reimplemented from ShapeBase.