Torque Game Engine Documentation
TGE Version 1.5.2

SimObjectList Class Reference

#include <simBase.h>

Inheritance diagram for SimObjectList:

[legend]

Detailed Description

A vector of SimObjects.

As this inherits from VectorPtr, it has the full range of vector methods.

Public Member Functions

void pushBack (SimObject *)

Add the SimObject* to the end of the list, unless it's already in the list.

void pushBackForce (SimObject *)

Add the SimObject* to the end of the list, moving it there if it's already present in the list.

void pushFront (SimObject *)

Add the SimObject* to the start of the list.

void remove (SimObject *)

Remove the SimObject* from the list; may disrupt order of the list.

SimObject * at (S32 index) const

void removeStable (SimObject *pObject)

Remove the SimObject* from the list; guaranteed to preserve list order.

void sortId ()

Sort the list by object ID.

Static Private Member Functions

static S32 QSORT_CALLBACK compareId (const void *a, const void *b)

Member Function Documentation

static S32 QSORT_CALLBACK SimObjectList::compareId	(	const void *	a,
		const void *	b
	)			`[static, private]`

void SimObjectList::pushBack ( SimObject * )

Add the SimObject* to the end of the list, unless it's already in the list.

void SimObjectList::pushBackForce ( SimObject * )

Add the SimObject* to the end of the list, moving it there if it's already present in the list.

void SimObjectList::pushFront ( SimObject * )

Add the SimObject* to the start of the list.

void SimObjectList::remove ( SimObject * )

Remove the SimObject* from the list; may disrupt order of the list.

SimObject* SimObjectList::at ( S32 index ) const [inline]

void SimObjectList::removeStable ( SimObject * pObject )

Remove the SimObject* from the list; guaranteed to preserve list order.

void SimObjectList::sortId ( )

Sort the list by object ID.