Object-Oriented Programming in T2D 1.0.0

Download Code File

THIS RESOURCE IS DEPRECATED! Find the new 3.0 version HERE.

Well, here goes. Hopefully this will show exactly how to implement OO in T2D 1.0.0 without giving anyone problems.

It is advised that you back up all the files that require modification in this resource before making any changes. Try to follow the instructions as accurately as possible.

For easier copying and pasting of the code in this resource, do not copy and paste from this web page. Instead, use the attached OOInT2DScriptInstructions.txt file.

Here's the same instructions on this webpage for your quick veiwing conveniance.

In console/compileEval.cc starting on line 1047, replace this code -

if(ns)
                  nsEntry = ns->lookup(fnName);
               else
                  nsEntry = NULL;

with this code -

/////////////////////////////////////
               // CODE MODIFIED BRYAN EDDS
               /////////////////////////////////////
               /*if(ns)
                  nsEntry = ns->lookup(fnName);
               else
                  nsEntry = NULL;*/
               if(ns)
               {
                  nsEntry = ns->lookup(fnName);

                  // while we have not found a function entry...
                  while (!nsEntry)
                  {
                     // while there is a parent, set ns = to it, and try 
                     // looking up the function again
                     if (ns->mParent)
                     {
                        ns = ns->mParent;
                        nsEntry = ns->lookup(fnName);
                     }
                     // if there are no more parents to search, the function
                     // cannot be found
                     else
                     {
                        nsEntry = NULL;
                        break;
                     }
                  }
               }
               else
               {
                  nsEntry = NULL;
               }
               /////////////////////////////////////
               // END CODE MODIFIED BRYAN EDDS
               /////////////////////////////////////

In console/simBase.cc directly after this line of code on line 201 -

mFieldDictionary = NULL;

insert this code on a new line -

/////////////////////////////////////
   // CODE INSERTED BY BRYAN EDDS
   /////////////////////////////////////
   mClassName = "";
   mSuperClassName = "";
   /////////////////////////////////////
   // END CODE INSERTED BY BRYAN EDDS
   /////////////////////////////////////

In the same file after this line of code on line 803 -

mNameSpace = getClassRep()->getNameSpace();

insert this code on a new line -

