Inherits SimObject, and SimObject.

Inherited by GroupedSceneController, and GroupedSceneController.

Methods
void	add (obj1,...)

void	add (obj1,...)

void	bringToFront (object)

void	bringToFront (object)

void	callOnChildren (string method, string args...)

void	callOnChildren (string method, string args...)

void	clear ()

void	clear ()

void	deleteObjects ()

void	deleteObjects ()

void	dumpObjects ()

void	dumpObjects ()

int	findObjectByInternalName (string name,[bool searchChildren])

int	findObjectByInternalName (string name,[bool searchChildren])

int	getCount ()

int	getCount ()

int	getObject (objIndex)

int	getObject (objIndex)

bool	isMember (object)

bool	isMember (object)

void	pushToBack (object)

void	pushToBack (object)

void	remove (obj1,...)

void	remove (obj1,...)

void	reorderChild (child1, child2)

void	reorderChild (child1, child2)

Methods inherited from SimObject
void	addFieldFilter (fieldName)

void	addFieldFilter (fieldName)

string	call (%args)

string	call (%args)

int	clone ([bool copyDynamicFields?=false])

int	clone ([bool copyDynamicFields?=false])

void	delete ()

void	delete ()

void	dump ()

void	dump ()

void	dumpClassHierarchy ()

void	dumpClassHierarchy ()

string	getClassName ()

string	getClassName ()

string	getClassNamespace ()

string	getClassNamespace ()

string	getDynamicField (index)

string	getDynamicField (index)

int	getDynamicFieldCount ()

int	getDynamicFieldCount ()

string	getField (int index)

string	getField (int index)

int	getFieldCount ()

int	getFieldCount ()

string	getFieldType (fieldName)

string	getFieldType (fieldName)

string	getFieldValue (fieldName)

string	getFieldValue (fieldName)

int	getGroup ()

int	getGroup ()

int	getId ()

int	getId ()

string	getInternalName ()

string	getInternalName ()

string	getName ()

string	getName ()

string	getProgenitorFile ()

string	getProgenitorFile ()

string	getSuperClassNamespace ()

string	getSuperClassNamespace ()

int	getType ()

int	getType ()

bool	isChildOfGroup ()

bool	isChildOfGroup ()

bool	isMemberOfClass (string classname)

bool	isMemberOfClass (string classname)

bool	isMethod (string method name)

bool	isMethod (string method name)

bool	isTimerActive ()

bool	isTimerActive ()

void	removeFieldFilter (fieldName)

void	removeFieldFilter (fieldName)

bool	save (fileName,[selectedOnly])

bool	save (fileName,[selectedOnly])

int	schedule (time, command,< arg1...argN >)

int	schedule (time, command,< arg1...argN >)

void	setClassNamespace ()

void	setClassNamespace ()

bool	setFieldValue (fieldName, value)

bool	setFieldValue (fieldName, value)

void	setInternalName ()

void	setInternalName ()

void	setName (newName)

void	setName (newName)

void	setProgenitorFile (file)

void	setProgenitorFile (file)

void	setSuperClassNamespace ()

void	setSuperClassNamespace ()

bool	startTimer (callbackFunction, float timePeriod,[repeat])

bool	startTimer (callbackFunction, float timePeriod,[repeat])

void	stopTimer ()

void	stopTimer ()

Fields
SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

void SceneObjectSet::add	(	obj1	,
			...
	)

Adds given list of objects to the SceneObjectSet.

Parameters

obj_i (i is unilimited) Variable list of objects to add

Returns: No return value

void SceneObjectSet::add	(	obj1	,
			...
	)

Adds given list of objects to the SceneObjectSet.

Parameters

obj_i (i is unilimited) Variable list of objects to add

Returns: No return value

void SceneObjectSet::bringToFront ( object )

Brings object to front of set.

Returns: No return value.

void SceneObjectSet::bringToFront ( object )

Brings object to front of set.

Returns: No return value.

void SceneObjectSet::callOnChildren	(	string	method,
		string	args...
	)

Call a method on all objects contained in the set.

Parameters

method	The name of the method to call.
args	The arguments to the method.

Note: This method recurses into all SimSets that are children to the set.

See Also: callOnChildrenNoRecurse

void SceneObjectSet::callOnChildren	(	string	method,
		string	args...
	)

Call a method on all objects contained in the set.

Parameters

method	The name of the method to call.
args	The arguments to the method.

Note: This method recurses into all SimSets that are children to the set.

See Also: callOnChildrenNoRecurse

void SceneObjectSet::clear ( )

Clears the SceneObjectSet

Returns: No return value

void SceneObjectSet::clear ( )

Clears the SceneObjectSet

Returns: No return value

void SceneObjectSet::deleteObjects ( )

Deletes all the objects in the SceneObjectSet.

Returns: No return value

void SceneObjectSet::deleteObjects ( )

Deletes all the objects in the SceneObjectSet.

Returns: No return value

void SceneObjectSet::dumpObjects ( )

Dumps the object data within the set

Returns: No return value

void SceneObjectSet::dumpObjects ( )

Dumps the object data within the set

Returns: No return value

int SceneObjectSet::findObjectByInternalName ( string name )

Returns the object with given internal name

Parameters

name	The internal name of the object you wish to find
searchChildren	Set this true if you wish to search all children as well.

Returns: Returns the ID of the object.

int SceneObjectSet::findObjectByInternalName ( string name )

Returns the object with given internal name

Parameters

name	The internal name of the object you wish to find
searchChildren	Set this true if you wish to search all children as well.

Returns: Returns the ID of the object.

int SceneObjectSet::getCount ( )

Returns: Returns the number of objects in the SceneObjectSet

int SceneObjectSet::getCount ( )

Returns: Returns the number of objects in the SceneObjectSet

int SceneObjectSet::getObject ( objIndex )

Returns: Returns the ID of the desired object or -1 on failure

int SceneObjectSet::getObject ( objIndex )

Returns: Returns the ID of the desired object or -1 on failure

bool SceneObjectSet::isMember ( object )

Returns: Returns true if specified object is a member of the set, and false otherwise

bool SceneObjectSet::isMember ( object )

Returns: Returns true if specified object is a member of the set, and false otherwise

void SceneObjectSet::pushToBack ( object )

Sends item to back of set.

Returns: No return value.

void SceneObjectSet::pushToBack ( object )

Sends item to back of set.

Returns: No return value.

void SceneObjectSet::remove	(	obj1	,
			...
	)

Removes given listy of objects from the SceneObjectSet.

Parameters

obj_i (i is unilimited) Variable list of objects to remove

Returns: No return value

void SceneObjectSet::remove	(	obj1	,
			...
	)

Removes given listy of objects from the SceneObjectSet.

Parameters

obj_i (i is unilimited) Variable list of objects to remove

Returns: No return value

void SceneObjectSet::reorderChild	(	child1	,
		child2
	)

Uses SceneObjectSet reorder to push child 1 before child 2 - both must already be child controls of this control

Parameters

child1	The child you wish to set first
child2	The child you wish to set after child1

Returns: No return value.

void SceneObjectSet::reorderChild	(	child1	,
		child2
	)

Uses SceneObjectSet reorder to push child 1 before child 2 - both must already be child controls of this control

Parameters

child1	The child you wish to set first
child2	The child you wish to set after child1

Returns: No return value.

Member Data Documentation

bool SceneObjectSet::canSaveDynamicFields

string SceneObjectSet::class

Script SuperClass of object.

string SceneObjectSet::internalName

SimObjectPtr SceneObjectSet::parentGroup

Group hierarchy parent of the object.

string SceneObjectSet::superclass

Script Class of object.