Changes between Version 69 and Version 70 of pps/tutorial

Timestamp:

Oct 3, 2016, 4:34:06 PM (8 years ago)

Author:

zifloria

Comment:

—

pps/tutorial

@@ -12 +12 @@
 
 == Before you start coding ==
-Before you start coding there's one [wiki:howto/XMLPort page] which is extremely useful for the following tasks. You might want to have a look at it.
+Before you start coding there's one [wiki:howto/XMLPort page] which is extremely useful for the following tasks. You might want to have it open in the background.
 
 == The task ==
@@ -21 +21 @@
 The implementation of our drone will happen in three steps:
  * '''The AutonomousDrone:''' Core C++ code for the AutonomousDrone class, contains the C++ ↔  XML interface
+ * '''The XML part:''' An instantiation in the level file
  * '''The AutonomousDroneController:''' Controller C++ code to steer the drone
- * '''The XML part:''' An instantiation in the level file
 
 == The AutonomousDrone ==
@@ -65 +65 @@
 to add some code to the XMLPort function. There is already an example for the ''primaryThrust_'' variable. 
 
-4. Inside XMLPort, add similar calls for ''auxiliaryThrust_'' and ''rotationThrust_'' using the following scheme:
+ 4. Inside XMLPort, add similar calls for ''auxiliaryThrust_'' and ''rotationThrust_'' using the following scheme:
 
 {{{
@@ -82 +82 @@
  * Is the classname that you specified for ''RegisterClass(Classname)'' and ''RegisterObject(Classname)'' correct? If it is either ''Classname'', ''ClassX'' or ''ClassXY'', then it is incorrect, try to think about what it should be. If you can't find the solution ask one of the assistants.
  * Have you created 2 set-functions and 2 get-functions for the two variables ''auxiliaryThrust_'' and ''rotationThrust_''?
+ * Did you edit the ''CMakeList.txt'' file?
 
-== The AutonomousDroneController ==
-Now you will finish the AutonomousDroneController which gets called each tick and steers the drone using the functionality of movement in the game world that the drone provides. i.e. the drone's intelligence.
-
- 1. Open the file ''AutonomousDroneController.cc'' and look at it (''src/orxonox/controllers/'').
- 2. Have a look at the constructor and make sure nothing is missing (think of the what we did for the AutonomousDrone).
- 3. Now look at the ''tick'' function. It gets called each time before a new frame is drawn. you can put in some steering code here. If you want you can use some functions provided by Math.h:
-{{{
-rnd() // Return a random value between 0 and 1
-sin() // Should be clear (also cos)
-// Many other functions (have a look at src/util/Math.h for details)
-}}}
- 4. Repeat step 5 (CMakeLists) of the AutonomousDrone for the AutonomousDroneController.
-
-Again if you have been having '''problems''' consider the following suggestions:
- * Did you register the object and create a factory for it? If not or you don't know what this means, have a look at steps 2 and 3 of the AutonomousDrone and think about how this applies to the AutonomousDroneController.
 
 == The XML Part ==
-As a last step we will include the drone in our level and add the visual part of the drone, the model (and some other stuff, too).
+Next we will include the drone in our level and add the visual part of the drone, the model.
 
-Now that you finished the classes you can recompile the project. This is again done by typing in the console:
-{{{
-make -j3
-}}}
-
-Afterwards open the level file:
- 1. Open ''tutorial/data/levels/tutorial.oxw''.
+Open the level file:
+ 1. Open ''trunk/data/levels/tutorial.oxw''.
  2. We want to add a drone to the level now, so put in an entry for it (below the comment that tells you to do so). Look at this example:
 {{{
@@ -142 +123 @@
  }}}
 
- 7. The controller would normally be added to the AutonomousDrone in XML, but as we're currently updating 
- the framework, we need to add this outside the AutonomousDrone. Add these two lines below the AutonomousDrone
- entry above:
+ 7. Test it! E.g. start the game, open the level ''Coding tutorial'' and you should be able to see the drone.
+
+It's a bit boring, as it doesn't move yet. This is the job of the controller.
+
+
+== The AutonomousDroneController ==
+Now you will finish the AutonomousDroneController which gets called each tick and steers the drone using the functionality of movement in the game world that the drone provides. i.e. the drone's intelligence.
+
+ 1. Open the file ''AutonomousDroneController.cc'' and look at it (''src/orxonox/controllers/'').
+ 2. Have a look at the constructor and make sure nothing is missing (think of the what we did for the AutonomousDrone).
+ 3. Now look at the ''tick'' function. It gets called each time before a new frame is drawn. you can put in some steering code here (for instance by using the moveFrontBack function). If you want you can use some functions provided by Math.h:
+{{{
+rnd() // Return a random value between 0 and 1
+sin() // Should be clear (also cos)
+// Many other functions (have a look at src/util/Math.h for details)
+}}}
+ 4. Repeat step 5 (CMakeLists) of the AutonomousDrone for the AutonomousDroneController.
+
+ 5. Compile it.
+
+{{{
+make -j3
+}}}
+
+Again if you have been having '''problems''' consider the following suggestions:
+ * Did you edit the correct CMakeList.txt?
+ * Did you register the object and create a factory for it? If not or you don't know what this means, have a look at steps 2 and 3 of the AutonomousDrone and think about how this applies to the AutonomousDroneController.
+
+
+  6. To see any change, you need to edit the level file again.
+  To do that, add these two lines below the AutonomousDrone (or anywhere in between the scene tags):
  {{{
  <AutonomousDroneController>
@@ -150 +159 @@
  }}}
 
+
 == Have a look at your AutonomousDrone ==
- - Now recompile the code, start the game again and have a look at how your drone behaves.
+ - Now start the game again and have a look at how your drone behaves.
  - Don't worry if it does not react to your steering commands as expected. Try to modify some things.
  - If you want to do some more things you can try to let the drone fly in circles or helixes.