VObject
Public Attributes
Public Functions
void
clear()
Detaches and deletes all of the child objects.
int
getCount()
Get the number of child objects.
int
getIndex()
Get the index of this object relative to its siblings.
int
getObject(int index)
Get the object corresponding to the given index.
int
Get the parent object.
int
getRoot()
Get the root object.
bool
readFile(String fileName)
Clears the object and loads the new data from the given filename.
void
removeObject(SimObject simObj)
Remove the target object from this node.
void
setLabelUnique(String label)
Force this label to be unique.
bool
writeFile(String fileName)
Save to a given filename.
Detailed Description
UNDOCUMENTED!
Public Attributes
bool Enabled
Enable or Disable the object from playback.
string Label
The label this object is referenced by.
Public Functions
addObject(SimObject simObj)
Add a child object to this node.
Parameters:
pObject | The SimObjectID of the object to be added to this node. |
No return value.
clear()
Detaches and deletes all of the child objects.
No return value.
getCount()
Get the number of child objects.
Returns the number of child objects.
getIndex()
Get the index of this object relative to its siblings.
Returns the index of this object.
getObject(int index)
Get the object corresponding to the given index.
Parameters:
pIndex | The index of the object you wish to retrieve. |
Returns the SimObjectID for the object.
getParent()
Get the parent object.
Returns the SimObjectId for the parent object.
getRoot()
Get the root object.
Returns the SimObjectId for the root object.
readFile(String fileName)
Clears the object and loads the new data from the given filename.
Parameters:
pFileName | The target file to read from. |
Returns true if the read was successful.
removeObject(SimObject simObj)
Remove the target object from this node.
Parameters:
pObject | The SimObjectID of the object to be removed from this node. |
No return value.
setLabelUnique(String label)
Force this label to be unique.
Parameters:
pLabel | The name you wish to reference this object by. |
No return value.
writeFile(String fileName)
Save to a given filename.
Parameters:
pFileName | The target file to write to. |
Returns true if the write was successful.