|
| SimSet () |
|
| ~SimSet () |
|
virtual void | onRemove () |
| Called when the object is removed from the sim. More...
|
|
virtual void | onDeleteNotify (SimObject *object) |
|
virtual U32 | getTamlChildCount (void) const |
| Called when Taml attempts to compile a list of children. More...
|
|
virtual SimObject * | getTamlChild (const U32 childIndex) const |
| Called when Taml attempts to compile a list of children. More...
|
|
virtual void | addTamlChild (SimObject *pSimObject) |
| Called when Taml attempts to populate an objects children during a read. More...
|
|
void | callOnChildren (const char *method, S32 argc, const char *argv[], bool executeOnChildGroups=true) |
|
virtual void | write (Stream &stream, U32 tabStop, U32 flags=0) |
|
virtual SimObject * | findObject (const char *name) |
|
SimObject * | findObjectByInternalName (const char *internalName, bool searchChildren=false) |
|
virtual bool | writeObject (Stream *stream) |
|
virtual bool | readObject (Stream *stream) |
|
void | lock () |
|
void | unlock () |
|
| DECLARE_CONOBJECT (SimSet) |
|
void | _setVectorAssoc (const char *file, const U32 line) |
|
|
virtual void | addObject (SimObject *) |
| Add an object to the set. More...
|
|
virtual void | removeObject (SimObject *) |
| Remove an object from the set. More...
|
|
virtual void | pushObject (SimObject *) |
|
virtual void | popObject () |
| Remove an object from the end of the list. More...
|
|
void | bringObjectToFront (SimObject *obj) |
|
void | pushObjectToBack (SimObject *obj) |
|
StringTableEntry | getClassNamespace () const |
|
StringTableEntry | getSuperClassNamespace () const |
|
void | setClassNamespace (const char *classNamespace) |
|
void | setSuperClassNamespace (const char *superClassNamespace) |
|
void | pushScriptCallbackGuard (void) |
|
void | popScriptCallbackGuard (void) |
|
S32 | getScriptCallbackGuard (void) |
|
Namespace * | getNamespace () |
| Return the object's namespace. More...
|
|
const char * | tabComplete (const char *prevText, S32 baseLen, bool) |
|
virtual void | dump () |
|
virtual void | dumpClassHierarchy () |
|
SimObject * | clone (const bool copyDynamicFields) |
|
virtual void | copyTo (SimObject *object) |
|
template<typename T > |
bool | isType (void) |
|
virtual bool | handlesConsoleMethod (const char *fname, S32 *routingId) |
|
| DECLARE_CONOBJECT (SimObject) |
|
Notify * | removeNotify (void *ptr, Notify::Type) |
| Remove a notification from the list. More...
|
|
void | deleteNotify (SimObject *obj) |
| Notify an object when we are deleted. More...
|
|
void | clearNotify (SimObject *obj) |
| Notify an object when we are cleared. More...
|
|
void | clearAllNotifications () |
| Remove all notifications for this object. More...
|
|
void | processDeleteNotifies () |
| Send out deletion notifications. More...
|
|
void | registerReference (SimObject **obj) |
|
void | unregisterReference (SimObject **obj) |
|
const char * | getDataField (StringTableEntry slotName, const char *array) |
|
void | setDataField (StringTableEntry slotName, const char *array, const char *value) |
|
const char * | getPrefixedDataField (StringTableEntry fieldName, const char *array) |
|
void | setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value) |
|
const char * | getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1) |
|
void | setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1) |
|
StringTableEntry | getDataFieldPrefix (StringTableEntry fieldName) |
|
U32 | getDataFieldType (StringTableEntry slotName, const char *array) |
|
SimFieldDictionary * | getFieldDictionary () |
|
void | clearDynamicFields (void) |
| Clear all dynamic fields. More...
|
|
void | setCanSaveDynamicFields (bool bCanSave) |
| Set whether fields created at runtime should be saved. Default is true. More...
|
|
bool | getCanSaveDynamicFields (void) const |
| Get whether fields created at runtime should be saved. Default is true. More...
|
|
void | setInternalName (const char *newname) |
|
StringTableEntry | getInternalName () |
| Get the internal of of this control. More...
|
|
virtual bool | save (const char *pcFilePath, bool bOnlySelected=false) |
| Save object as a TorqueScript File. More...
|
|
virtual bool | isMethod (const char *methodName) |
| Check if a method exists in the objects current namespace. More...
|
|
SimObjectId | getId (void) const |
|
StringTableEntry | getIdString (void) const |
|
U32 | getType () const |
|
const StringTableEntry | getName (void) 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) |
|
void | setProgenitorFile (const char *pFile) |
|
StringTableEntry | getProgenitorFile (void) const |
|
void | setPeriodicTimerID (const S32 timerID) |
|
S32 | getPeriodicTimerID (void) const |
|
bool | isPeriodicTimerActive (void) const |
|
bool | isSelected () const |
|
bool | isExpanded () const |
|
void | setSelected (bool sel) |
|
void | setExpanded (bool exp) |
|
void | setModDynamicFields (bool dyn) |
|
void | setModStaticFields (bool sta) |
|
| SimObject () |
|
virtual | ~SimObject () |
|
virtual bool | processArguments (S32 argc, const char **argv) |
| Process constructor options. (ie, new SimObject(1,2,3)) More...
|
|
virtual bool | onAdd () |
| Called when the object is added to the sim. More...
|
|
virtual void | onGroupAdd () |
| Called when the object is added to a SimGroup. More...
|
|
virtual void | onGroupRemove () |
| Called when the object is removed from a SimGroup. More...
|
|
virtual void | onNameChange (const char *name) |
| Called when the object's name is changed. More...
|
|
virtual void | onStaticModified (const char *slotName, const char *newValue=NULL) |
|
virtual void | inspectPreApply () |
|
virtual void | inspectPostApply () |
|
virtual void | onEditorEnable () |
| Called when the editor is activated. More...
|
|
virtual void | onEditorDisable () |
| Called when the editor is deactivated. More...
|
|
bool | registerObject () |
|
bool | registerObject (U32 id) |
|
bool | registerObject (const char *name) |
|
bool | registerObject (const char *name, U32 id) |
|
void | unregisterObject () |
|
void | deleteObject () |
|
bool | addToSet (SimObjectId) |
|
bool | addToSet (const char *) |
|
bool | removeFromSet (SimObjectId) |
|
bool | removeFromSet (const char *) |
|
virtual bool | writeField (StringTableEntry fieldname, const char *value) |
|
virtual void | writeFields (Stream &stream, U32 tabStop) |
|
virtual void | buildFilterList () |
|
void | addFieldFilter (const char *fieldName) |
|
void | removeFieldFilter (const char *fieldName) |
|
void | clearFieldFilters () |
|
bool | isFiltered (const char *fieldName) |
|
void | assignFieldsFrom (SimObject *obj) |
|
void | assignDynamicFieldsFrom (SimObject *obj) |
|
const AbstractClassRep::Field * | findField (StringTableEntry fieldName) const |
| Get a reference to a field by name. More...
|
|
virtual AbstractClassRep * | getClassRep () const |
| Gets the ClassRep. More...
|
|
bool | setField (const char *fieldName, const char *value) |
| Set the value of a field. More...
|
|
virtual | ~ConsoleObject () |
|
const AbstractClassRep::FieldList & | getFieldList () const |
| Get a list of all the fields. This information cannot be modified. More...
|
|
AbstractClassRep::FieldList & | getModifiableFieldList () |
|
bool & | getDynamicGroupExpand () |
|
S32 | getClassId (U32 netClassGroup) const |
|
const char * | getClassName () const |
|
|
enum | WriteFlags { SelectedOnly = BIT(0)
} |
|
static void | initPersistFields () |
|
static const char * | lookupClassName (const U32 in_classTag) |
| Get the classname from a class tag. More...
|
|
static void | initPersistFields () |
|
static void | consoleInit () |
|
static ConsoleObject * | create (const char *in_pClassName) |
|
static ConsoleObject * | create (const U32 groupId, const U32 typeId, const U32 in_classId) |
|
static AbstractClassRep * | getStaticClassRep () |
| Get the abstract class information for this class. More...
|
|
static AbstractClassRep * | getParentStaticClassRep () |
| Get the abstract class information for this class's superclass. More...
|
|
virtual void | onTamlPreWrite (void) |
| Taml callbacks. More...
|
|
virtual void | onTamlPostWrite (void) |
| Called after Taml has finished writing the object. More...
|
|
virtual void | onTamlPreRead (void) |
| Called prior to Taml reading the object. More...
|
|
virtual void | onTamlPostRead (const TamlCustomNodes &customNodes) |
|
virtual void | onTamlAddParent (SimObject *pParentObject) |
| Called after Taml has finished reading the object and has added the object to any parent. More...
|
|
virtual void | onTamlCustomWrite (TamlCustomNodes &customNodes) |
| Called during the writing of the object to allow custom properties to be written. More...
|
|
virtual void | onTamlCustomRead (const TamlCustomNodes &customNodes) |
| Called during the reading of the object to allow custom properties to be read. More...
|
|
void | linkNamespaces () |
|
void | unlinkNamespaces () |
|
| ConsoleObject () |
|
| ConsoleObject (const ConsoleObject &) |
|
static bool | setClass (void *obj, const char *data) |
|
static bool | setSuperClass (void *obj, const char *data) |
|
static bool | writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName) |
|
static bool | writeInternalName (void *obj, StringTableEntry pFieldName) |
|
static bool | setParentGroup (void *obj, const char *data) |
|
static bool | writeParentGroup (void *obj, StringTableEntry pFieldName) |
|
static bool | writeSuperclass (void *obj, StringTableEntry pFieldName) |
|
static bool | writeClass (void *obj, StringTableEntry pFieldName) |
|
static SimObject::Notify * | allocNotify () |
| Get a free Notify structure. More...
|
|
static void | freeNotify (SimObject::Notify *) |
| Mark a Notify structure as free. More...
|
|
static void | addGroup (const char *in_pGroupname, const char *in_pGroupDocs=NULL) |
|
static void | endGroup (const char *in_pGroupname) |
|
static void | addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL) |
|
static void | addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL) |
|
static void | addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs) |
|
static void | addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char *in_pFieldDocs) |
|
static void | addFieldV (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator *v, const char *in_pFieldDocs=NULL) |
|
static void | addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL) |
|
static void | addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL) |
|
static void | addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char *in_pFieldDocs=NULL) |
|
static void | addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char *in_pFieldDocs=NULL) |
|
static void | addDepricatedField (const char *fieldName) |
|
static bool | removeField (const char *in_pFieldname) |
|
static SimObject::Notify * | mNotifyFreeList = NULL |
|
A set of SimObjects.
It is often necessary to keep track of an arbitrary set of SimObjects. For instance, Torque's networking code needs to not only keep track of the set of objects which need to be ghosted, but also the set of objects which must always be ghosted. It does this by working with two sets. The first of these is the RootGroup (which is actually a SimGroup) and the second is the GhostAlwaysSet, which contains objects which must always be ghosted to the client.
Some general notes on SimSets:
- Membership is not exclusive. A SimObject may be a member of multiple SimSets.
- A SimSet does not destroy subobjects when it is destroyed.
- A SimSet may hold an arbitrary number of objects.
Using SimSets, the code to work with these two sets becomes relatively straightforward:
{
if (nobj)
{
}
}
SimSet* ghostAlwaysSet = Sim::getGhostAlwaysSet();
U32 sz = ghostAlwaysSet->
size();
S32 j;
for(i = ghostAlwaysSet->
begin(); i != ghostAlwaysSet->
end(); i++)
{
}