/////////////////////////////////////
   // CODE INSERTED BY BRYAN EDDS 
   // AND HAROLD "LABRAT" BROWN
   /////////////////////////////////////

   // parent = C++ Class StringTableEntry
   StringTableEntry parent = getClassRep()->getNameSpace()->mName;

   // objectName = name of instance
   StringTableEntry objectName = getName();

   // here we'll make sure that the instance name is not the same as
   // the classname, superclassname, or parent name. If it is, we'll con-
   // catenate the word "Instance" to the end of the name.
   if(objectName)
   {
      if(mClassName)
      {
         if(dStricmp(mClassName, objectName) == 0)
         {
            int chars = 0;
            while(objectName[chars] != 0) ++chars;

            char * tempStr = new char[chars + 10];
            dStrcpy(tempStr, objectName);
            tempStr = dStrcat(tempStr, "Instance");
            objectName = StringTable->insert(tempStr);

            delete [] tempStr;
         }
      }

      if(mSuperClassName)
      {
         if(dStricmp(mSuperClassName, objectName) == 0)
         {
            int chars = 0;
            while(objectName[chars] != 0) ++chars;

            char * tempStr = new char[chars + 10];
            dStrcpy(tempStr, objectName);
            tempStr = dStrcat(tempStr, "Instance");
            objectName = StringTable->insert(tempStr);

            delete [] tempStr;
         }
      }

      if(parent)
      {
         if(dStricmp(parent, objectName) == 0)
         {
            int chars = 0;
            while(objectName[chars] != 0) ++chars;

            char * tempStr = new char[chars + 10];
            dStrcpy(tempStr, objectName);
            tempStr = dStrcat(tempStr, "Instance");
            objectName = StringTable->insert(tempStr);

            delete [] tempStr;
         }
      }
   }
   
   // it's possible that all the namespace links can fail if
   // multiple objects are named the same thing with different script
   // hierarchies.
   // linkNamespaces will now return false and echo an error message
   // rather than asserting.
   
   // if superClass was used then change parent to the proper NameSpace
   // else leave parent = "SimObject"
   if(mSuperClassName && mSuperClassName[0])
   {  
      // walk = SuperClass's NameSpace
      Namespace *walk = Con::lookupNamespace(mSuperClassName);

      // prnt = "SimObject" NameSpace
      Namespace *prnt = Con::lookupNamespace(parent);

      // insert the SuperClass Namespace into the StringTable
      StringTableEntry mName = StringTable->insert(mSuperClassName);

      // walk = its parent if walk has a parent and it is SuperClass 
      while(walk->mParent && walk->mParent->mName == mName)
      walk = walk->mParent;

      // if walk has a parent, and its parent is not "SimObject",
      // then parent = "SuperClass" StringTableEntry
      if(walk->mParent && walk->mParent != prnt)
         parent = mSuperClassName;

      // if walk doesn't have a parent or its parent is not SimObject
      // link parent and SuperClass StringTableEntries
      // if link is successful, parent = SuperClass StringTableEntry
      else {
         if(Con::linkNamespaces(parent, mSuperClassName))
            parent = mSuperClassName;
      }
   }
      
   // className -> superClassName

   // if class was used then change parent to the proper NameSpace
   // else leave parent = "SimObject"
   if (mClassName && mClassName[0])
   {
      // walk = Class NameSpace
      Namespace *walk = Con::lookupNamespace(mClassName);

      // prnt = parent NameSpace
      Namespace *prnt = Con::lookupNamespace(parent);

      // mName = Class StringTable
      StringTableEntry mName = StringTable->insert(mClassName);

      // walk = its parent while
      // it has a parent and its parent's name = Class StringTable
      while(walk->mParent && walk->mParent->mName == mName)
         walk = walk->mParent;

      // if walk has a parent and it is not the parent NameSpace
      // then parent = Class StringTableEntry
      if(walk->mParent && walk->mParent != prnt)
         parent=mClassName;
      // else if walk has no parent or parent is the parent NameSpace
      // then link the parent and Class StringTableEntries
      // if the link was successful, parent = Class StringTableEntry
      else {
         if(Con::linkNamespaces(parent, mClassName))
            parent = mClassName;
      }
   }

   // objectName -> className

   // if name of this instance exists
   // link parent and objectName StringTableEntries
   // if link is success, parent = objectName
   if (objectName && objectName[0])
      if(Con::linkNamespaces(parent, objectName))
         parent = objectName;

   // Store our namespace
   mNameSpace = Con::lookupNamespace(parent);   

   /////////////////////////////////////
   // END CODE INSERTED BY BRYAN EDDS 
   // AND HAROLD "LABRAT" BROWN
   /////////////////////////////////////

In the same file after this line of code SOMEWHERE AROUND line 1103 (sorry, I lost track)-

Parent::initPersistFields();

insert this code on a new line -

/////////////////////////////////////
   // CODE INSERTED BY BRYAN EDDS
   /////////////////////////////////////
   addGroup("Classes", "Sim objects have the ability to inherit and have class information.");
   addField("className", TypeString, Offset(mClassName, SimObject), "Class of object.");
   addField("superClassName", TypeString, Offset(mSuperClassName, SimObject), "Superclass of object.");

   // members "class" and "superClass" are retained to be backward compatible
   // ScriptObject. Rather icky, but better than the alternative...
   addField("class", TypeString, Offset(mClassName, SimObject), "Class of object.");
   addField("superClass", TypeString, Offset(mSuperClassName, SimObject), "Superclass of object.");
   
   endGroup("Classes");
   /////////////////////////////////////
   // END CODE INSERTED BY BRYAN EDDS
   /////////////////////////////////////

In the same file, on the very last line, insert this code -

