Changes between Version 6 and Version 7 of code/doc/Pickups

Timestamp:

Mar 19, 2010, 6:30:32 PM (15 years ago)

Author:

dafrick

Comment:

—

code/doc/Pickups

@@ -179 +179 @@
 Please be aware, that these three methods are methods registered with Super, meaning, that whenever overloading them, don't forget to call SUPER(MyClass, myMethod);
 
- * a
+ * clone() The clone() method creates a new pickup of the same type as the pickup it is cloned from. So the cloned pickup is not exactly the same, as it doesn't necessarily completely reflect the status of the pickup it is cloned from, but all the parameters and their values, that distinguish different types of this pickup class. It needs to be implemented by every pickup class. And it is best if this is done in a very specific way. Below is shown how:
+{{{
+void MyPickup::clone(OrxonoxClass*& item)
+{
+    if(item == NULL)
+        item = new MyPickup(this);
+        
+    SUPER(MyPickup, clone, item);
+        
+    MyPickup* pickup = dynamic_cast<MyPickup*>(item);
+    // Here you should set all the important parameters (that destinguis the different types of this pickup), e.g.
+    pickup->setSomeParameter(this->getSomeParameter());
+        
+    // You must also initialize the identifier of the new pickup, conveniently this is normally done in a member function called initializeIdentifier() and so just this method is called here.
+    pickup->initializeIdentifier();
+}
+}}}
+ * initializeIdentifier() The initializeIdentifier() method initializes (or more simply put, creates) the PickupIdentifier of the instance of your pickup. Since the important values of the parameters are not yet available in the constructor of your pickup this initializeIdentifier() method must be called as soon as they are available, which normally is in the XMLPort() method, and the clone() method, as seen above. In the initializeIdentifier method you need to register each parameter that is important for the type of your pickup to its identifier, this is normally done as follows:
+{{{
+void Pickup::initializeIdentifier(void)
+{        
+    // If the get method returns a string.
+    std::string val1 = this->getSomeParameter();
+    std::string type1 = "someParameter";
+    this->pickupIdentifier_->addParameter(type1, val1);
+        
+    // If the get method doesn't return a string
+    std::stringstream stream;
+    stream << this->getSomeOtherParameter();
+    std::string type2 = "someOtherParameter";
+    std::string val2 = stream.str();
+    this->pickupIdentifier_->addParameter(type2, val2);
+}
+}}}
+Be aware, this only works for parameters that are simple enough, meaning with pointers for example it will, naturally, not work.
 
 === Making your object pickupable ===
+
+work in progress..