Changes between Version 2 and Version 3 of code/doc/Identifier

Timestamp:

Feb 24, 2008, 10:52:42 PM (17 years ago)

Author:

landauf

Comment:

—

code/doc/Identifier

@@ -4 +4 @@
 
 The [wiki:Identifier] is a construct to identify the class of an object. All classes derived from OrxonoxClass have an Identifier, representing the class in the running game. The Identifier additionally stores all objects of its class in a [wiki:ObjectList list], knows the name of the class, can have a [wiki:ClassFactory], knows all parents and children, stores [wiki:ConfigValueContainer config-values] and shell-functions and provides several other functionalities.
+
+You can get the Identifier of a given class with the macro Class(classname). You have to include [wiki:CoreIncludes CoreIncludes.h] to use it.
 
 A new class that wants an Identifier must use a macro (!RegisterObject(classname) or !RegisterRootObject(interfacename)) from [wiki:CoreIncludes]. Read the related Wiki-page for more informations.
@@ -14 +16 @@
 
 == Functions ==
+
+ * '''Macro''': (Include [wiki:CoreIncludes CoreIncludes.h] to use this)
+   * Identifier* myidentifier = Class(BaseObject);
 
  * '''Comparison''':
@@ -37 +42 @@
 == Examples ==
 
+The following examples use the class-tree below.
+
+{{{
+#!cpp
+Identifier* myidentifier = Class(A1);            // Assigns the Identifier of A1
+
+myidentifier->isA(Class(BaseObject));            // returns true
+myidentifier->isA(Class(A1));                    // returns true
+myidentifier->isA(Class(A1B1));                  // returns false
+myidentifier->isA(Class(A2));                    // returns false
+Class(A3)->isA(Class(Interface1));               // returns true
+
+Class(A1B1)->isChildOf(Class(BaseObject));       // returns true
+Class(A1B1)->isChildOf(Class(A1));               // returns true
+
+Class(A1B1)->isDirectChildOf(Class(BaseObject)); // returns false
+Class(A1B1)->isDirectChildOf(Class(A1));         // returns true
+}}}
+
+{{{
+#!cpp
+// Creates a new instance of A1
+BaseObject* newobject = Class(A1)->fabricate();
+
+// Creates a new instance of A1 and casts it to Interface1
+Identifier* myidentifier = Class(A3);
+Interface1* newobject = (Interface1)(myidentifier->fabricate());
+}}}
+
+{{{
+#!cpp
+Identifier* myidentifier = Class(BaseObject);
+for (std::list<const Identifier*>::const_iterator it = myidentifier->getDirectParentsBegin(); it != myidentifier->getDirectParentsEnd(); ++it)
+  cout << (*it)->getName() << std::endl;
+
+/*
+returns:
+A1
+A2
+A3
+*/
+}}}
+
+[[Image(Core:testclass_interface_tree.gif)]]
+
 == Networking ==