Torque Game Engine Documentation
TGE Version 1.5.2

SimGroup Class Reference

#include <simBase.h>

Inheritance diagram for SimGroup:

[legend]

Detailed Description

A group of SimObjects.

A SimGroup is a stricter form of SimSet. SimObjects may only be a member of a single SimGroup at a time.

The SimGroup will automatically enforce the single-group-membership rule.

      // From engine/sim/simPath.cc - getting a pointer to a SimGroup
      SimGroup* pMissionGroup = dynamic_cast<SimGroup*>(Sim::findObject("MissionGroup"));

      // From game/trigger.cc:46 - iterating over a SimObject's group.
      SimObject* trigger = ...;
      SimGroup* pGroup = trigger->getGroup();
      for (SimGroup::iterator itr = pGroup->begin(); itr != pGroup->end(); itr++)
      {
         // do something with *itr
      }

Public Member Functions

~SimGroup ()

virtual void addObject (SimObject *)

Add an object to the group.

void addObject (SimObject *, SimObjectId)

void addObject (SimObject *, const char *name)

virtual void removeObject (SimObject *)

Remove an object from the group.

virtual void onRemove ()

Called when the object is removed from the sim.

virtual SimObject * findObject (const char *name)

Find an object in the group.

SimObject * findObjectByInternalName (const char *internalName, bool searchChildren=false)

bool processArguments (S32 argc, const char **argv)

Process constructor options. (ie, new SimObject(1,2,3)).

DECLARE_CONOBJECT (SimGroup)

Private Types

typedef SimSet Parent

Private Attributes

SimNameDictionary nameDictionary

Friends

class SimManager

class SimObject

Member Typedef Documentation

typedef SimSet SimGroup::Parent [private]

Reimplemented from SimSet.

Reimplemented in SimChunk, UnknownChunk, CreatorTree, EditManager, EditTSCtrl, GuiTerrPreviewCtrl, MissionAreaEditor, TerrainEditor, WorldEditor, AIClient, AIConnection, DebugView, GameConnection, GameTSCtrl, GuiPlayerView, GuiControlArrayControl, GuiFrameSetCtrl, GuiPaneControl, GuiScrollCtrl, GuiStackControl, GuiTabBookCtrl, GuiWindowCtrl, GuiBackgroundCtrl, GuiBitmapButtonCtrl, GuiBitmapButtonTextCtrl, GuiBitmapCtrl, GuiButtonBaseCtrl, GuiButtonCtrl, GuiCheckBoxCtrl, GuiColorPickerCtrl, GuiConsole, GuiConsoleEditCtrl, GuiConsoleTextCtrl, GuiDirectoryFileListCtrl, GuiDirectoryTreeCtrl, GuiListBoxCtrl, GuiMLTextCtrl, GuiMLTextEditCtrl, GuiPopUpTextListCtrl, GuiPopUpMenuCtrl, GuiRadioCtrl, GuiSliderCtrl, GuiTabPageCtrl, GuiTextCtrl, GuiTextEditCtrl, GuiTextEditSliderCtrl, GuiTextListCtrl, GuiTreeViewCtrl, GuiArrayCtrl, GuiCanvas, GuiControl, GuiTSCtrl, DbgFileView, GuiEditCtrl, GuiFilterCtrl, GuiGraphCtrl, GuiInspector, GuiInspectorField, GuiInspectorGroup, GuiInspectorDynamicField, GuiInspectorDynamicGroup, GuiInspectorDatablockField, GuiInspectorTypeEnum, GuiInspectorTypeCheckBox, GuiInspectorTypeGuiProfile, GuiInspectorTypeFileName, GuiInspectorTypeColor, GuiInspectorTypeColorI, GuiInspectorTypeColorF, GuiMenuBackgroundCtrl, GuiSubmenuBackgroundCtrl, GuiMenuTextListCtrl, GuiMenuBar, GuiAviBitmapCtrl, GuiMessageVectorCtrl, GuiProgressCtrl, GuiEffectCanvas, GuiTheoraCtrl, GuiTickCtrl, GuiBubbleTextCtrl, GuiInputCtrl, GuiMouseEventCtrl, GuiVectorFieldCtrl, DInputManager, UInputManager, NetConnection, and Path.

Constructor & Destructor Documentation

SimGroup::~SimGroup ( )

Member Function Documentation

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

Add an object to the group.

Reimplemented from SimSet.

Reimplemented in GuiFrameSetCtrl, GuiScrollCtrl, GuiStackControl, GuiControl, and Path.

void SimGroup::addObject	(	SimObject *	,
		SimObjectId
	)			`[inline]`

void SimGroup::addObject	(	SimObject *	,
		const char *	name
	)			`[inline]`

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

Remove an object from the group.

Reimplemented from SimSet.

Reimplemented in GuiFrameSetCtrl, GuiStackControl, GuiControl, and Path.

virtual void SimGroup::onRemove ( ) [virtual]

Called when the object is removed from the sim.

Reimplemented from SimSet.

Reimplemented in GameConnection, GuiTabBookCtrl, GuiTextListCtrl, GuiControl, GuiMessageVectorCtrl, GuiVectorFieldCtrl, DInputManager, UInputManager, NetConnection, and Path.

virtual SimObject* SimGroup::findObject ( const char * name ) [virtual]

Find an object in the group.

Reimplemented from SimSet.

SimObject* SimGroup::findObjectByInternalName	(	const char *	internalName,
		bool	searchChildren = `false`
	)

bool SimGroup::processArguments	(	S32	argc,
		const char **	argv
	)			`[virtual]`

Process constructor options. (ie, new SimObject(1,2,3)).

Reimplemented from SimObject.

SimGroup::DECLARE_CONOBJECT ( SimGroup )

Friends And Related Function Documentation

friend class SimManager [friend]

Reimplemented from SimObject.

friend class SimObject [friend]

Field Documentation

SimNameDictionary SimGroup::nameDictionary [private]