TorqueScript Reference
Public Member Functions | List of all members
SceneObjectSet Class Reference

Inherits SimObject.

Public Member Functions

void add (obj1,...)
 
void bringToFront (object)
 
void callOnChildren (string method, string args...)
 
void clear ()
 
void deleteObjects ()
 
void dumpObjects ()
 
int findObjectByInternalName (string name,[bool searchChildren])
 
int getCount ()
 
int getObject (objIndex)
 
bool isMember (object)
 
void pushToBack (object)
 
void remove (obj1,...)
 
void reorderChild (child1, child2)
 
- Public Member Functions inherited from SimObject
string call (functionName,[args]*)
 
int clone ([bool copyDynamicFields?=false]?)
 
void delete ()
 
void dump ()
 
void dumpClassHierarchy ()
 
const char * getClassName ()
 
string getClassNamespace ()
 
string getDynamicField (index)
 
int getDynamicFieldCount ()
 
string getField (int index)
 
int getFieldCount ()
 
const char * getFieldType (fieldName)
 
const char * getFieldValue (fieldName)
 
int getGroup ()
 
int getId ()
 
string getInternalName ()
 
const char * getName ()
 
string getProgenitorFile ()
 
string getSuperClassNamespace ()
 
int getType ()
 
bool isChildOfGroup ()
 
bool isMemberOfClass (string classname)
 
bool isMethod (const char *methodName)
 
bool isMethod (string method name)
 
bool isTimerActive ()
 
bool save (fileName,[selectedOnly]?)
 
int schedule (time, command,[arg]*)
 
void setClassNamespace ()
 
bool setFieldValue (fieldName, value)
 
void setInternalName (string InternalName)
 
void setName (newName)
 
void setProgenitorFile (file)
 
void setSuperClassNamespace ()
 
bool startTimer (callbackFunction, float timePeriod,[repeat]?)
 
void stopTimer ()
 

Additional Inherited Members

- Static Public Member Functions inherited from SimObject
static S32 QSORT_CALLBACK compareFields (const void *a, const void *b)
 

Member Function Documentation

void 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 bringToFront ( object  )

Brings object to front of set.

Returns
No return value.
void callOnChildren ( string  method,
string  args... 
)

Call a method on all objects contained in the set.

Parameters
methodThe name of the method to call.
argsThe arguments to the method.
Note
This method recurses into all SimSets that are children to the set.
See Also
callOnChildrenNoRecurse
void clear ( )

Clears the SceneObjectSet

Returns
No return value
void deleteObjects ( )

Deletes all the objects in the SceneObjectSet.

Returns
No return value
void dumpObjects ( )

Dumps the object data within the set

Returns
No return value
int findObjectByInternalName ( string  name)

Returns the object with given internal name

Parameters
nameThe internal name of the object you wish to find
searchChildrenSet this true if you wish to search all children as well.
Returns
Returns the ID of the object.
int getCount ( )
Returns
Returns the number of objects in the SceneObjectSet
int getObject ( objIndex  )
Returns
Returns the ID of the desired object or -1 on failure
bool isMember ( object  )
Returns
Returns true if specified object is a member of the set, and false otherwise
void pushToBack ( object  )

Sends item to back of set.

Returns
No return value.
void 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 reorderChild ( child1  ,
child2   
)

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

Parameters
child1The child you wish to set first
child2The child you wish to set after child1
Returns
No return value.