Torque Game Engine Documentation
TGE Version 1.5.2

SimObject Class Reference

#include <simBase.h>

Inheritance diagram for SimObject:

[legend]

Detailed Description

Base class for objects involved in the simulation.

Introduction

SimObject is a base class for most of the classes you'll encounter working in Torque. It provides fundamental services allowing "smart" object referencing, creation, destruction, organization, and location. Along with SimEvent, it gives you a flexible event-scheduling system, as well as laying the foundation for the in-game editors, GUI system, and other vital subsystems.

Subclassing

You will spend a lot of your time in Torque subclassing, or working with subclasses of, SimObject. SimObject is designed to be easy to subclass.

You should not need to override anything in a subclass except:

The constructor/destructor.
processArguments()
onAdd()/onRemove()
onGroupAdd()/onGroupRemove()
onNameChange()
onStaticModified()
onDeleteNotify()
onEditorEnable()/onEditorDisable()
inspectPreApply()/inspectPostApply()
things from ConsoleObject (see ConsoleObject docs for specifics)

Of course, if you know what you're doing, go nuts! But in most cases, you shouldn't need to touch things not on that list.

When you subclass, you should define a typedef in the class, called Parent, that references the class you're inheriting from.

 class mySubClass : public SimObject {
     typedef SimObject Parent;
     ...

Then, when you override a method, put in:

 bool mySubClass::onAdd()
 {
     if(!Parent::onAdd())
         return false;

     // ... do other things ...
 }

Of course, you want to replace onAdd with the appropriate method call.

A SimObject's Life Cycle

SimObjects do not live apart. One of the primary benefits of using a SimObject is that you can uniquely identify it and easily find it (using its ID). Torque does this by keeping a global hierarchy of SimGroups - a tree - containing every registered SimObject. You can then query for a given object using Sim::findObject() (or SimSet::findObject() if you want to search only a specific set).

        // Three examples of registering an object.

        // Method 1:
        AIClient *aiPlayer = new AIClient();
        aiPlayer->registerObject();

        // Method 2:
        ActionMap* globalMap = new ActionMap;
        globalMap->registerObject("GlobalActionMap");

        // Method 3:
        bool reg = mObj->registerObject(id);

Registering a SimObject performs these tasks:

Marks the object as not cleared and not removed.
Assigns the object a unique SimObjectID if it does not have one already.
Adds the object to the global name and ID dictionaries so it can be found again.
Calls the object's onAdd() method. Note: SimObject::onAdd() performs some important initialization steps. See here for details" on how to properly subclass SimObject.
If onAdd() fails (returns false), it calls unregisterObject().
Checks to make sure that the SimObject was properly initialized (and asserts if not).

Calling registerObject() and passing an ID or a name will cause the object to be assigned that name and/or ID before it is registered.

Congratulations, you have now registered your object! What now?

Well, hopefully, the SimObject will have a long, useful life. But eventually, it must die.

There are a two ways a SimObject can die.

First, the game can be shut down. This causes the root SimGroup to be unregistered and deleted. When a SimGroup is unregistered, it unregisters all of its member SimObjects; this results in everything that has been registered with Sim being unregistered, as everything registered with Sim is in the root group.
Second, you can manually kill it off, either by calling unregisterObject() or by calling deleteObject().

When you unregister a SimObject, the following tasks are performed:

The object is flagged as removed.
Notifications are cleaned up.
If the object is in a group, then it removes itself from the group.
Delete notifications are sent out.
Finally, the object removes itself from the Sim globals, and tells Sim to get rid of any pending events for it.

If you call deleteObject(), all of the above tasks are performed, in addition to some sanity checking to make sure the object was previously added properly, and isn't in the process of being deleted. After the object is unregistered, it deallocates itself.

Torque Editors

SimObjects are one of the building blocks for the in-game editors. They provide a basic interface for the editor to be able to list the fields of the object, update them safely and reliably, and inform the object things have changed.

This interface is implemented in the following areas:

onNameChange() is called when the object is renamed.
onStaticModified() is called whenever a static field is modified.
inspectPreApply() is called before the object's fields are updated, when changes are being applied.
inspectPostApply() is called after the object's fields are updated.
onEditorEnable() is called whenever an editor is enabled (for instance, when you hit F11 to bring up the world editor).
onEditorDisable() is called whenever the editor is disabled (for instance, when you hit F11 again to close the world editor).

(Note: you can check the variable gEditingMission to see if the mission editor is running; if so, you may want to render special indicators. For instance, the fxFoliageReplicator renders inner and outer radii when the mission editor is runnning.)

The Console

SimObject extends ConsoleObject by allowing you to to set arbitrary dynamic fields on the object, as well as statically defined fields. This is done through two methods, setDataField and getDataField, which deal with the complexities of allowing access to two different types of object fields.

Static fields take priority over dynamic fields. This is to be expected, as the role of dynamic fields is to allow data to be stored in addition to the predefined fields.

The fields in a SimObject are like properties (or fields) in a class.

Some fields may be arrays, which is what the array parameter is for; if it's non-null, then it is parsed with dAtoI and used as an index into the array. If you access something as an array which isn't, then you get an empty string.

You don't need to read any further than this. Right now, set/getDataField are called a total of 6 times through the entire Torque codebase. Therefore, you probably don't need to be familiar with the details of accessing them. You may want to look at Con::setData instead. Most of the time you will probably be accessing fields directly, or using the scripting language, which in either case means you don't need to do anything special.

The functions to get/set these fields are very straightforward:

  setDataField(StringTable->insert("locked", false), NULL, b ? "true" : "false" );
  curObject->setDataField(curField, curFieldArray, STR.getStringValue());
  setDataField(slotName, array, value);

For advanced users: There are two flags which control the behavior of these functions. The first is ModStaticFields, which controls whether or not the DataField functions look through the static fields (defined with addField; see ConsoleObject for details) of the class. The second is ModDynamicFields, which controls dynamically defined fields. They are set automatically by the console constructor code.

Notification

Notify * mNotifyList

Notification

Helper functions for notification code.

static SimObject::Notify * mNotifyFreeList

static SimObject::Notify * allocNotify ()

Get a free Notify structure.

static void freeNotify (SimObject::Notify *)

Mark a Notify structure as free.

Accessors

const char * getDataField (StringTableEntry slotName, const char *array)

Get the value of a field on the object.

void setDataField (StringTableEntry slotName, const char *array, const char *value)

Set the value of a field on the object.

SimFieldDictionary * getFieldDictionary ()

Get reference to the dictionary containing dynamic fields.

void setCanSaveDynamicFields (bool bCanSave)

Set whether fields created at runtime should be saved. Default is true.

bool getCanSaveDynamicFields (bool bCanSave)

Get whether fields created at runtime should be saved. Default is true.

void setInternalName (const char *newname)

These functions support internal naming that is not namespace bound for locating child controls in a generic way.

StringTableEntry getInternalName ()

Get the internal of of this control.

virtual bool save (const char *pcFilePath, bool bOnlySelected=false)

Save object as a TorqueScript File.

bool isMethod (const char *methodName)

Check if a method exists in the objects current namespace.

Initialization

virtual void dumpClassHierarchy ()

added this so that you can print the entire class hierarchy, including script objects,

SimObject ()

virtual ~SimObject ()

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

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

Events

virtual bool onAdd ()

Called when the object is added to the sim.

virtual void onRemove ()

Called when the object is removed from the sim.

virtual void onGroupAdd ()

Called when the object is added to a SimGroup.

virtual void onGroupRemove ()

Called when the object is removed from a SimGroup.

virtual void onNameChange (const char *name)

Called when the object's name is changed.

virtual void onStaticModified (const char *slotName)

Called when a static field is modified.

virtual void inspectPreApply ()

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

virtual void inspectPostApply ()

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

virtual void onDeleteNotify (SimObject *object)

Called when a SimObject is deleted.

virtual void onEditorEnable ()

Called when the editor is activated.

virtual void onEditorDisable ()

Called when the editor is deactivated.

Notification

Notify * removeNotify (void *ptr, Notify::Type)

Remove a notification from the list.

void deleteNotify (SimObject *obj)

Notify an object when we are deleted.

void clearNotify (SimObject *obj)

Notify an object when we are cleared.

void clearAllNotifications ()

Remove all notifications for this object.

void processDeleteNotifies ()

Send out deletion notifications.

void registerReference (SimObject **obj)

Register a reference to this object.

void unregisterReference (SimObject **obj)

Unregister a reference to this object.

Registration

SimObjects must be registered with the object system.

bool registerObject ()

Register an object with the object system.

bool registerObject (U32 id)

Register the object, forcing the id.

bool registerObject (const char *name)

Register the object, assigning the name.

bool registerObject (const char *name, U32 id)

Register the object, assigning a name and ID.

void unregisterObject ()

Unregister the object from Sim.

void deleteObject ()

Unregister, mark as deleted, and free the object.

Accessors

SimObjectId getId () const

const char * getIdString ()

U32 getType () const

const char * getName () const

void setId (SimObjectId id)

void assignName (const char *name)

SimGroup * getGroup () const

bool isChildOfGroup (SimGroup *pGroup)

bool isProperlyAdded () const

bool isDeleted () const

bool isRemoved () const

bool isLocked ()

void setLocked (bool b)

bool isHidden ()

void setHidden (bool b)

Sets

The object must be properly registered before you can add/remove it to/from a set.
All these functions accept either a name or ID to identify the set you wish to operate on. Then they call addObject or removeObject on the set, which sets up appropriate notifications.
An object may be in multiple sets at a time.

bool addToSet (SimObjectId)

bool addToSet (const char *)

bool removeFromSet (SimObjectId)

bool removeFromSet (const char *)

Serialization

virtual bool writeField (StringTableEntry fieldname, const char *value)

Determine whether or not a field should be written.

virtual void write (Stream &stream, U32 tabStop, U32 flags=0)

Output the TorqueScript to recreate this object.

virtual void writeFields (Stream &stream, U32 tabStop)

Write the fields of this object in TorqueScript.

void assignFieldsFrom (SimObject *obj)

Copy fields from another object onto this one.

Accessors

bool isSelected () const

bool isExpanded () const

void setSelected (bool sel)

void setExpanded (bool exp)

void setModDynamicFields (bool dyn)

void setModStaticFields (bool sta)

Initialization

virtual void registerLights (LightManager *lm, bool lightingScene)

Called to register the object's lights, if any, with the LightManager.

Public Types

enum WriteFlags { SelectedOnly = BIT(0) }

Public Member Functions

virtual SimObject * findObject (const char *name)

Find a named sub-object of this object.

Namespace * getNamespace ()

Return the object's namespace.

const char * tabComplete (const char *prevText, S32 baseLen, bool)

Get next matching item in namespace.

DECLARE_CONOBJECT (SimObject)

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Data Fields

SimGroup * mGroup

SimGroup we're contained in, if any.

Protected Attributes

SimObjectId mId

Id number for this object.

Namespace * mNameSpace

U32 mTypeMask

bool mCanSaveFieldDictionary

true if dynamic fields (added at runtime) should be saved, defaults to true

StringTableEntry mInternalName

Stores object Internal Name.

Private Types

enum {
  Deleted = BIT(0),
  Removed = BIT(1),
  Added = BIT(3),
  Selected = BIT(4),
  Expanded = BIT(5),
  ModStaticFields = BIT(6),
  ModDynamicFields = BIT(7)
}

Flags for use in mFlags. More...

typedef ConsoleObject Parent

Private Attributes

StringTableEntry objectName

SimObject * nextNameObject

SimObject * nextManagerNameObject

SimObject * nextIdObject

BitSet32 mFlags

SimFieldDictionary * mFieldDictionary

Storage for dynamic fields.

Friends

class SimManager

class SimGroup

class SimNameDictionary

class SimManagerNameDictionary

class SimIdDictionary

Data Structures

struct Notify

Member Typedef Documentation

typedef ConsoleObject SimObject::Parent [private]

Reimplemented in AudioEnvironment, AudioSampleEnvironment, AudioDescription, AudioProfile, ConsoleLogger, SimDataBlock, SimSet, SimGroup, SimChunk, UnknownChunk, FileObject, MaterialPropertyMap, CreatorTree, EditManager, EditTSCtrl, GuiTerrPreviewCtrl, MissionAreaEditor, Terraformer, TerrainEditor, WorldEditor, WorldEditor::Selection, AIClient, AIConnection, AIPlayer, AIWheeledVehicle, AudioEmitter, BanList, CameraData, Camera, DebrisData, Debris, DebugView, FireballAtmosphereData, FireballAtmosphere, ExplosionData, Explosion, fxFoliageReplicator, fxLightData, fxLight, fxRenderObject, fxShapeReplicatedStatic, fxShapeReplicator, fxSunLight, LightningData, Lightning, ParticleEmitterNodeData, ParticleEmitterNode, ParticleData, ParticleEmitterData, ParticleEmitter, PrecipitationData, Precipitation, SplashData, Splash, WeatherLightningData, WeatherLightning, GameBaseData, GameBase, GameConnection, GameTSCtrl, GuiPlayerView, ItemData, Item, MissionArea, MissionMarkerData, MissionMarker, SpawnSphere, HTTPObject, TCPObject, PathCameraData, PathCamera, PhysicalZone, PlayerData, Player, ProjectileData, Projectile, RigidShapeData, RigidShape, ShapeBaseImageData, ShapeBaseData, ShapeBase, ShowTSShape, StaticShapeData, StaticShape, Trigger, TSStatic, FlyingVehicleData, FlyingVehicle, HoverVehicleData, HoverVehicle, VehicleData, Vehicle, VehicleBlocker, WheeledVehicleTire, WheeledVehicleSpring, WheeledVehicleData, WheeledVehicle, 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, GuiCursor, GuiControlProfile, 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, MessageVector, LangTable, InteriorInstance, InteriorMap, InteriorSubObject, MirrorSubObject, PathedInteriorData, PathedInterior, sgLightObjectData, sgLightObject, sgMissionLightingFilterData, sgMissionLightingFilter, SceneLighting, volumeLight, DInputManager, UInputManager, SceneRoot, ActionMap, DecalData, DecalManager, NetConnection, NetObject, SceneObject, Path, Marker, Sky, Sun, TerrainBlock, WaterBlock, and TSShapeConstructor.

Member Enumeration Documentation

anonymous enum [private]

Flags for use in mFlags.

Enumerator:

Deleted	This object is marked for deletion.
Removed	This object has been unregistered from the object system.
Added	This object has been registered with the object system.
Selected	This object has been marked as selected. (in editor).
Expanded	This object has been marked as expanded. (in editor).
ModStaticFields	The object allows you to read/modify static fields.
ModDynamicFields	The object allows you to read/modify dynamic fields.

enum SimObject::WriteFlags

Enumerator:

SelectedOnly

Passed to SimObject::write to indicate that only objects marked as selected should be outputted.

Used in SimSet.

Constructor & Destructor Documentation

SimObject::SimObject ( )

virtual SimObject::~SimObject ( ) [virtual]

Member Function Documentation

static SimObject::Notify* SimObject::allocNotify ( ) [static, protected]

Get a free Notify structure.

Reimplemented in GameConnection, and NetConnection.

static void SimObject::freeNotify ( SimObject::Notify * ) [static, protected]

Mark a Notify structure as free.

const char* SimObject::getDataField	(	StringTableEntry	slotName,
		const char *	array
	)

Get the value of a field on the object.

See here for a detailed discussion of what this function does.

Parameters:

	slotName	Field to access.
	array	String containing index into array (if field is an array); if NULL, it is ignored.

void SimObject::setDataField	(	StringTableEntry	slotName,
		const char *	array,
		const char *	value
	)

Set the value of a field on the object.

See here for a detailed discussion of what this function does.

Parameters:

	slotName	Field to access.
	array	String containing index into array; if NULL, it is ignored.
	value	Value to store.

SimFieldDictionary* SimObject::getFieldDictionary ( ) [inline]

Get reference to the dictionary containing dynamic fields.

See here for a detailed discussion of what this function does.

This dictionary can be iterated over using a SimFieldDictionaryIterator.

void SimObject::setCanSaveDynamicFields ( bool bCanSave ) [inline]

Set whether fields created at runtime should be saved. Default is true.

bool SimObject::getCanSaveDynamicFields ( bool bCanSave ) [inline]

Get whether fields created at runtime should be saved. Default is true.

void SimObject::setInternalName ( const char * newname )

These functions support internal naming that is not namespace bound for locating child controls in a generic way.

Set the internal name of this control (Not linked to a namespace)

StringTableEntry SimObject::getInternalName ( )

Get the internal of of this control.

virtual bool SimObject::save	(	const char *	pcFilePath,
		bool	bOnlySelected = `false`
	)			`[virtual]`

Save object as a TorqueScript File.

bool SimObject::isMethod ( const char * methodName )

Check if a method exists in the objects current namespace.

virtual void SimObject::dumpClassHierarchy ( ) [virtual]

added this so that you can print the entire class hierarchy, including script objects,

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

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

Reimplemented in ConsoleLogger, SimGroup, TCPObject, and Sky.

virtual bool SimObject::onAdd ( ) [virtual]

Called when the object is added to the sim.

Reimplemented in AudioDescription, AudioProfile, SimDataBlock, EditManager, EditTSCtrl, MissionAreaEditor, TerrainEditor, WorldEditor, AudioEmitter, Camera, DebrisData, Debris, FireballAtmosphereData, FireballAtmosphere, ExplosionData, Explosion, fxFoliageReplicator, fxLightData, fxLight, fxRenderObject, fxShapeReplicator, fxSunLight, LightningData, Lightning, ParticleEmitterNodeData, ParticleEmitterNode, ParticleData, ParticleEmitterData, ParticleEmitter, PrecipitationData, Precipitation, SplashData, Splash, WeatherLightningData, WeatherLightning, GameBaseData, GameBase, GameConnection, Item, MissionArea, MissionMarker, SpawnSphere, TCPObject, PathCamera, PhysicalZone, Player, ProjectileData, Projectile, RigidShapeData, RigidShape, ShapeBaseImageData, ShapeBase, ShowTSShape, StaticShape, Trigger, TSStatic, FlyingVehicle, HoverVehicleData, HoverVehicle, Vehicle, VehicleBlocker, WheeledVehicle, GuiFrameSetCtrl, GuiTabBookCtrl, GuiDirectoryTreeCtrl, GuiMLTextCtrl, GuiPopUpMenuCtrl, GuiTextCtrl, GuiTextEditCtrl, GuiControl, GuiCursor, GuiControlProfile, GuiInspector, GuiInspectorField, GuiInspectorGroup, GuiInspectorDynamicField, GuiMessageVectorCtrl, GuiVectorFieldCtrl, MessageVector, InteriorInstance, InteriorMap, PathedInterior, sgLightObject, sgMissionLightingFilter, volumeLight, DInputManager, UInputManager, ActionMap, NetObject, SceneObject, Path, Marker, Sky, Sun, TerrainBlock, WaterBlock, and TSShapeConstructor.

virtual void SimObject::onRemove ( ) [virtual]

Called when the object is removed from the sim.

Reimplemented in SimSet, SimGroup, AudioEmitter, Camera, Debris, FireballAtmosphere, Explosion, fxFoliageReplicator, fxLight, fxRenderObject, fxShapeReplicator, fxSunLight, Lightning, ParticleEmitterNode, ParticleEmitter, Precipitation, Splash, WeatherLightning, GameBase, GameConnection, Item, MissionMarker, PathCamera, PhysicalZone, Player, Projectile, RigidShape, ShapeBase, ShowTSShape, StaticShape, Trigger, TSStatic, FlyingVehicle, HoverVehicle, Vehicle, VehicleBlocker, WheeledVehicle, GuiTabBookCtrl, GuiTextListCtrl, GuiControl, GuiCursor, GuiMessageVectorCtrl, GuiVectorFieldCtrl, MessageVector, InteriorInstance, InteriorMap, PathedInterior, sgMissionLightingFilter, volumeLight, DInputManager, UInputManager, NetConnection, NetObject, SceneObject, Path, Marker, Sky, TerrainBlock, and WaterBlock.

virtual void SimObject::onGroupAdd ( ) [virtual]

Called when the object is added to a SimGroup.

Reimplemented in ParticleEmitterNode, and Marker.

virtual void SimObject::onGroupRemove ( ) [virtual]

Called when the object is removed from a SimGroup.

virtual void SimObject::onNameChange ( const char * name ) [virtual]

Called when the object's name is changed.

virtual void SimObject::onStaticModified ( const char * slotName ) [virtual]

Called when a static field is modified.

Specifically, this is called by setDataField when a static field is modified, see the console details.

Reimplemented in SimDataBlock, GuiTextEditCtrl, and InteriorInstance.

virtual void SimObject::inspectPreApply ( ) [virtual]

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

The calling order here is:

Reimplemented in AudioEmitter, GuiControl, and InteriorInstance.

virtual void SimObject::inspectPostApply ( ) [virtual]

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

See also:: inspectPreApply

Reimplemented in AudioEmitter, fxFoliageReplicator, fxLight, fxRenderObject, fxShapeReplicator, fxSunLight, Precipitation, GameBase, MissionMarker, SpawnSphere, StaticShape, TSStatic, GuiControlArrayControl, GuiBitmapButtonCtrl, GuiBitmapCtrl, GuiMLTextCtrl, GuiTextCtrl, GuiControl, GuiMessageVectorCtrl, GuiTheoraCtrl, InteriorInstance, InteriorMap, sgLightObject, sgMissionLightingFilter, volumeLight, SceneObject, Marker, Sky, Sun, TerrainBlock, and WaterBlock.

virtual void SimObject::onDeleteNotify ( SimObject * object ) [virtual]

Called when a SimObject is deleted.

When you are on the notification list for another object and it is deleted, this method is called.

Reimplemented in SimSet, TerrainEditor, WorldEditor::Selection, Camera, Item, ShapeBase, Trigger, DInputManager, and UInputManager.

virtual void SimObject::onEditorEnable ( ) [inline, virtual]

Called when the editor is activated.

Reimplemented in WorldEditor, Camera, fxFoliageReplicator, fxRenderObject, fxShapeReplicator, MissionMarker, PathCamera, Trigger, InteriorMap, Marker, and TerrainBlock.

virtual void SimObject::onEditorDisable ( ) [inline, virtual]

Called when the editor is deactivated.

Reimplemented in Camera, fxFoliageReplicator, fxRenderObject, fxShapeReplicator, MissionMarker, PathCamera, Trigger, InteriorMap, Marker, and TerrainBlock.

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

Find a named sub-object of this object.

This is subclassed in the SimGroup and SimSet classes.

For a single object, it just returns NULL, as normal objects cannot have children.

Reimplemented in SimSet, and SimGroup.

Notify* SimObject::removeNotify	(	void *	ptr,
		Notify::Type
	)

Remove a notification from the list.

void SimObject::deleteNotify ( SimObject * obj )

Notify an object when we are deleted.

void SimObject::clearNotify ( SimObject * obj )

Notify an object when we are cleared.

void SimObject::clearAllNotifications ( )

Remove all notifications for this object.

void SimObject::processDeleteNotifies ( )

Send out deletion notifications.

void SimObject::registerReference ( SimObject ** obj )

You pass a pointer to your reference to this object.

When the object is deleted, it will null your pointer, ensuring you don't access old memory.

Parameters:

obj

Pointer to your reference to the object.

void SimObject::unregisterReference ( SimObject ** obj )

Unregister a reference to this object.

Remove a reference from the list, so that it won't get nulled inappropriately.

Call this when you're done with your reference to the object, especially if you're going to free the memory. Otherwise, you may erroneously get something overwritten.

See also:: registerReference

bool SimObject::registerObject ( )

This must be called if you want to keep the object around. In the rare case that you will delete the object immediately, or don't want to be able to use Sim::findObject to locate it, then you don't need to register it.

registerObject adds the object to the global ID and name dictionaries, after first assigning it a new ID number. It calls onAdd(). If onAdd fails, it unregisters the object and returns false.

If a subclass's onAdd doesn't eventually call SimObject::onAdd(), it will cause an assertion.

bool SimObject::registerObject ( U32 id )

See also:: registerObject()

Parameters:

ID to assign to the object.

bool SimObject::registerObject ( const char * name )

See also:: registerObject()

Parameters:

name

Name to assign to the object.

bool SimObject::registerObject	(	const char *	name,
		U32	id
	)

See also:: registerObject()

Parameters:

	name	Name to assign to the object.
	id	ID to assign to the object.

void SimObject::unregisterObject ( )

Unregister the object from Sim.

This performs several operations:

Sets the removed flag.
Call onRemove()
Clear out notifications.
Remove the object from...
- its group, if any. (via getGroup)
- Sim::gNameDictionary
- Sim::gIDDictionary
Finally, cancel any pending events for this object (as it can't receive them now).

void SimObject::deleteObject ( )

Unregister, mark as deleted, and free the object.

This helper function can be used when you're done with the object and don't want to be bothered with the details of cleaning it up.

SimObjectId SimObject::getId ( ) const [inline]

const char* SimObject::getIdString ( )

U32 SimObject::getType ( ) const [inline]

const char* SimObject::getName ( ) const [inline]

void SimObject::setId ( SimObjectId id )

void SimObject::assignName ( const char * name )

SimGroup* SimObject::getGroup ( ) const [inline]

bool SimObject::isChildOfGroup ( SimGroup * pGroup )

bool SimObject::isProperlyAdded ( ) const [inline]

bool SimObject::isDeleted ( ) const [inline]

bool SimObject::isRemoved ( ) const [inline]

bool SimObject::isLocked ( )

void SimObject::setLocked ( bool b )

bool SimObject::isHidden ( )

Reimplemented in ShapeBase.

void SimObject::setHidden ( bool b )

Reimplemented in ShapeBase.

bool SimObject::addToSet ( SimObjectId )

bool SimObject::addToSet ( const char * )

bool SimObject::removeFromSet ( SimObjectId )

bool SimObject::removeFromSet ( const char * )

virtual bool SimObject::writeField	(	StringTableEntry	fieldname,
		const char *	value
	)			`[virtual]`

Determine whether or not a field should be written.

Parameters:

	fiedname	The name of the field being written.
	value	The value of the field.

virtual void SimObject::write	(	Stream &	stream,
		U32	tabStop,
		U32	flags = `0`
	)			`[virtual]`

Output the TorqueScript to recreate this object.

This calls writeFields internally.

Parameters:

	stream	Stream to output to.
	tabStop	Indentation level for this object.
	flags	If SelectedOnly is passed here, then only objects marked as selected (using setSelected) will output themselves.

Reimplemented in SimSet, and GuiControl.

virtual void SimObject::writeFields	(	Stream &	stream,
		U32	tabStop
	)			`[virtual]`

Write the fields of this object in TorqueScript.

Parameters:

	stream	Stream for output.
	tabStop	Indentation level for the fields.

void SimObject::assignFieldsFrom ( SimObject * obj )

Copy fields from another object onto this one.

Objects must be of same type. Everything from obj will overwrite what's in this object; extra fields in this object will remain.

Parameters:

obj

Object to copy from.

Namespace* SimObject::getNamespace ( ) [inline]

Return the object's namespace.

const char* SimObject::tabComplete	(	const char *	prevText,
		S32	baseLen,
		bool
	)

Get next matching item in namespace.

This wraps a call to Namespace::tabComplete; it gets the next thing in the namespace, given a starting value and a base length of the string. See Namespace::tabComplete for details.

bool SimObject::isSelected ( ) const [inline]