Torque Game Engine Documentation
TGE Version 1.5.2

Path Class Reference

#include <simPath.h>

Inheritance diagram for Path:

Detailed Description

A path!

Public Types

enum { NoPathIndex = 0xFFFFFFFF }

Public Member Functions

Path ()

~Path ()

void addObject (SimObject *)

Add an object to the group.

void removeObject (SimObject *)

Remove an object from the group.

void sortMarkers ()

void updatePath ()

bool isLooping ()

U32 getPathIndex () const

DECLARE_CONOBJECT (Path)

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Protected Member Functions

bool onAdd ()

Called when the object is added to the sim.

void onRemove ()

Called when the object is removed from the sim.

Private Types

typedef SimGroup Parent

Private Attributes

U32 mPathIndex

bool mIsLooping

typedef SimGroup Path::Parent [private]

Reimplemented from SimGroup.

anonymous enum

Enumerator:

NoPathIndex

Path::Path ( )

Path::~Path ( )

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

Called when the object is added to the sim.

Reimplemented from SimObject.

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

Called when the object is removed from the sim.

Reimplemented from SimGroup.

void Path::addObject ( SimObject * ) [virtual]

Add an object to the group.

Reimplemented from SimGroup.

void Path::removeObject ( SimObject * ) [virtual]

Remove an object from the group.

Reimplemented from SimGroup.

void Path::sortMarkers ( )

void Path::updatePath ( )

bool Path::isLooping ( ) [inline]

U32 Path::getPathIndex ( ) const [inline]

Path::DECLARE_CONOBJECT ( Path )

static void Path::initPersistFields ( ) [static]

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

Reimplemented from SimObject.

U32 Path::mPathIndex [private]

bool Path::mIsLooping [private]