/////////////////////////////////////
// CODE INSERTED BY BRYAN EDDS
/////////////////////////////////////
ConsoleFunction(link, void, 4, 4, "(string class, string superClass, string parent)")
{
   argc;

   StringTableEntry className;
   StringTableEntry superClassName;
   StringTableEntry parent;

   if(argv[1] && argv[1][0])
      className = StringTable->insert(argv[1]);

   if(argv[2] && argv[2][0])
      superClassName = StringTable->insert(argv[2]);

   if(argv[3] && argv[3][0])
      parent = StringTable->insert(argv[3]);
   
   // parent = C++ Class StringTableEntry
   //StringTableEntry parent = getClassRep()->getNameSpace()->mName;
   
   // it's possible that all the namespace links can fail, if
   // multiple objects are named the same thing with different script
   // hierarchies.
   // linkNamespaces will now return false and echo an error message
   // rather than asserting.
   
   // if superClass was used then change parent to the proper NameSpace
   // else leave parent = "SimObject"
   if(superClassName && superClassName[0])
   {  
      // walk = SuperClass's NameSpace
      Namespace *walk = Con::lookupNamespace(superClassName);

      // prnt = "SimObject" NameSpace
      Namespace *prnt = Con::lookupNamespace(parent);

      // mName = superClassName
      StringTableEntry mName = superClassName;

      // walk = its parent if walk has a parent and it is SuperClass 
      while(walk->mParent && walk->mParent->mName == mName)
      walk = walk->mParent;

      // if walk has a parent, and its parent is not "SimObject",
      // then parent = "SuperClass" StringTableEntry
      if(walk->mParent && walk->mParent != prnt)
         parent = superClassName;

      // if walk doesn't have a parent or its parent is not SimObject
      // link parent and SuperClass StringTableEntries
      // if link is successful, parent = SuperClass StringTableEntry
      else {
         if(Con::linkNamespaces(parent, superClassName))
            parent = superClassName;
      }
   }
      
   // className -> superClassName

   // if class was used then change parent to the proper NameSpace
   // else leave parent = "SimObject"
   if (className && className[0])
   {
      // walk = Class NameSpace
      Namespace *walk = Con::lookupNamespace(className);

      // prnt = parent NameSpace
      Namespace *prnt = Con::lookupNamespace(parent);

      // mName = Class StringTable
      StringTableEntry mName = className;

      // walk = its parent while
      // it has a parent and its parent's name = Class StringTable
      while(walk->mParent && walk->mParent->mName == mName)
         walk = walk->mParent;

      // if walk has a parent and it is not the parent NameSpace
      // then parent = Class StringTableEntry
      if(walk->mParent && walk->mParent != prnt)
         parent=className;
      // else if walk has no parent or parent is the parent NameSpace
      // then link the parent and Class StringTableEntries
      // if the link was successful, parent = Class StringTableEntry
      else {
         if(Con::linkNamespaces(parent, className))
            parent = className;
      }
   }
}
/////////////////////////////////////
// END CODE INSERTED BY BRYAN EDDS
/////////////////////////////////////

In the file console/scriptObject.cc starting on line 17, replace this code -

StringTableEntry mClassName;
   StringTableEntry mSuperClassName;

with this code -

/////////////////////////////////////
   // CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////
   /*StringTableEntry mClassName;
   StringTableEntry mSuperClassName;*/
   /////////////////////////////////////
   // END CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////

In the same file on line 26, replace this line of code -

ScriptObject();

with this code -

/////////////////////////////////////
   // CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////
   /*ScriptObject();*/
   /////////////////////////////////////
   // END CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////

In the same file starting on line 45, replace this code -

addGroup("Classes", "Script objects have the ability to inherit and have class information.");
   addField("class", TypeString, Offset(mClassName, ScriptObject), "Class of object.");
   addField("superClass", TypeString, Offset(mSuperClassName, ScriptObject), "Superclass of object.");
   endGroup("Classes");

with this code -

/////////////////////////////////////
   // CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////
   /*addGroup("Classes", "Script objects have the ability to inherit and have class information.");
   addField("class", TypeString, Offset(mClassName, ScriptObject), "Class of object.");
   addField("superClass", TypeString, Offset(mSuperClassName, ScriptObject), "Superclass of object.");
   endGroup("Classes");*/
   Parent::initPersistFields();
   /////////////////////////////////////
   // END CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////

In the same file starting on line 58, replace this code -

ScriptObject::ScriptObject()
{
   mClassName = "";
   mSuperClassName = "";
}

with this code -

/////////////////////////////////////
// CODE MODIFIED BY BRYAN EDDS
/////////////////////////////////////
/*ScriptObject::ScriptObject()
{
   mClassName = "";
   mSuperClassName = "";
}*/
/////////////////////////////////////
// END CODE MODIFIED BY BRYAN EDDS
/////////////////////////////////////

In the same file starting on line 75, replace this code -

// it's possible that all the namespace links can fail, if
   // multiple objects are named the same thing with different script
   // hierarchies.
   // linkNamespaces will now return false and echo an error message
   // rather than asserting.
     
   // superClassName -> ScriptObject
   StringTableEntry parent = StringTable->insert("ScriptObject");
   if(mSuperClassName[0])
   {
      if(Con::linkNamespaces(parent, mSuperClassName))
         parent = mSuperClassName;
   }
      
   // className -> superClassName
   if (mClassName[0])
   {
      if(Con::linkNamespaces(parent, mClassName))
         parent = mClassName;
   }

   // objectName -> className
   StringTableEntry objectName = getName();
   if (objectName && objectName[0])
   {
      if(Con::linkNamespaces(parent, objectName))
         parent = objectName;
   }

   // Store our namespace
   mNameSpace = Con::lookupNamespace(parent);

with this code -

/////////////////////////////////////
   // CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////
   /*// it's possible that all the namespace links can fail, if
   // multiple objects are named the same thing with different script
   // hierarchies.
   // linkNamespaces will now return false and echo an error message
   // rather than asserting.
     
   // superClassName -> ScriptObject
   StringTableEntry parent = StringTable->insert("ScriptObject");
   if(mSuperClassName[0])
   {
      if(Con::linkNamespaces(parent, mSuperClassName))
         parent = mSuperClassName;
   }
      
   // className -> superClassName
   if (mClassName[0])
   {
      if(Con::linkNamespaces(parent, mClassName))
         parent = mClassName;
   }

   // objectName -> className
   StringTableEntry objectName = getName();
   if (objectName && objectName[0])
   {
      if(Con::linkNamespaces(parent, objectName))
         parent = objectName;
   }

   // Store our namespace
   mNameSpace = Con::lookupNamespace(parent);*/
   /////////////////////////////////////
   // END CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////

In the file console/simBase.h after this line of code on line 449 -

SimObject*       nextIdObject;

insert this code on a new line -

/////////////////////////////////////
   // CODE INSERTED BY BRYAN EDDS
   /////////////////////////////////////
   StringTableEntry mClassName;
   StringTableEntry mSuperClassName;
   /////////////////////////////////////
   // END CODE INSERTED BY BRYAN EDDS
   /////////////////////////////////////

In the file gui/guiControl.cc starting on line 56, replace this code -

const char *name = getName();
   if(name && name[0] && getClassRep())
   {    
      Namespace *parent = getClassRep()->getNameSpace();
      if(Con::linkNamespaces(parent->mName, name))
         mNameSpace = Con::lookupNamespace(name);
   }

with this code -

/////////////////////////////////////
   // CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////
   /*const char *name = getName();
   if(name && name[0] && getClassRep())
   {    
      Namespace *parent = getClassRep()->getNameSpace();
      if(Con::linkNamespaces(parent->mName, name))
         mNameSpace = Con::lookupNamespace(name);
   }*/
   /////////////////////////////////////
   // END CODE MODIFIED BY BRYAN EDDS
   /////////////////////////////////////

Now compile.

It is critical that you read and study the file that is attached to this resource call tsoo.cs. This is a script file that can be executed from the console which shows and explains many of the features of OO in T2D script in an example. Once you absorb the knowledge in that document, you'll be on your way to making object-oriented T2D classes and datablocks in no time.

Final Note: If anyone has any problems or I have gotten any line numbers wrong, please don't hesitate to tell me by e-mailing me at the e-mail address specified in my profile.

Thanks for trying out my OO-in-T2D-script extension resource.