[Orxonox-commit 6442] r11099 - in code/trunk: doc/api doc/api/groups src/libraries/core src/libraries/core/class src/libraries/core/command src/libraries/core/commandline src/libraries/core/config src/libraries/core/object src/libraries/network src/libraries/tools src/libraries/util src/modules/docking src/modules/gametypes src/modules/hover src/modules/jump src/modules/mini4dgame src/modules/notifications src/modules/objects src/modules/objects/controllers src/modules/objects/triggers src/modules/pickup src/modules/pickup/items src/modules/tetris src/modules/towerdefense src/modules/weapons/projectiles src/modules/weapons/weaponmodes src/orxonox src/orxonox/chat src/orxonox/controllers src/orxonox/gametypes src/orxonox/infos src/orxonox/interfaces src/orxonox/items src/orxonox/overlays src/orxonox/weaponsystem src/orxonox/worldentities src/orxonox/worldentities/pawns
muemart at orxonox.net
muemart at orxonox.net
Wed Jan 27 18:50:52 CET 2016
Author: muemart
Date: 2016-01-27 18:50:51 +0100 (Wed, 27 Jan 2016)
New Revision: 11099
Modified:
code/trunk/doc/api/doxy.config.in
code/trunk/doc/api/groups/Pickup.dox
code/trunk/doc/api/groups/Portals.dox
code/trunk/src/libraries/core/CoreIncludes.h
code/trunk/src/libraries/core/GUIManager.cc
code/trunk/src/libraries/core/class/IdentifierManager.cc
code/trunk/src/libraries/core/command/CommandExecutor.cc
code/trunk/src/libraries/core/command/ConsoleCommandCompilation.cc
code/trunk/src/libraries/core/commandline/CommandLineIncludes.h
code/trunk/src/libraries/core/commandline/CommandLineParser.cc
code/trunk/src/libraries/core/commandline/CommandLineParser.h
code/trunk/src/libraries/core/config/ConfigValueContainer.h
code/trunk/src/libraries/core/object/IteratorBase.h
code/trunk/src/libraries/core/object/ObjectListBase.h
code/trunk/src/libraries/network/MasterServerComm.h
code/trunk/src/libraries/network/ServerList.h
code/trunk/src/libraries/tools/BulletDebugDrawer.cc
code/trunk/src/libraries/tools/BulletDebugDrawer.h
code/trunk/src/libraries/tools/DebugDrawer.cc
code/trunk/src/libraries/tools/DebugDrawer.h
code/trunk/src/libraries/tools/IcoSphere.cc
code/trunk/src/libraries/tools/IcoSphere.h
code/trunk/src/libraries/tools/OgreBulletUtils.h
code/trunk/src/libraries/util/Clock.h
code/trunk/src/libraries/util/Math.cc
code/trunk/src/modules/docking/DockingAnimation.h
code/trunk/src/modules/docking/DockingEffect.h
code/trunk/src/modules/docking/DockingTarget.h
code/trunk/src/modules/docking/MoveToDockingTarget.h
code/trunk/src/modules/gametypes/SpaceRaceController.cc
code/trunk/src/modules/gametypes/SpaceRaceController.h
code/trunk/src/modules/hover/HoverFlag.cc
code/trunk/src/modules/hover/HoverOrigin.h
code/trunk/src/modules/hover/HoverWall.cc
code/trunk/src/modules/jump/JumpEnemy.cc
code/trunk/src/modules/mini4dgame/Mini4DgameBoard.cc
code/trunk/src/modules/notifications/NotificationDispatcher.h
code/trunk/src/modules/notifications/NotificationQueue.cc
code/trunk/src/modules/objects/Script.cc
code/trunk/src/modules/objects/Turret.h
code/trunk/src/modules/objects/controllers/TurretController.h
code/trunk/src/modules/objects/triggers/DistanceTrigger.cc
code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.cc
code/trunk/src/modules/objects/triggers/EventTrigger.cc
code/trunk/src/modules/objects/triggers/MultiTrigger.cc
code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc
code/trunk/src/modules/objects/triggers/Trigger.cc
code/trunk/src/modules/pickup/Pickup.cc
code/trunk/src/modules/pickup/PickupCollection.cc
code/trunk/src/modules/pickup/PickupManager.cc
code/trunk/src/modules/pickup/PickupSpawner.cc
code/trunk/src/modules/pickup/items/DamageBoostPickup.h
code/trunk/src/modules/tetris/TetrisCenterpoint.h
code/trunk/src/modules/towerdefense/TowerDefense.h
code/trunk/src/modules/towerdefense/TowerDefenseCenterpoint.h
code/trunk/src/modules/towerdefense/TowerDefenseEnemy.cc
code/trunk/src/modules/towerdefense/TowerDefenseEnemy.h
code/trunk/src/modules/towerdefense/TowerDefenseField.h
code/trunk/src/modules/towerdefense/TowerDefenseHUDController.h
code/trunk/src/modules/towerdefense/TowerDefenseTower.h
code/trunk/src/modules/weapons/projectiles/BasicProjectile.cc
code/trunk/src/modules/weapons/projectiles/BasicProjectile.h
code/trunk/src/modules/weapons/projectiles/GravityBombField.h
code/trunk/src/modules/weapons/projectiles/SplitGunProjectile.cc
code/trunk/src/modules/weapons/weaponmodes/HsW01.h
code/trunk/src/orxonox/LevelInfo.cc
code/trunk/src/orxonox/LevelInfo.h
code/trunk/src/orxonox/chat/ChatHistory.h
code/trunk/src/orxonox/chat/ChatInputHandler.h
code/trunk/src/orxonox/controllers/ActionpointController.h
code/trunk/src/orxonox/controllers/ArtificialController.cc
code/trunk/src/orxonox/controllers/MasterController.h
code/trunk/src/orxonox/gametypes/Dynamicmatch.cc
code/trunk/src/orxonox/gametypes/Dynamicmatch.h
code/trunk/src/orxonox/infos/GametypeInfo.cc
code/trunk/src/orxonox/interfaces/NotificationListener.cc
code/trunk/src/orxonox/interfaces/PlayerTrigger.h
code/trunk/src/orxonox/items/Engine.h
code/trunk/src/orxonox/items/PartDestructionEvent.cc
code/trunk/src/orxonox/items/PartDestructionEvent.h
code/trunk/src/orxonox/items/ShipPart.cc
code/trunk/src/orxonox/overlays/OrxonoxOverlay.cc
code/trunk/src/orxonox/overlays/OverlayGroup.cc
code/trunk/src/orxonox/weaponsystem/WeaponSlot.h
code/trunk/src/orxonox/weaponsystem/WeaponSystem.cc
code/trunk/src/orxonox/worldentities/Actionpoint.h
code/trunk/src/orxonox/worldentities/WorldEntity.h
code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.cc
code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.h
code/trunk/src/orxonox/worldentities/pawns/Pawn.cc
Log:
Fix loads of doxygen warnings and other documentation issues
Modified: code/trunk/doc/api/doxy.config.in
===================================================================
--- code/trunk/doc/api/doxy.config.in 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/doc/api/doxy.config.in 2016-01-27 17:50:51 UTC (rev 11099)
@@ -882,7 +882,7 @@
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.
-GENERATE_HTMLHELP = YES
+GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
Modified: code/trunk/doc/api/groups/Pickup.dox
===================================================================
--- code/trunk/doc/api/groups/Pickup.dox 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/doc/api/groups/Pickup.dox 2016-01-27 17:50:51 UTC (rev 11099)
@@ -150,6 +150,8 @@
@endcode
@subsection CreatingTheInnerWorkings Creating the inner workings of your pickup
+ @todo This is completely outdated. Someone who knows how pickups work should update this.
+
Now that we have the skeleton of a pickup and we have defined which carriers are allowed to pick our pickup up we are going to take a look at all the methods we can (or sometimes have to) overload from @ref orxonox::Pickupable "Pickupable", for our pickup to work properly. But first I will introduce some more concepts to make the need for these methods more obvious.
- Since one pickup class can by itself be many pickup types, we need a way to find out whether a particular instance of a pickup is of the same type as another instance of a pickup. To that end the @ref orxonox::PickupIdentifier "PickupIdentifier" was created. The @ref orxonox::PickupIdentifier "PickupIdentifier" accounts for the type of class your pickup is of and also for the parameters (and their values) that distinguish different types of pickups of the same class. Much of the functionality of the pickup module relies on this identifier being correct, thus it is very important to initialize it correctly. (We will see, how that is done in a short while.)
- Every @ref orxonox::Pickupable "Pickupable" has at least two states which are very important. The first is, whether the @ref orxonox::Pickupable "Pickupable" is currently in use or not and the second is whether the pickup is currently picked up or not.
Modified: code/trunk/doc/api/groups/Portals.dox
===================================================================
--- code/trunk/doc/api/groups/Portals.dox 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/doc/api/groups/Portals.dox 2016-01-27 17:50:51 UTC (rev 11099)
@@ -58,224 +58,4 @@
- distance (default: 50): distance at which a valid entity gets pulled in (if the end point is an entrance).
- target (default: "Pawn"): the class which is able to enter this end point (if it is an entrance)
- design: the name of the @ref orxonox::Template "design template"
-*/
-
-/**
- @addtogroup Pickup Pickup
- @ingroup Modules
-
- The Pickup module adds a special type of object to Orxonox, the so-called @ref orxonox::Pickupable "Pickupables". @ref orxonox::Pickupable "Pickupables" are objects that can be picked up (by virtually any entity, but commonly by the @ref orxonox::Pawn "Pawn") and have some kind of effect on the entity that picked the @ref orxonox::Pickupable "Pickupable" up.
-
- @section IncludingPickups Including pickups in a level
- @ref orxonox::Pickupable "Pickupables" are designed so that they can be included in levels fairly easily, while also ensuring, that the pickup itself (its game-logic component) and how it is represented (e.g. in the PickupInventory (the GUI that displays @ref orxonox::Pickupable "Pickupables") or in the game) are neatly seperated.
- To be able to use @ref orxonox::Pickupable "Pickupables" in a level one must understand some basic concepts.
- - @ref orxonox::Pickupable "Pickupables" are entities which (by itself) have no physical (or graphical) dimension. The simply represent the effect they will have on a @ref orxonox::PickupCarrier "PickupCarrier" (the entity that can pick up @ref orxonox::Pickupable "Pickupables", @ref orxonox::Pawn "Pawn" for example inherits from @ref orxonox::PickupSpawner "PickupSpawner" and thus is able to pick up and carry @ref orxonox::Pickupable "Pickupables"), when used and the mechanism that leads to that.
- - The physical (or graphical) dimension of a pickup is called a @ref orxonox::PickupRepresentation "PickupRepresentation".
- - The @ref orxonox::PickupRepresentation "PickupRepresentation" of a @ref orxonox::Pickupable "Pickupable" and the @ref orxonox::Pickupable "Pickupable" itself are linked to each other, in such a way that a @ref orxonox::PickupRepresentation "PickupRepresentation" can only represent one type of @ref orxonox::Pickupable "Pickupable".
- - A type of @ref orxonox::Pickupable "Pickupable" is a specific pickup class (inheriting from @ref orxonox::Pickupable "Pickupable") with specific values for all its relevant parameters. This means, that a pickup of the same class with the same values for all parameters except for one is a different type of pickup and will therefore have a different @ref orxonox::PickupRepresentation "PickupRepresentation". Which parameters are the ones relevant to destinguish between two types of pickups can be defined in the class description of the specific pickup.
- - The entity that actually gives a @ref orxonox::Pickupable "Pickupable" to a @ref orxonox::PickupCarrier "PickupCarrier" is called a @ref orxonox::PickupSpawner "PickupSpawner". A @ref orxonox::PickupSpawner "PickupSpawner" creates (based on some parameters) @ref orxonox::Pickupable "Pickupables" which then is picked up by the @ref orxonox::PickupCarrier "PickupCarrier", that caused the @ref orxonox::PickupSpawner "PickupSpawner" to spawn a new pickup. How the spawner looks in the game is defined by the @ref orxonox::PickupRepresentation "PickupRepresentation" of the @ref orxonox::Pickupable "Pickupable" it spawns.
-
- @subsection UsingPredifinedPickups Using predefined pickups
- There is a file called <code>pickupRepresentationTemplates.oxt</code> in <code>levels/templates</code>, which holds the templates for the @ref orxonox::PickupRepresentation "PickupRepresentations" and also templates for @ref orxonox::Pickupable "Pickupables". The templates for the @ref orxonox::PickupRepresentation "PickupRepresentations" define the @ref orxonox::StaticEntity "StaticEntities" that are attached to the @ref orxonox::PickupSpawner "PickupSpawners" to make them look like the @ref orxonox::Pickupable "Pickupable" they are spawning. The templates for the @ref orxonox::Pickupable "Pickupables" can be added just for ease of use.
- If you want to use pickups you will have to include this file in your level file, somewhere above the Level-tag.
- @code
- <?lua
- include("templates/pickupRepresentationTemplates.oxt")
- ?>
- ...
- <Level>
- ...
- @endcode
- There is another file called <code>pickups.oxi</code> in <code>level/includes</code> which creates all @ref orxonox::PickupRepresentation "PickupRepresentations" needed for the @ref orxonox::Pickupable "Pickupable" supplied by the <code>pickupRepresentationTemplates.oxt</code> file. This file will have to be included as well. It has to be somewhere after the opening Scene-tag and your first use of a pickup.
- @code
- <Scene>
- ...
- <?lua
- include("includes/pickups.oxi")
- ?>
- @endcode
- After that all the predefined pickups specified in those two files can be used just by creating a @ref orxonox::PickupSpawner "PickupSpawner" for them in the respective level.
- For example:
- @code
- <PickupSpawner position="-100,0,-100" respawnTime="30" maxSpawnedItems="10">
- <pickup>
- <HealthPickup
- health = 10
- healthType = "limited"
- activationType = "immediate"
- durationType = "once"
- />
- </pickup>
- </PickupSpawner>
- @endcode
- Please be aware, that the @ref orxonox::Pickupable "Pickupable" specified for the @ref orxonox::PickupSpawner "PickupSpawner", has to be exactly the same (including all parameters) to the one specified in the <code>pickups.oxi</code> file.
- To make things simpler, one could just use the templates specified in the <code>pickupRepresentationTemplates.oxt</code> file. Which, following the previous example, would look like this:
- @code
- <PickupSpawner position="-100,0,-100" respawnTime="30" maxSpawnedItems="10">
- <pickup>
- <HealthPickup template="smallhealthpickup" />
- </pickup>
- </PickupSpawner>
- @endcode
-
- @subsection UnsingNon-PredefinedPickups Using non-predefined pickups
- To include a type of pickup (which, as we remember, is the class of the @ref orxonox::Pickupable "Pickupable" with specific values for all the relevant parameters) in a level file, you can just create a new @ref orxonox::PickupSpawner "PickupSpawner" and specify the @ref orxonox::Pickupable "Pickupable".
- @code
- <PickupSpawner position="-100,0,-100" respawnTime="30" maxSpawnedItems="10">
- <pickup>
- <HealthPickup
- health = 33
- healthType = "limited"
- activationType = "immediate"
- durationType = "once"
- />
- </pickup>
- </PickupSpawner>
- @endcode
- As can be seen in the <code>pickupRepresentationTemplates.oxt</code> file and the <code>pickups.oxi</code> file there is no @ref orxonox::PickupRepresentation "PickupRepresentation" defined for this type of pickup. Thus the default representation will be used.
-
- To create an appropriate @ref orxonox::PickupRepresentation "PickupRepresentation" for the inserted pickup above, you can just create a @ref orxonox::PickupRepresentation "PickupRepresentation" within the scene (Within the Scene-tags).
- @code
- <PickupRepresentation
- name = "My new health pickup"
- description = "This is an awesome new health pickup."
- spawnerTemplate = "mediumhealthpickupRepresentation"
- inventoryRepresentation = "MediumHealth"
- >
- <pickup>
- <HealthPickup
- health = 33
- healthType = "limited"
- activationType = "immediate"
- durationType = "once"
- />
- </pickup>
- </PickupRepresentation>
- @endcode
- Notice, that the type of pickup specified for the @ref orxonox::PickupRepresentation "PickupRepresentation", naturally, needs to be the same (this is the way they can be connected). Also, we just used an existing <em>spawnerTemplate</em>, to make things simpler.
-
- The next step is to create a <em>spawnerRepresentation</em> uniquely for our new type of pickup. Lets call it <code>newhealthpickupRepresentation</code>. Thus the parameter <em>spawnerTemplate</em> of the @ref orxonox::PickupRepresentation "PickupRepresentation" has to be changed to that value.
- @code
- spawnerTemplate = "newhealthpickupRepresentation"
- @endcode
- The <em>spawnerTemplate</em> defines how the @ref orxonox::PickupSpawner "PickupSpawner" is displayed in a level.
- In our example case it could look like this:
- @code
- <Template name=newhealthpickupRepresentation>
- <PickupRepresentation>
- <spawner-representation>
- <StaticEntity>
- <attached>
- -- Here you can put all the objects which define the look of the spawner. --
- </attached>
- </StaticEntity>
- </spawner-representation>
- </PickupRepresentation>
- </Template>
- @endcode
- Please refer to the <code>pickupRepresentationTemplates.oxt</code> for more examples.
-
- The @ref orxonox::PickupRepresentation "PickupRepresentation" also needs another parameter the <em>inventoryRepresentation</em>. This parameter defined how the @ref orxonox::Pickupable "Pickupable" is displayed in the PickupInventory (a menu to browse the currently equipped pickups).
- @code
- inventoryRepresentation = "MediumHealth"
- @endcode
- This is the name of an image defined in the PickupInventory imageset (<code>PickupInventory.imageset</code>), which can be found in <code>data_extern/gui/imagesets</code>.
-
- This is all that has to be done. Now you have a new pickup type with an appropriate @ref orxonox::PickupRepresentation "PickupRepresentation" for your use. If you feel that your pickup is useful in general, please don't hesitate to create a template for the pickup and add your pickup to the <code>pickupRepresentationTemplates.oxt</code> file and the <code>pickups.oxi</code> file, so that anyone who wants to use it can do so quite easily.
-
- There is also an additional way to create new types of pickups to be used in a level (without having to do any coding). There is a @ref orxonox::Pickupable "Pickupable" called the @ref orxonox::PickupCollection "PickupCollection", which is just a collection (hence the name) of @ref orxonox::Pickupable "Pickupables" (more precisely of @ref orxonox::CollectiblePickup "CollectiblePickups"), behaving as if it was just one @ref orxonox::Pickupable "Pickupable".
- A @ref orxonox::PickupCollection "PickupCollection" can be created as follows:
- @code
- <PickupCollection>
- <pickupables>
- -- some pickups you want to have in your collection, e.g. --
- <HealthPickup template=smallhealthpickup />
- <HealthPickup health=50 healthRate=5 durationType=continuous activationType=immediate healthType=limited />
- </pickupables>
- </PickupCollection>
- @endcode
- Of which types of pickups a collection is made up is entirely up to the one creating the @ref orxonox::PickupCollection "PickupCollection", they can be mixed freely.
-
- @section CreatingAPickup Creating a new pickup
- Things have been fairly straightforward so far. Creating a @ref orxonox::Pickupable "Pickupable" form scratch isn't as easy. Therefore I'm just going to supply you with a recipe, or a set of steps you have to take, without which your pickup won't work and point out some common pitfalls.
-
- @subsection CreatingAPickupClass Creating the class
- For a new @ref orxonox::Pickupable "Pickupable" you need to create a new class in <code>>modules/pickup/items</code>. Your class needs to be derived from another pickup class, normally this would either be @ref orxonox::Pickupable "Pickupable", @ref orxonox::CollectiblePickup "CollectiblePickup" or @ref orxonox::Pickup "Pickup". @ref orxonox::Pickupable "Pickupable" is (as mentioned earlier) the base class of all things that can be picked up, thus of all pickups. @ref orxonox::CollectiblePickup "CollectiblePickup" is a (directly) derived class of @ref orxonox::Pickupable "Pickupable" and provides the additional functionality of enabling your pickup to be used in a @ref orxonox::PickupCollection "PickupCollection". However you are probably going to want to derive your class form @ref orxonox::Pickup "Pickup", because it is a @ref orxonox::CollectiblePickup "CollectiblePickup" and provides some useful methods. So have a look at @ref orxonox::Pickup "Pickup".
- Once you have created your new pickup class you have to insert it in the <code>PickupPrereqs.h</code> file in the <code>modules/pickup</code> folder and in the <code>CMakeList.txt</code> file in the <code>modules/pickup/items</code> folder. Also have a look at other pickups to make sure you include all the necessary files in your class.
-
- @subsection ChoosingTheCarriers Coosing the carriers
- You also have to choose the entities that are allowed to pick your pickup up. After you have chosen the entity that carries your pickup, you need to do the following.
- - The enity that carries your pickup needs to be derived from the @ref orxonox::PickupCarrier "PickupCarrier" interface. And you need to implement the @ref orxonox::PickupCarrier "PickupCarriers'" virtual functions <code>getCarrierChildren()</code> and <code>getCarrierParent()</code>. These tow methods are needed, because all pickups are initially picked up by a @ref orxonox::Pawn "Pawn" and then handed down to the entity that effectively carries them. With the above mentioned two function just that is accomplished. A hierarchical structure is established with one parent and a set of children, where the @ref orxonox::Pawn "Pawn" is the root node of this hierarchical structure, the only entity with no parent.
- - Once you have done that you will also want to specify in your pickup which carriers can pick it up, this is done via the <code>addTarget()</code> function. So you have to make sure the target is added whenever one of your pickups is created (so, most conveniently somewhere in the constructor), with the following command.
- @code
- this->addTarget(ClassIdentifier<MyCarrierClass>::getIdentifier());
- @endcode
-
- @subsection CreatingTheInnerWorkings Creating the inner workings of your pickup
- Now that we have the skeleton of a pickup and we have defined which carriers are allowed to pick our pickup up we are going to take a look at all the methods we can (or sometimes have to) overload from @ref orxonox::Pickupable "Pickupable", for our pickup to work properly. But first I will introduce some more concepts to make the need for these methods more obvious.
- - Since one pickup class can by itself be many pickup types, we need a way to find out whether a particular instance of a pickup is of the same type as another instance of a pickup. To that end the @ref orxonox::PickupIdentifier "PickupIdentifier" was created. The @ref orxonox::PickupIdentifier "PickupIdentifier" accounts for the type of class your pickup is of and also for the parameters (and their values) that distinguish different types of pickups of the same class. Much of the functionality of the pickup module relies on this identifier being correct, thus it is very important to initialize it correctly. (We will see, how that is done in a short while.)
- - Every @ref orxonox::Pickupable "Pickupable" has at least two states which are very important. The first is, whether the @ref orxonox::Pickupable "Pickupable" is currently in use or not and the second is whether the pickup is currently picked up or not.
-
- Let's have a look at the important methods.
- - <b>changedUsed()</b> The <code>changedUsed()</code> method is called whenever the state of the @ref orxonox::Pickupable "Pickupable" transits from being used to not being used or the other way around. Which means this method is probably the most important method you have at your fingertips, since it enables you to apply the effect of your pickup when it gets used and remove the effect as soon as it is no longer in use.
- - <b>changedPickedUp()</b> The <code>changedPickedUp()</code> method is called whenever the state of the @ref orxonox::Pickupable "Pickupable" changes from being picked up to not being picked up or the other way around. For example if you want your pickup to be used as soon as it is picked up, this is the method you have to overload to achieve that behavior (or just let your pickup be derived from @ref orxonox::Pickup "Pickup", which implements exactly that behavior, if the <em>activationType</em> is set to <em>immediate</em>). You don't have to concern yourself with destroying the pickup or creating a spawner when it changes to not picked up, since that is already implemented with the @ref orxonox::Pickupable "Pickupable" and @ref orxonox::PickupCarrier "PickupCarrier" classes. If you want a different behavior, however, once again, this is the method.
- - <b>changedCarrier()</b> The <code>changedCarrier()</code> method is called whenever the carrier of the @ref orxonox::Pickupable "Pickupable" changes. And by that I don't mean the class that is allowed to carry the pickup, but the object that actually carries (or carried) the pickup. Please do not overload this class to implement behavior for picked up -> not picked up transitions, use <code>changedPickedUp()</code> for that. For most pickup classes this method doesn't need to be overloaded. Where it is used, however is in the @ref orxonox::PickupCollection "PickupCollection" class, where the new carrier needed to be communicated to all pickups the collection consists of, whenever the carrier was changed.
-
- Please be aware, that these three methods are methods registered with @ref Super.h "Super", meaning, that whenever overloading them, don't forget to call <code>SUPER(MyClass, myMethod);</code>.
- Also when implementing the above methods you should think of what should happen in unexpected situations, e.g. when your pickup is unused manually and set to used again.
- Additionally you should use the <code>destroy()</code> method of Pickupable instead of the method provided by @ref orxonox::OrxonoxClass "OrxonoxClass", meaning <code>Pickupable::destroy()</code> instead of plain <code>destroy()</code>.
-
- - <b>clone()</b> The <code>clone()</code> 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 it reflects 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:
- @code
- 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 distinguish the different types of this pickup), e.g.
- pickup->setSomeParameter(this->getSomeParameter());
- // You must also initialize the identifier of the new pickup, this is normally done in a member function called in
- pickup->initializeIdentifier();
- }
- @endcode
- - <b>initializeIdentifier()</b> The <code>initializeIdentifier()</code> method initializes (or more simply put, creates) the @ref orxonox::PickupIdentifier "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 <code>initializeIdentifier()</code> method must be called as soon as they are available, which normally is in the <code>XMLPort()</code> method, and the <code>clone()</code> method, as seen above. In the <code>initializeIdentifier()</code> 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:
- @code
- 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);
- }
- @endcode
-
- Be aware, this only works for parameters that are simple enough, meaning with pointers for example it will, naturally, not work, and other ways must be found (this is for example done in @ref orxonox::PickupCollection "PickupCollection" with a derived class of the @ref orxonox::PickupIdentifier "PickupIdentifier", the @ref orxonox::PickupCollectionIdentifier "PickupCollectionIdentifier") or in the @ref orxonox::DronePickup "DronePickup" class by using a @ref orxonox::Template "Template".
- - <b>createSpawner()</b> The <code>createSpawner()</code> method needs to be implemented by any pickup directly inheriting from @ref orxonox::Pickupable "Pickupable" (or directly from @ref orxonox::CollectiblePickup "CollectiblePickup"), so if you inherit from @ref orxonox::Pickup "Pickup", you don't need to implement this. It is used to create a @ref orxonox::PickupSpawner "PickupSpawner", when the pickup is dropped. A standard implementation would look like this.
- @code
- bool MyPickup::createSpawner(void)
- {
- new DroppedPickup(this, this, this->getCarrier());
- return true;
- }
- @endcode
-
- @section PickupTechnicalDetails Technical details
-
- @image html pickupmodule.png
-*/
-
-/**
- @defgroup PickupItems Items
- @ingroup Pickup
-
- The actual pickups can be found here.
-*/
+*/
\ No newline at end of file
Modified: code/trunk/src/libraries/core/CoreIncludes.h
===================================================================
--- code/trunk/src/libraries/core/CoreIncludes.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/CoreIncludes.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -124,6 +124,8 @@
/**
@brief Registers the class in the framework with a given Factory.
@param ClassName The name of the class
+ @param FactoryInstance An instance of a factory that can create the class
+ @param bLoadable Whether the class is allowed to be loaded through XML
*/
#define RegisterClassWithFactory(ClassName, FactoryInstance, bLoadable) \
orxonox::SI_I& _##ClassName##Identifier = (*new orxonox::SI_I(orxonox::registerClass<ClassName>(#ClassName, FactoryInstance, bLoadable)))
@@ -200,10 +202,10 @@
@brief Returns the Identifier with a given 'this' pointer.
@note This of course only works with Identifiables.
The only use is in conjunction with macros that don't know the class type.
- @param object Pointer to an Identifiable
+ @param p Pointer to an Identifiable
*/
template <class T>
- inline Identifier* ClassByObjectType(const T*)
+ inline Identifier* ClassByObjectType(const T* p)
{
return ClassIdentifier<T>::getIdentifier();
}
Modified: code/trunk/src/libraries/core/GUIManager.cc
===================================================================
--- code/trunk/src/libraries/core/GUIManager.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/GUIManager.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -792,18 +792,12 @@
}
}
- /** Executes a CEGUI function normally, but catches CEGUI::ScriptException.
- When a ScriptException occurs, the error message will be displayed and
- the program carries on.
- @remarks
- The exception behaviour may pose problems if the code is not written
- exception-safe (and you can forget about that in Lua). The program might
- be left in an undefined state. But otherwise one script error would
- terminate the whole program...
- @note
- Your life gets easier if you use std::bind to create the object/function.
+ /**
+ @copydoc protectedCeguiSystemCall
@param function
- Any callable object/function that takes this->guiSystem_ as its only parameter.
+ Any callable object/function that takes one parameter.
+ @param object
+ Object to be used as an argument for the @p function
@return
True if input was handled, false otherwise. A caught exception yields true.
*/
@@ -822,6 +816,22 @@
}
}
+ /**
+ Executes a CEGUI function normally, but catches CEGUI::ScriptException.
+ When a ScriptException occurs, the error message will be displayed and
+ the program carries on.
+ @remarks
+ The exception behaviour may pose problems if the code is not written
+ exception-safe (and you can forget about that in Lua). The program might
+ be left in an undefined state. But otherwise one script error would
+ terminate the whole program...
+ @note
+ Your life gets easier if you use std::bind to create the object/function.
+ @param function
+ Any callable object/function that takes this->guiSystem_ as its only parameter.
+ @return
+ True if input was handled, false otherwise. A caught exception yields true.
+ */
template <typename FunctionType>
bool GUIManager::protectedCeguiSystemCall(FunctionType function)
{
Modified: code/trunk/src/libraries/core/class/IdentifierManager.cc
===================================================================
--- code/trunk/src/libraries/core/class/IdentifierManager.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/class/IdentifierManager.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -254,7 +254,7 @@
/**
@brief Returns the Identifier with a given typeid-name.
- @param name The typeid-name of the wanted Identifier
+ @param typeInfo The type_info of the wanted Identifier
@return The Identifier
*/
Identifier* IdentifierManager::getIdentifierByTypeInfo(const std::type_info& typeInfo)
Modified: code/trunk/src/libraries/core/command/CommandExecutor.cc
===================================================================
--- code/trunk/src/libraries/core/command/CommandExecutor.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/command/CommandExecutor.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -66,6 +66,7 @@
@brief Executes a command.
@param command A string containing the command
@param useTcl If true, the command is passed to tcl (see TclBind)
+ @param printErrors If true, print an error when command failed
@return Returns the error-code (see @ref CommandExecutorErrorCodes "error codes")
*/
/* static */ int CommandExecutor::execute(const std::string& command, bool useTcl, bool printErrors)
Modified: code/trunk/src/libraries/core/command/ConsoleCommandCompilation.cc
===================================================================
--- code/trunk/src/libraries/core/command/ConsoleCommandCompilation.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/command/ConsoleCommandCompilation.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -99,6 +99,7 @@
/**
@brief Prints text to the console.
@param level_name The name of the output level
+ @param text The text to print
*/
void orxout_level(const std::string& level_name, const std::string& text)
{
@@ -118,6 +119,7 @@
@brief Prints text to the console.
@param level_name The name of the output level
@param context_name The name of the output context
+ @param text The text to print
*/
void orxout_level_context(const std::string& level_name, const std::string& context_name, const std::string& text)
{
Modified: code/trunk/src/libraries/core/commandline/CommandLineIncludes.h
===================================================================
--- code/trunk/src/libraries/core/commandline/CommandLineIncludes.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/commandline/CommandLineIncludes.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -29,7 +29,6 @@
/**
@defgroup CmdArgs Commandline arguments
@ingroup Config
- @brief For a reference of all commandline arguments see @ref cmdargspage
*/
/**
Modified: code/trunk/src/libraries/core/commandline/CommandLineParser.cc
===================================================================
--- code/trunk/src/libraries/core/commandline/CommandLineParser.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/commandline/CommandLineParser.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -217,8 +217,6 @@
Full name of the argument
@param value
String containing the value
- @param bParsingFile
- Parsing a file or the command line itself
*/
void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value)
{
@@ -236,8 +234,6 @@
Shortcut to the argument
@param value
String containing the value
- @param bParsingFile
- Parsing a file or the command line itself
*/
void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value)
{
Modified: code/trunk/src/libraries/core/commandline/CommandLineParser.h
===================================================================
--- code/trunk/src/libraries/core/commandline/CommandLineParser.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/commandline/CommandLineParser.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -27,12 +27,6 @@
*/
/**
- @defgroup CmdArgs Commandline arguments
- @ingroup Config
- @brief For a reference of all commandline arguments see @ref cmdargspage
-*/
-
-/**
@file
@ingroup Config CmdArgs
@brief Declaration of CommandLineParser and CommandLineArgument, definition of the SetCommandLineArgument() macros.
Modified: code/trunk/src/libraries/core/config/ConfigValueContainer.h
===================================================================
--- code/trunk/src/libraries/core/config/ConfigValueContainer.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/config/ConfigValueContainer.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -108,7 +108,7 @@
@param value Only needed do determine the right type.
*/
template <class D, class V>
- ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const D& defvalue, const V&)
+ ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const D& defvalue, const V& value)
{
this->init(type, identifier, sectionname, varname);
this->initValue(static_cast<V>(defvalue));
@@ -124,7 +124,7 @@
@param value Only needed do determine the right type.
*/
template <class D, class V>
- ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>&)
+ ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>& value)
{
this->init(type, identifier, sectionname, varname);
Modified: code/trunk/src/libraries/core/object/IteratorBase.h
===================================================================
--- code/trunk/src/libraries/core/object/IteratorBase.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/object/IteratorBase.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -172,7 +172,7 @@
/**
@brief Increments the Iterator if it points at the given element.
- @param object The object to compare with
+ @param element The element to compare with
*/
virtual void removedElement(ObjectListBaseElement* element) override
{
Modified: code/trunk/src/libraries/core/object/ObjectListBase.h
===================================================================
--- code/trunk/src/libraries/core/object/ObjectListBase.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/core/object/ObjectListBase.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -54,7 +54,7 @@
public:
/**
@brief Constructor: Creates the list-element with an object.
- @param objectBase The object to store
+ @param object The object to store
*/
ObjectListBaseElement(Listable* object) : next_(nullptr), prev_(nullptr), objectBase_(object), list_(nullptr) {}
virtual ~ObjectListBaseElement() { this->removeFromList(); }
Modified: code/trunk/src/libraries/network/MasterServerComm.h
===================================================================
--- code/trunk/src/libraries/network/MasterServerComm.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/network/MasterServerComm.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -87,7 +87,7 @@
*/
int sendRequest( std::string data );
- /** \param callback The callback function to call with data received.
+ /** \param listener The listener to call with data received.
* \param delayms Delay in milliseconds.
* \return 0 for success, other for error
*
Modified: code/trunk/src/libraries/network/ServerList.h
===================================================================
--- code/trunk/src/libraries/network/ServerList.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/network/ServerList.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -73,6 +73,7 @@
/* BASIC MANIPULATION */
/** \param toadd the server to add.
+ * \param peer the peer
*
* Add server to the game server list
*/
Modified: code/trunk/src/libraries/tools/BulletDebugDrawer.cc
===================================================================
--- code/trunk/src/libraries/tools/BulletDebugDrawer.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/BulletDebugDrawer.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,4 +1,5 @@
/**
+ * @file BulletDebugDrawer.cc
* Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
* This source code is released into the Public Domain.
*
Modified: code/trunk/src/libraries/tools/BulletDebugDrawer.h
===================================================================
--- code/trunk/src/libraries/tools/BulletDebugDrawer.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/BulletDebugDrawer.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,10 +1,3 @@
-/**
- * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
- * This source code is released into the Public Domain.
- *
- * Modified by Fabian 'x3n' Landau by using DebugDrawer and Orxonox specific utilities (e.g. output).
- */
-
#ifndef _BulletDebugDrawer_H__
#define _BulletDebugDrawer_H__
@@ -17,6 +10,12 @@
namespace orxonox
{
+ /**
+ * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
+ * This source code is released into the Public Domain.
+ *
+ * Modified by Fabian 'x3n' Landau by using DebugDrawer and Orxonox specific utilities (e.g. output).
+ */
class _ToolsExport BulletDebugDrawer : public btIDebugDraw, public Ogre::FrameListener
{
public:
Modified: code/trunk/src/libraries/tools/DebugDrawer.cc
===================================================================
--- code/trunk/src/libraries/tools/DebugDrawer.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/DebugDrawer.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,4 +1,5 @@
/**
+ * @file DebugDrawer.cc
* Copy-pasted from
* - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
* - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
Modified: code/trunk/src/libraries/tools/DebugDrawer.h
===================================================================
--- code/trunk/src/libraries/tools/DebugDrawer.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/DebugDrawer.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,4 +1,5 @@
/**
+ * @file DebugDrawer.h
* Copy-pasted from
* - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
* - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
@@ -8,12 +9,8 @@
* Modified by Fabian 'x3n' Landau
*/
-/**
- * @file
- * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
- * This utility is e.g. used by @ref BulletDebugDrawer to visualize collision shapes and other physical entities.
- */
+
#ifndef _DebugDrawer_H__
#define _DebugDrawer_H__
@@ -25,6 +22,10 @@
namespace orxonox
{
+ /**
+ * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
+ * This utility is e.g. used by @ref orxonox::BulletDebugDrawer to visualize collision shapes and other physical entities.
+ */
class _ToolsExport DebugDrawer
{
public:
Modified: code/trunk/src/libraries/tools/IcoSphere.cc
===================================================================
--- code/trunk/src/libraries/tools/IcoSphere.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/IcoSphere.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,4 +1,5 @@
/**
+ * @file IcoSphere.cc
* Copy-pasted from
* - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
* - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
Modified: code/trunk/src/libraries/tools/IcoSphere.h
===================================================================
--- code/trunk/src/libraries/tools/IcoSphere.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/IcoSphere.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,18 +1,4 @@
-/**
- * Copy-pasted from
- * - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
- * - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
- *
- * This source code is released into the Public Domain.
- *
- * Modified by Fabian 'x3n' Landau
- */
-/**
- * @file
- * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
- * This utility is e.g. used by @ref BulletDebugDrawer to visualize collision shapes and other physical entities.
- */
#ifndef _IcoSphere_H__
#define _IcoSphere_H__
@@ -26,6 +12,15 @@
{
typedef std::pair<Ogre::Vector3, Ogre::ColourValue> VertexPair;
+ /**
+ * Copy-pasted from
+ * - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
+ * - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
+ *
+ * This source code is released into the Public Domain.
+ *
+ * Modified by Fabian 'x3n' Landau
+ */
class _ToolsExport IcoSphere
{
public:
Modified: code/trunk/src/libraries/tools/OgreBulletUtils.h
===================================================================
--- code/trunk/src/libraries/tools/OgreBulletUtils.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/tools/OgreBulletUtils.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -1,4 +1,5 @@
/**
+ * @file OgreBulletUtils.h
* Copy-pasted from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
* This source code is released into the Public Domain.
*
Modified: code/trunk/src/libraries/util/Clock.h
===================================================================
--- code/trunk/src/libraries/util/Clock.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/util/Clock.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -53,7 +53,6 @@
Furthermore it might be possible that the Ogre::Timer has a performance
caveat because it will only capture the time on the same CPU core.
Confining the main thread to one process could speed up the game.
- See \ref cmdargspage "Ccommandline Argument" 'limitToCPU' (only on Windows)
*/
class _UtilExport Clock
{
Modified: code/trunk/src/libraries/util/Math.cc
===================================================================
--- code/trunk/src/libraries/util/Math.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/libraries/util/Math.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -290,11 +290,11 @@
/**
@brief Gets the new vector after a coordinate transformation
- @param distance Vector which will be transformed
- @param mydirection New x basevector
- @param myorthonormal New y basevector
- @param otherposition New z basevector
- @return direction in the new coordinates
+ @param totransform Vector which will be transformed
+ @param newx New x basevector
+ @param newy New y basevector
+ @param newz New z basevector
+ @return Vector in the new coordinates
x is vector in old coordinates
y is vector in old coordinates
@@ -306,12 +306,12 @@
y = T^(-1)*x
*/
- orxonox::Vector3 getTransformedVector(const orxonox::Vector3& distance, const orxonox::Vector3& mydirection, const orxonox::Vector3& myorthonormal, const orxonox::Vector3& myside)
+ orxonox::Vector3 getTransformedVector(const orxonox::Vector3& totransform, const orxonox::Vector3& newx, const orxonox::Vector3& newy, const orxonox::Vector3& newz)
{
// inverse of the transform matrix
- float determinant = +mydirection.x * (myorthonormal.y*myside.z - myside.y*myorthonormal.z)
- -mydirection.y * (myorthonormal.x*myside.z - myorthonormal.z*myside.x)
- +mydirection.z * (myorthonormal.x*myside.y - myorthonormal.y*myside.x);
+ float determinant = +newx.x * (newy.y*newz.z - newz.y*newy.z)
+ -newx.y * (newy.x*newz.z - newy.z*newz.x)
+ +newx.z * (newy.x*newz.y - newy.y*newz.x);
float invdet = 1/determinant;
// transform matrix
@@ -319,21 +319,21 @@
orxonox::Vector3 yinvtransform;
orxonox::Vector3 zinvtransform;
- xinvtransform.x = (myorthonormal.y * myside.z - myside.y * myorthonormal.z)*invdet;
- xinvtransform.y = (mydirection.z * myside.y - mydirection.y * myside.z )*invdet;
- xinvtransform.z = (mydirection.y * myorthonormal.z - mydirection.z * myorthonormal.y)*invdet;
- yinvtransform.x = (myorthonormal.z * myside.x - myorthonormal.x * myside.z )*invdet;
- yinvtransform.y = (mydirection.x * myside.z - mydirection.z * myside.x )*invdet;
- yinvtransform.z = (myorthonormal.x * mydirection.z - mydirection.x * myorthonormal.z)*invdet;
- zinvtransform.x = (myorthonormal.x * myside.y - myside.x * myorthonormal.y)*invdet;
- zinvtransform.y = (myside.x * mydirection.y - mydirection.x * myside.y )*invdet;
- zinvtransform.z = (mydirection.x * myorthonormal.y - myorthonormal.x * mydirection.y )*invdet;
+ xinvtransform.x = (newy.y * newz.z - newz.y * newy.z)*invdet;
+ xinvtransform.y = (newx.z * newz.y - newx.y * newz.z )*invdet;
+ xinvtransform.z = (newx.y * newy.z - newx.z * newy.y)*invdet;
+ yinvtransform.x = (newy.z * newz.x - newy.x * newz.z )*invdet;
+ yinvtransform.y = (newx.x * newz.z - newx.z * newz.x )*invdet;
+ yinvtransform.z = (newy.x * newx.z - newx.x * newy.z)*invdet;
+ zinvtransform.x = (newy.x * newz.y - newz.x * newy.y)*invdet;
+ zinvtransform.y = (newz.x * newx.y - newx.x * newz.y )*invdet;
+ zinvtransform.z = (newx.x * newy.y - newy.x * newx.y )*invdet;
// coordinate transformation
orxonox::Vector3 distanceShip;
- distanceShip.x = xinvtransform.x * distance.x + yinvtransform.x * distance.y + zinvtransform.x * distance.z;
- distanceShip.y = xinvtransform.y * distance.x + yinvtransform.y * distance.y + zinvtransform.y * distance.z;
- distanceShip.z = xinvtransform.z * distance.x + yinvtransform.z * distance.y + zinvtransform.z * distance.z;
+ distanceShip.x = xinvtransform.x * totransform.x + yinvtransform.x * totransform.y + zinvtransform.x * totransform.z;
+ distanceShip.y = xinvtransform.y * totransform.x + yinvtransform.y * totransform.y + zinvtransform.y * totransform.z;
+ distanceShip.z = xinvtransform.z * totransform.x + yinvtransform.z * totransform.y + zinvtransform.z * totransform.z;
return distanceShip;
}
Modified: code/trunk/src/modules/docking/DockingAnimation.h
===================================================================
--- code/trunk/src/modules/docking/DockingAnimation.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/docking/DockingAnimation.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -52,7 +52,7 @@
/**
@brief
- Base class for docking animations used by @ref orxonox::Docking "Docks".
+ Base class for docking animations used by @ref orxonox::Dock "Docks".
@author
Sven Stucki
Modified: code/trunk/src/modules/docking/DockingEffect.h
===================================================================
--- code/trunk/src/modules/docking/DockingEffect.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/docking/DockingEffect.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -50,7 +50,7 @@
/**
@brief
- Handles DockingEffects for @ref orxonox::Docking "Docks".
+ Handles DockingEffects for @ref orxonox::Dock "Docks".
@author
Sven Stucki
Modified: code/trunk/src/modules/docking/DockingTarget.h
===================================================================
--- code/trunk/src/modules/docking/DockingTarget.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/docking/DockingTarget.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -44,7 +44,7 @@
{
/**
@brief
- DockingTargets for @ref orxonox::Docking "Docks".
+ DockingTargets for @ref orxonox::Dock "Docks".
@author
Sven Stucki
Modified: code/trunk/src/modules/docking/MoveToDockingTarget.h
===================================================================
--- code/trunk/src/modules/docking/MoveToDockingTarget.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/docking/MoveToDockingTarget.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -45,7 +45,7 @@
/**
@brief
- Base class for docking animations used by @ref orxonox::Docking "Docks".
+ Base class for docking animations used by @ref orxonox::Dock "Docks".
@author
Sven Stucki
Modified: code/trunk/src/modules/gametypes/SpaceRaceController.cc
===================================================================
--- code/trunk/src/modules/gametypes/SpaceRaceController.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/gametypes/SpaceRaceController.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -23,17 +23,6 @@
* Author: purgham
*/
-/**
- * Conventions:
- * -first Checkpoint has index 0
- * -staticCheckPoint= static Point (see def over = constructor)
- */
-
-/*TODO:
- * tICK KORRIGIEREN
- *
- *
- */
#include <gametypes/SpaceRaceController.h>
#include "core/CoreIncludes.h"
#include "core/XMLPort.h"
Modified: code/trunk/src/modules/gametypes/SpaceRaceController.h
===================================================================
--- code/trunk/src/modules/gametypes/SpaceRaceController.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/gametypes/SpaceRaceController.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -35,6 +35,13 @@
namespace orxonox
{
+ /**
+ * Conventions:
+ * -first Checkpoint has index 0
+ * -staticCheckPoint= static Point (see def over = constructor)
+ *@todo:
+ * tICK KORRIGIEREN
+ */
class _GametypesExport SpaceRaceController: public ArtificialController,
public Tickable
{
Modified: code/trunk/src/modules/hover/HoverFlag.cc
===================================================================
--- code/trunk/src/modules/hover/HoverFlag.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/hover/HoverFlag.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -79,6 +79,8 @@
X-Coordinate of the flage, 0-9, origin is bottom left
@param yCoordinate
Y-Coordinate of the flage, 0-9, origin is bottom left
+ @param cellSize
+ The size of the cells
*/
void HoverFlag::init(int xCoordinate, int yCoordinate, int cellSize)
{
Modified: code/trunk/src/modules/hover/HoverOrigin.h
===================================================================
--- code/trunk/src/modules/hover/HoverOrigin.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/hover/HoverOrigin.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -40,68 +40,8 @@
@brief
The HoverOrigin implements the playing field @ref orxonox::Hover "Hover" takes place in and allows for many parameters of the minigame to be set.
The playing field resides in the x,z-plane, with the x-axis being the horizontal axis and the z-axis being the vertical axis.
-
- Various parameters can be set:
- - The <b>dimension</b> is a vector, that defines the width and height of the playing field. The default is <em>(200, 120)</em>.
- - The <b>balltemplate</b> is a template that is applied to the @ref orxonox::HoverPlatform "HoverPlatform", it can be used to attach different things to it, e.g. its @ref orxonox::Model "Model". See below for a usage example.
- - The <b>battemplate</b> is a template that is applied to the @ref orxonox::HoverPlatform "HoverFigure", it can be used to attach different things to it, e.g. its @ref orxonox::Model "Model". See below for a usage example.
- - The <b>ballspeed</b> is the speed with which the @ref orxonox::HoverPlatform "HoverPlatform" moves. The default is <em>100</em>.
- - The <b>ballaccfactor</b> is the acceleration factor for the @ref orxonox::HoverPlatform "HoverPlatform". The default is <em>1.0</em>.
- - The <b>batspeed</b> is the speed with which the @ref orxonox::HoverFigure "HoverFigures" move. The default is <em>60</em>.
- - The <b>batlength</b> is the length of the @ref orxonox::HoverFigure "HoverFigures" as the percentage of the height of the playing field. The default is <em>0.25</em>.
-
- An example in XML of the HoverOrigin would be:
-
- First the needed templates:
- The template for the @ref orxonox::HoverPlatform "HoverPlatform".
- @code
- <Template name="Hoverball">
- <HoverPlatform>
- <attached>
- <Model mesh="sphere.mesh" scale="2" />
- <ParticleSpawner name="hiteffect" position="0,0,0" source="Orxonox/sparks2" lifetime="0.01" autostart="0" mainstate="spawn" />
- </attached>
- <eventlisteners>
- <EventTarget target="hiteffect" />
- </eventlisteners>
- </HoverPlatform>
- </Template>
- @endcode
- As can be seen, a sphere is attached as the @ref orxonox::Model "Model" for the @ref orxonox::HoverPlatform "HoverPlatform", and also an @ref orxonox::EventListener "EventListener" that triggers a @ref orxonox::ParticleSpawner "ParticleSpawner", whenever the ball hits the boundaries is attached.
-
- Additionally the template for the @ref orxonox::HoverFigure "HoverFigure".
- @code
- <Template name="Hoverbatcameras" defaults="0">
- <HoverFigure>
- <camerapositions>
- <CameraPosition position="0,200,0" pitch="-90" absolute="true" />
- </camerapositions>
- </HoverFigure>
- </Template>
+ For an example, have a look at the <code>Hover.oxw</code> level file.
- <Template name="Hoverbat">
- <HoverFigure camerapositiontemplate=Hoverbatcameras>
- <attached>
- <Model position="0,0,3" mesh="cube.mesh" scale3D="14,2,2" />
- </attached>
- </HoverFigure>
- </Template>
- @endcode
- As can be seen, there are actually two templates. The first template is needed to set the camera for the @ref orxonox::HoverFigure "HoverFigure". The second template ist the actual template for the @ref orxonox::HoverFigure "HoverFigure", the template for the camera position is added and a @ref orxonox::Model "Model" for the @ref orxonox::HoverFigure "HoverFigure" is attached.
- propellerTemplate_
- Finally the HoverOrigin is created.
- @code
- <HoverOrigin name="Hovercenter" dimension="200,120" balltemplate="Hoverball" battemplate="Hoverbat" ballspeed="200" ballaccfactor="1.0" batspeed="130" batlength="0.25">
- <attached>
- <Model position="0,0,60" mesh="cube.mesh" scale3D="105,1,1" />
- <Model position="0,0,-60" mesh="cube.mesh" scale3D="105,1,1" />
- </attached>
- </HoverOrigin>
- @endcode
- All parameters are specified. And also two @ref orxonox::Model "Models" (for the upper and lower boundary) are attached.
-
- For a more elaborate example, have a look at the <code>Hover.oxw</code> level file.
-
*/
class _HoverExport HoverOrigin : public StaticEntity
{
Modified: code/trunk/src/modules/hover/HoverWall.cc
===================================================================
--- code/trunk/src/modules/hover/HoverWall.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/hover/HoverWall.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -75,6 +75,10 @@
x-Coordinate of the Square that the Wall is attached to, 0-9, Origin is Bottom left
@param y
y-Coordinate of the Square that the Wall is attached to, 0-9, Origin is Bottom left
+ @param cellSize
+ The size of a cell
+ @param cellHeight
+ The height of a cell
@param orientation
Wall on the right side (1) or on top (2) of this square, 0-1
*/
Modified: code/trunk/src/modules/jump/JumpEnemy.cc
===================================================================
--- code/trunk/src/modules/jump/JumpEnemy.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/jump/JumpEnemy.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -138,12 +138,6 @@
this->setVelocity(Vector3(newHSpeed,0,newVSpeed));
}
- /**
- @brief
- Set the bats for the ball.
- @param bats
- An array (of size 2) of weak pointers, to be set as the new bats.
- */
void JumpEnemy::setFigure(JumpFigure* newFigure)
{
figure_ = newFigure;
Modified: code/trunk/src/modules/mini4dgame/Mini4DgameBoard.cc
===================================================================
--- code/trunk/src/modules/mini4dgame/Mini4DgameBoard.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/mini4dgame/Mini4DgameBoard.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -71,8 +71,8 @@
}
/**
- @brief checks if the move is valid
- @param the position where to put the stone plus the player who makes the move
+ @brief Checks if the move is valid
+ @param move The position where to put the stone
*/
bool Mini4DgameBoard::isValidMove(const Mini4DgamePosition& move)
{
@@ -97,7 +97,7 @@
/**
@brief makes a move on the logic playboard
- @param the position where to put the stone plus the player who makes the move
+ @param move The position where to put the stone
*/
void Mini4DgameBoard::makeMove(const Mini4DgamePosition& move)
{
Modified: code/trunk/src/modules/notifications/NotificationDispatcher.h
===================================================================
--- code/trunk/src/modules/notifications/NotificationDispatcher.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/notifications/NotificationDispatcher.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -102,7 +102,7 @@
{ return this->bBroadcast_; }
/**
@brief Set the NotificationDispatcher to broadcast.
- @param broadcast Whether the NotificationDispatcher is set to broadcast or singlecast.
+ @param v Whether the NotificationDispatcher is set to broadcast or singlecast.
*/
void setBroadcasting(bool v)
{ this->bBroadcast_ = v; }
Modified: code/trunk/src/modules/notifications/NotificationQueue.cc
===================================================================
--- code/trunk/src/modules/notifications/NotificationQueue.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/notifications/NotificationQueue.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -48,8 +48,6 @@
/**
@brief
Default constructor. Registers and initializes the object.
- @param creator
- The creator of the NotificationQueue.
*/
NotificationQueue::NotificationQueue(Context* context) : BaseObject(context), Synchronisable(context), registered_(false)
{
@@ -65,25 +63,8 @@
this->registerVariables();
}
- // TODO move to docu.
/**
@brief
- Constructor. Registers and initializes the object.
- @param creator
- The creator of the NotificationQueue
- @param name
- The name of the new NotificationQueue. It needs to be unique
- @param senders
- The senders that are targets of this NotificationQueue, i.e. the names of senders whose Notifications this NotificationQueue displays.
- The senders need to be seperated by commas.
- @param size
- The size (the maximum number of displayed Notifications) of this NotificationQueue.
- @param displayTime
- The time during which a Notification is (at most) displayed.
- */
-
- /**
- @brief
Destructor.
*/
NotificationQueue::~NotificationQueue()
Modified: code/trunk/src/modules/objects/Script.cc
===================================================================
--- code/trunk/src/modules/objects/Script.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/Script.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -57,8 +57,6 @@
/**
@brief
Constructor. Registers and initializes the object.
- @param creator
- The creator of this object.
*/
Script::Script(Context* context) : BaseObject(context)
{
Modified: code/trunk/src/modules/objects/Turret.h
===================================================================
--- code/trunk/src/modules/objects/Turret.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/Turret.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -27,6 +27,7 @@
*/
/**
+ @file Turret.h
@brief Definition of the Turret class.
@ingroup Objects
*/
Modified: code/trunk/src/modules/objects/controllers/TurretController.h
===================================================================
--- code/trunk/src/modules/objects/controllers/TurretController.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/controllers/TurretController.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -26,10 +26,6 @@
*
*/
-/**
- @brief Definition for the controller for turrets.
-*/
-
#ifndef _TurretController_H__
#define _TurretController_H__
Modified: code/trunk/src/modules/objects/triggers/DistanceTrigger.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/DistanceTrigger.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/triggers/DistanceTrigger.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -53,8 +53,6 @@
/**
@brief
Constructor. Registers and initializes the object.
- @param creator
- The creator of this trigger.
*/
DistanceTrigger::DistanceTrigger(Context* context) : Trigger(context)
{
Modified: code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -44,8 +44,6 @@
/**
@brief
Constructor. Registers the object.
- @param creator
- The creator of this object.
*/
DistanceTriggerBeacon::DistanceTriggerBeacon(Context* context) : StaticEntity(context)
{
Modified: code/trunk/src/modules/objects/triggers/EventTrigger.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/EventTrigger.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/triggers/EventTrigger.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -44,8 +44,6 @@
/**
@brief
Constructor. Registers and initializes the object.
- @param creator
- The creator of the EventTrigger.
*/
EventTrigger::EventTrigger(Context* context) : Trigger(context)
{
Modified: code/trunk/src/modules/objects/triggers/MultiTrigger.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/MultiTrigger.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/triggers/MultiTrigger.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -47,8 +47,6 @@
/**
@brief
Constructor. Registers the objects and initializes default values.
- @param creator
- The creator.
*/
MultiTrigger::MultiTrigger(Context* context) : TriggerBase(context)
{
Modified: code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -46,8 +46,6 @@
/**
@brief
Default constructor. Registers the object and creates an empty container.
- @param creator
- The creator.
*/
MultiTriggerContainer::MultiTriggerContainer(Context* context) : BaseObject(context), originator_(nullptr), data_(nullptr)
{
@@ -57,8 +55,8 @@
/**
@brief
Constructor. Registers the object and sets the input values.
- @param creator
- The creator.
+ @param context
+ The context.
@param originator
A pointer to the originator of the Event, i.e. the MultiTrigger that fired the Event. (or is about to fire)
@param data
Modified: code/trunk/src/modules/objects/triggers/Trigger.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/Trigger.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/objects/triggers/Trigger.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -50,8 +50,6 @@
/**
@brief
Constructor. Registers and initializes the object.
- @param creator
- The creator of the Trigger.
*/
Trigger::Trigger(Context* context) : TriggerBase(context)
{
Modified: code/trunk/src/modules/pickup/Pickup.cc
===================================================================
--- code/trunk/src/modules/pickup/Pickup.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/pickup/Pickup.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -52,8 +52,6 @@
/**
@brief
Constructor. Registers and initializes the object.
- @param creator
- The objects creator.
*/
Pickup::Pickup(Context* context) : BaseObject(context)
{
Modified: code/trunk/src/modules/pickup/PickupCollection.cc
===================================================================
--- code/trunk/src/modules/pickup/PickupCollection.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/pickup/PickupCollection.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -49,8 +49,6 @@
/**
@brief
Default Constructor.
- @param creator
- The creator of the object.
*/
PickupCollection::PickupCollection(Context* context) : BaseObject(context)
{
Modified: code/trunk/src/modules/pickup/PickupManager.cc
===================================================================
--- code/trunk/src/modules/pickup/PickupManager.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/pickup/PickupManager.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -334,6 +334,8 @@
Whether the Pickupable's used status can be changed to used in the PickupInventory.
@param representationObjectId
The objectId identifying (over the network) the PickupRepresentation that represents this Pickupable.
+ @param representationName
+ The name of the associated PickupRepresentation
@param pickedUp
The pickedUp status the Pickupable changed to.
*/
Modified: code/trunk/src/modules/pickup/PickupSpawner.cc
===================================================================
--- code/trunk/src/modules/pickup/PickupSpawner.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/pickup/PickupSpawner.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -51,8 +51,6 @@
/**
@brief
Constructor. Creates a blank PickupSpawner.
- @param creator
- Pointer to the object which created this item.
*/
PickupSpawner::PickupSpawner(Context* context) : StaticEntity(context), pickup_(nullptr), representation_(nullptr), pickupTemplate_(nullptr)
{
@@ -89,8 +87,8 @@
/**
@brief
Factory method, Creates a fully functional PickupSpawner.
- @param creator
- The creator of this PickupSpawner.
+ @param context
+ The context of this PickupSpawner.
@param pickup
The Pickupable to be spawned by this PickupSpawner.
@param carrier
Modified: code/trunk/src/modules/pickup/items/DamageBoostPickup.h
===================================================================
--- code/trunk/src/modules/pickup/items/DamageBoostPickup.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/pickup/items/DamageBoostPickup.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -67,8 +67,7 @@
/**
- @brief set Damage multiplier
- @param multiplier The default damage multiplier to set
+ @brief Get Damage multiplier
*/
inline float getDamageMultiplier()
{ return this->damageMultiplier_; }
Modified: code/trunk/src/modules/tetris/TetrisCenterpoint.h
===================================================================
--- code/trunk/src/modules/tetris/TetrisCenterpoint.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/tetris/TetrisCenterpoint.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -104,7 +104,7 @@
/**
@brief Set the template for the stones.
- @param template The template name to be applied to each stone.
+ @param templateName The template name to be applied to each stone.
*/
void setStoneTemplate(const std::string& templateName)
{ this->stoneTemplate_ = templateName; }
@@ -117,7 +117,7 @@
/**
@brief Set the template for the bricks.
- @param template The template name to be applied to each brick.
+ @param templateName The template name to be applied to each brick.
*/
void setBrickTemplate(const std::string& templateName)
{ this->brickTemplate_ = templateName; }
Modified: code/trunk/src/modules/towerdefense/TowerDefense.h
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefense.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefense.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -26,14 +26,7 @@
*
*/
- /**
- @brief
- GameType class for TowerDefense. See TowerDefenseReadme.txt for Information.
- @ingroup TowerDefense
- */
-
-
#ifndef _TowerDefense_H__
#define _TowerDefense_H__
#include "TDCoordinate.h"
@@ -46,6 +39,12 @@
namespace orxonox
{
+ /**
+ @brief
+ GameType class for TowerDefense. See TowerDefenseReadme.txt for Information.
+
+ @ingroup TowerDefense
+ */
class _TowerDefenseExport TowerDefense : public TeamDeathmatch
{
public:
Modified: code/trunk/src/modules/towerdefense/TowerDefenseCenterpoint.h
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefenseCenterpoint.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefenseCenterpoint.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -26,13 +26,7 @@
*
*/
-/**
- @brief
- See TowerDefenseReadme.txt for Information.
- @ingroup TowerDefense
- */
-
#ifndef _TowerDefenseCenterpoint_H__
#define _TowerDefenseCenterpoint_H__
@@ -45,6 +39,11 @@
namespace orxonox
{
+ /**
+ @brief
+ See TowerDefenseReadme.txt for Information.
+ @ingroup TowerDefense
+ */
class _TowerDefenseExport TowerDefenseCenterpoint : public MobileEntity
{
public:
Modified: code/trunk/src/modules/towerdefense/TowerDefenseEnemy.cc
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefenseEnemy.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefenseEnemy.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -4,12 +4,6 @@
//
// Created by Jonas Erb on 22.10.14.
-/**
- at brief
-See TowerDefenseReadme.txt for Information.
-
- at ingroup TowerDefense
-*/
#include "TowerDefenseEnemy.h"
#include "core/CoreIncludes.h"
//#include "core/XMLPort.h"
Modified: code/trunk/src/modules/towerdefense/TowerDefenseEnemy.h
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefenseEnemy.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefenseEnemy.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -4,12 +4,7 @@
//
// Created by Jonas Erb on 22.10.14.
-/**
- at brief
-See TowerDefenseReadme.txt for Information.
- at ingroup TowerDefense
-*/
@@ -25,9 +20,12 @@
namespace orxonox
{
-/* Class to give the TowerDefenseEnemy spaceships waypoints and
- *
- */
+ /**
+ @brief
+ See TowerDefenseReadme.txt for Information.
+
+ @ingroup TowerDefense
+ */
class _TowerDefenseExport TowerDefenseEnemy : public SpaceShip
{
public:
Modified: code/trunk/src/modules/towerdefense/TowerDefenseField.h
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefenseField.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefenseField.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -26,11 +26,6 @@
*
*/
-/**
- @brief
- See TowerDefenseReadme.txt for Information.
- @ingroup TowerDefense
- */
#ifndef _TowerDefenseField_H__
@@ -55,7 +50,11 @@
TOWER
};
-
+ /**
+ @brief
+ See TowerDefenseReadme.txt for Information.
+ @ingroup TowerDefense
+ */
class _TowerDefenseExport TowerDefenseField : public MovableEntity
{
public:
Modified: code/trunk/src/modules/towerdefense/TowerDefenseHUDController.h
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefenseHUDController.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefenseHUDController.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -26,14 +26,7 @@
*
*/
- /**
- @brief
- This subclass of OverlayText is used to display the stats of the player in the HUD
- @ingroup TowerDefense
- */
-
-
#ifndef _TowerDefenseHUDController_H__
#define _TowerDefenseHUDController_H__
@@ -45,6 +38,12 @@
namespace orxonox
{
+ /**
+ @brief
+ This subclass of OverlayText is used to display the stats of the player in the HUD
+
+ @ingroup TowerDefense
+ */
class _TowerDefenseExport TowerDefenseHUDController : public OverlayText, public Tickable
{
public:
Modified: code/trunk/src/modules/towerdefense/TowerDefenseTower.h
===================================================================
--- code/trunk/src/modules/towerdefense/TowerDefenseTower.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/towerdefense/TowerDefenseTower.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -6,14 +6,7 @@
// Copyright (c) 2012 __MyCompanyName__. All rights reserved.
//
-/**
- at brief
-See TowerDefenseTowerDefenseReadme.txt for Information.
- at ingroup TowerDefenseTowerDefense
-*/
-
-
#ifndef Orxonox_TowerDefenseTower_h
#define Orxonox_TowerDefenseTower_h
@@ -23,6 +16,12 @@
namespace orxonox
{
+ /**
+ @brief
+ See TowerDefenseTowerDefenseReadme.txt for Information.
+
+ @ingroup TowerDefenseTowerDefense
+ */
class _TowerDefenseExport TowerDefenseTower : public Turret
{
public:
Modified: code/trunk/src/modules/weapons/projectiles/BasicProjectile.cc
===================================================================
--- code/trunk/src/modules/weapons/projectiles/BasicProjectile.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/weapons/projectiles/BasicProjectile.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -73,6 +73,8 @@
A pointer to the object the Projectile has collided against.
@param contactPoint
A btManifoldPoint indicating the point of contact/impact.
+ @param cs
+ The btCollisionShape of the other object
@return
Returns true if the collision resulted in a successful hit.
@see Pawn.h
Modified: code/trunk/src/modules/weapons/projectiles/BasicProjectile.h
===================================================================
--- code/trunk/src/modules/weapons/projectiles/BasicProjectile.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/weapons/projectiles/BasicProjectile.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -96,8 +96,6 @@
{ if(shielddamage >= 0.0f) { this->shielddamage_ = shielddamage; return; } orxout(internal_warning) << "The input projectile shield-damage must be non-negative. Ignoring..." << endl; }
/**
@brief Get the shield-damage done by this projectile.
- Shield-damage only reduces shield health.
- @param shielddamage The amount of damage. Is non-negative.
*/
inline float getShieldDamage() const
{ return this->shielddamage_; }
Modified: code/trunk/src/modules/weapons/projectiles/GravityBombField.h
===================================================================
--- code/trunk/src/modules/weapons/projectiles/GravityBombField.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/weapons/projectiles/GravityBombField.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -49,7 +49,7 @@
* @author Manuel Eggimann
* @date 23.05.2015
*
- * @param [in,out] the Pawn that created the field.
+ * @param [in,out] shooter the Pawn that created the field.
*/
void setShooter(Pawn* shooter)
{ this->shooter_ = shooter; }
Modified: code/trunk/src/modules/weapons/projectiles/SplitGunProjectile.cc
===================================================================
--- code/trunk/src/modules/weapons/projectiles/SplitGunProjectile.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/weapons/projectiles/SplitGunProjectile.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -79,7 +79,8 @@
/**
@brief
- This function starts a timer that will cause the projectile to split after a time defined by the argument @param splitTime.
+ This function starts a timer that will cause the projectile to split after a time defined by the argument @p splitTime.
+ @param splitTime The time
*/
void SplitGunProjectile::setSplitTime(float splitTime)
{
Modified: code/trunk/src/modules/weapons/weaponmodes/HsW01.h
===================================================================
--- code/trunk/src/modules/weapons/weaponmodes/HsW01.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/modules/weapons/weaponmodes/HsW01.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -75,7 +75,7 @@
/**
@brief Set the sound.
- @param mesh The Sound name.
+ @param sound The Sound name.
*/
void setSound(const std::string& sound)
{ this->sound_ = sound; }
Modified: code/trunk/src/orxonox/LevelInfo.cc
===================================================================
--- code/trunk/src/orxonox/LevelInfo.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/LevelInfo.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -114,7 +114,7 @@
/**
@brief
Set the starting ship models of the level
- @param tags
+ @param ships
A comma-seperated string of all the allowed ship models for the shipselection.
*/
void LevelInfoItem::setStartingShips(const std::string& ships)
@@ -243,12 +243,6 @@
RegisterClass(LevelInfo);
- /**
- @brief
-
- @param creator
- The creator of this object.
- */
LevelInfo::LevelInfo(Context* context) : BaseObject(context)
{
RegisterObject(LevelInfo);
Modified: code/trunk/src/orxonox/LevelInfo.h
===================================================================
--- code/trunk/src/orxonox/LevelInfo.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/LevelInfo.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -196,7 +196,6 @@
@author
Damian 'Mozork' Frick
- @edit
Matthias Hutter
@ingroup Orxonox
*/
@@ -246,7 +245,7 @@
{ return this->LevelInfoItem::getTags(); }
/**
@brief Set the starting ship models of the level
- @param A comma-seperated string of all the allowed ship models for the shipselection.
+ @param ships A comma-seperated string of all the allowed ship models for the shipselection.
*/
inline void setStartingShips(const std::string& ships)
{ this->LevelInfoItem::setStartingShips(ships); }
Modified: code/trunk/src/orxonox/chat/ChatHistory.h
===================================================================
--- code/trunk/src/orxonox/chat/ChatHistory.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/chat/ChatHistory.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -79,7 +79,7 @@
/** what to do with incoming chat
*
* \param message The incoming message
- * \param senderID Identification number of the sender
+ * \param name Name of the sender
*/
virtual void incomingChat(const std::string& message, const std::string& name) override;
Modified: code/trunk/src/orxonox/chat/ChatInputHandler.h
===================================================================
--- code/trunk/src/orxonox/chat/ChatInputHandler.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/chat/ChatInputHandler.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -119,7 +119,7 @@
static void activate_small_static();
/** \param message the message text
- * \param senderID ID of the player who sent the message
+ * \param name Name of the player who sent the message
*
* Deal with incoming chat (which means in our case: Add it to the
* history window of the full chat window)
Modified: code/trunk/src/orxonox/controllers/ActionpointController.h
===================================================================
--- code/trunk/src/orxonox/controllers/ActionpointController.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/controllers/ActionpointController.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -93,6 +93,8 @@
/**
@brief
XML method, example XML usage:
+
+ @code
<SpaceShip position="-2000, 1500, -1000" lookat="0,0,0" team=0 name="ss2">
<templates>
<Template link=spaceshipassff />
@@ -109,18 +111,21 @@
</DivisionController>
</controller>
</SpaceShip>
+ @endcode
Full description:
Adds an Actionpoint to this->actionpoints_. Actionpoint can take arguments like action="attack" attack="name".
For documentation on Actionpoint XML arguments, check out Actionpoint.h class
If any WorldEntity that is not Actionpoint or its child being sent to actionpoints through XML,
action would be assumed to be Action::FLY and target position to be position of the entity. Also, if not Actionpoint
- is passed, it is assumed to be in a loop. How it works is: in <actionpoints> first all Actionpoints between
+ is passed, it is assumed to be in a loop. How it works is: in \<actionpoints\> first all Actionpoints between
first Actionpoint with loopStart=true and first following Actionpoint with loopEnd=true are included in a single loop.
If they are adjacent (in the input array) with WorldEntity, then WorldEntity is also in a loop.
All the Worldentities are assumed to be in loop.
Loop example:
+
+ @code
<SpaceShip position="-1500, 1500, -1000" lookat="0,0,0" team=0 name="ss1">
<templates>
<Template link=spaceshipassff />
@@ -136,8 +141,11 @@
</DivisionController>
</controller>
</SpaceShip>
+ @endcode
other loop example:
+
+ @code
<SpaceShip position="-1500, -1500, -1500" lookat="0,0,0" team=0 name="ss1">
<templates>
<Template link=spaceshipassff />
@@ -152,10 +160,11 @@
</actionpoints>
</DivisionController>
</controller>
- </SpaceShip>
+ </SpaceShip>
+ @endcode
@note
- Don't use several loops, and don't use WorldEntities as input to <actionpoints> as I didn't test it well, but you
+ Don't use several loops, and don't use WorldEntities as input to \<actionpoints\> as I didn't test it well, but you
can try if feeling lucky.
*/
void addActionpoint(WorldEntity* actionpoint);
Modified: code/trunk/src/orxonox/controllers/ArtificialController.cc
===================================================================
--- code/trunk/src/orxonox/controllers/ArtificialController.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/controllers/ArtificialController.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -254,6 +254,7 @@
/**
@brief Adds first waypoint of type name to the waypoint stack, which is within the searchDistance
@param name object-name of a point of interest (e.g. "PickupSpawner", "ForceField")
+ @param searchDistance The maximum distance to search
*/
void ArtificialController::updatePointsOfInterest(std::string name, float searchDistance)
{
Modified: code/trunk/src/orxonox/controllers/MasterController.h
===================================================================
--- code/trunk/src/orxonox/controllers/MasterController.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/controllers/MasterController.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -43,12 +43,15 @@
Only one instance of MasterController is to be placed in level.
If no MasterController is initialized, none of ActionpointControllers will work.
Example:
+
+ @code
<Pawn position = "100000, 100000, 100000">
<controller>
<MasterController>
</MasterController>
</controller>
</Pawn>
+ @endcode
*/
class _OrxonoxExport MasterController : public Controller, public Tickable
{
Modified: code/trunk/src/orxonox/gametypes/Dynamicmatch.cc
===================================================================
--- code/trunk/src/orxonox/gametypes/Dynamicmatch.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/gametypes/Dynamicmatch.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -25,25 +25,7 @@
* ...
*
*/
-//TODO:
-//pig punkte vergeben pro Zeit!
-//killerfarbe schwarz; evtl. eigenes Raumfahrzeug;
-//Low; Codeoptimierung und Dokumentation
-/**
- at brief
- Short Gaming Manual:
- There are three different parties a player can belong to: victim, chaser or killer
- Every player starts as chaser. As long as there are not enough victims and killers, you can change your and other player's parties by shooting them.
- In order to win you have to earn as much points as possible:
- - as victim by escaping the chasers
- - as chaser by shooting the victim
- - as killer by killing the chasers
-
-
- What you shouldn't do is shooting at players of your own party. By doing so your score will decrease.
- P.S: If you don't want to be a victim: Get rid of your part by shooting a chaser.
-*/
#include "Dynamicmatch.h"
#include "util/Convert.h"
Modified: code/trunk/src/orxonox/gametypes/Dynamicmatch.h
===================================================================
--- code/trunk/src/orxonox/gametypes/Dynamicmatch.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/gametypes/Dynamicmatch.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -41,6 +41,25 @@
namespace orxonox
{
+ /**
+ @brief
+ Short Gaming Manual:
+ There are three different parties a player can belong to: victim, chaser or killer
+ Every player starts as chaser. As long as there are not enough victims and killers, you can change your and other player's parties by shooting them.
+ In order to win you have to earn as much points as possible:
+ - as victim by escaping the chasers
+ - as chaser by shooting the victim
+ - as killer by killing the chasers
+
+
+ What you shouldn't do is shooting at players of your own party. By doing so your score will decrease.
+ P.S: If you don't want to be a victim: Get rid of your part by shooting a chaser.
+
+ @todo:
+ pig punkte vergeben pro Zeit!
+ killerfarbe schwarz; evtl. eigenes Raumfahrzeug;
+ Low; Codeoptimierung und Dokumentation
+ */
class _OrxonoxExport Dynamicmatch : public Gametype
{
public:
Modified: code/trunk/src/orxonox/infos/GametypeInfo.cc
===================================================================
--- code/trunk/src/orxonox/infos/GametypeInfo.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/infos/GametypeInfo.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -377,7 +377,7 @@
Helper method. Sends changedSpawned notifiers over the network.
@param player
The player that has changed its spawned status.
- @param ready
+ @param spawned
The new spawned status.
*/
void GametypeInfo::setSpawnedHelper(PlayerInfo* player, bool spawned)
Modified: code/trunk/src/orxonox/interfaces/NotificationListener.cc
===================================================================
--- code/trunk/src/orxonox/interfaces/NotificationListener.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/interfaces/NotificationListener.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -101,7 +101,7 @@
The sender that sent the notification/command.
@param isCommand
Whether the message is a command or a notification.
- @param messageType
+ @param type
The type of the notification.
*/
/*static*/ void NotificationListener::sendHelper(const std::string& message, const std::string& sender, bool isCommand, NotificationMessageType type)
Modified: code/trunk/src/orxonox/interfaces/PlayerTrigger.h
===================================================================
--- code/trunk/src/orxonox/interfaces/PlayerTrigger.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/interfaces/PlayerTrigger.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -81,7 +81,7 @@
protected:
/**
@brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger.
- @param player A pointer to the Pawn that triggered the PlayerTrigger.
+ @param pawn A pointer to the Pawn that triggered the PlayerTrigger.
*/
void setTriggeringPawn(Pawn* pawn);
Modified: code/trunk/src/orxonox/items/Engine.h
===================================================================
--- code/trunk/src/orxonox/items/Engine.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/items/Engine.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -44,7 +44,7 @@
There are many parameters that can be specified:
- The <b>relativePosition</b>, specifies the position relative to the center of the SpaceShip the Engine is mounted on.
- - The <b>maximal speed</b>, there are four maximal speeds that can be specified: The <b>speedfront</b>, the maximal forward speed. The <b>speedback>, the maximal backward speed. The <b>speedleftright</b>, the maximal speed in y-direction of the SpaceShip coordinate frame. The <b>speedupdown</b>, the maximal speed in z-direction of the SpaceShip coordinate frame. All maximal speeds (naturally) have to be non-negative.
+ - The <b>maximal speed</b>, there are four maximal speeds that can be specified: The <b>speedfront</b>, the maximal forward speed. The <b>speedback</b>, the maximal backward speed. The <b>speedleftright</b>, the maximal speed in y-direction of the SpaceShip coordinate frame. The <b>speedupdown</b>, the maximal speed in z-direction of the SpaceShip coordinate frame. All maximal speeds (naturally) have to be non-negative.
- The <b>acceleration</b>, there are five types of acceleration that can be specified: The <b>accelerationfront</b>, the forward acceleration. The <b>accelerationbrake</b>, the braking acceleration. The <b>accelerationback</b>, the backward acceleration. The <b>accelerationleftright</b>, the acceleration in y-direction. The <b>accelerationupdown</b>, the acceleration in z-direction. All accelerations have to be non-negative.
- The <b>boostfactor</b>, specifies the factor by which boosting increases the speed. This has to be non-negative, as well. Beware that maximal speeds can be overcome through boosting.
- The <b>template</b>, the name of the engine template. Allows for parameters of the Engine be set trough a template.
@@ -212,7 +212,7 @@
/**
@brief Add to the additional forward speed factor.
- @param factor The speed that is added to the additional forward speed. Must be non-negative.
+ @param speed The speed that is added to the additional forward speed. Must be non-negative.
*/
inline void addSpeedAdd(float speed)
{ this->speedAdd_ += speed; }
Modified: code/trunk/src/orxonox/items/PartDestructionEvent.cc
===================================================================
--- code/trunk/src/orxonox/items/PartDestructionEvent.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/items/PartDestructionEvent.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -163,7 +163,7 @@
/**
@brief
Set type of the target
- @param param
+ @param type
The desired target-type as string. Valid target-types: ship engine weapon
*/
void PartDestructionEvent::setTargetType(std::string type)
@@ -196,7 +196,7 @@
@brief
Set the operation to be applied.
@param param
- The desired parameter as string. Valid parameters: c.f. @ref orxnox::PartDestructionEvent::TargetParam
+ The desired parameter as string. Valid parameters: c.f. @ref TargetParam
*/
void PartDestructionEvent::setTargetParam(std::string param)
{
Modified: code/trunk/src/orxonox/items/PartDestructionEvent.h
===================================================================
--- code/trunk/src/orxonox/items/PartDestructionEvent.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/items/PartDestructionEvent.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -80,7 +80,7 @@
/**
@brief
List of all allowed parameters.
- */
+ */
enum class TargetParam
{
shieldhealth,
Modified: code/trunk/src/orxonox/items/ShipPart.cc
===================================================================
--- code/trunk/src/orxonox/items/ShipPart.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/items/ShipPart.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -115,7 +115,7 @@
/**
@brief
Add a StaticEntity to the ShipPart.
- @param engine
+ @param entity
A pointer to the StaticEntity to be added.
*/
void ShipPart::addEntity(StaticEntity* entity)
@@ -157,7 +157,7 @@
/**
@brief
Add a PartDestructionEvent to the ShipPart.
- @param engine
+ @param event
A pointer to the PartDestructionEvent to be added.
*/
void ShipPart::addDestructionEvent(PartDestructionEvent* event)
Modified: code/trunk/src/orxonox/overlays/OrxonoxOverlay.cc
===================================================================
--- code/trunk/src/orxonox/overlays/OrxonoxOverlay.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/overlays/OrxonoxOverlay.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -125,8 +125,7 @@
This has to be called before usage, otherwise strange behaviour is
guaranteed! (there should be no segfaults however).
- @copydoc
- BaseObject::XMLPort()
+ @copydoc BaseObject::XMLPort()
*/
void OrxonoxOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
Modified: code/trunk/src/orxonox/overlays/OverlayGroup.cc
===================================================================
--- code/trunk/src/orxonox/overlays/OverlayGroup.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/overlays/OverlayGroup.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -84,8 +84,7 @@
/**
@brief
Loads the group and all its children OrxonoxOverlays.
- @copydoc
- BaseObject::XMLPort()
+ @copydoc BaseObject::XMLPort()
*/
void OverlayGroup::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
Modified: code/trunk/src/orxonox/weaponsystem/WeaponSlot.h
===================================================================
--- code/trunk/src/orxonox/weaponsystem/WeaponSlot.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/weaponsystem/WeaponSlot.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -47,6 +47,7 @@
<WeaponSlot position=" 15.0,-1.5,0" />
<WeaponSlot position=" 0, 0,0" />
</weaponslots>
+ @endcode
A WeaponSlot can be attached to a @ref orxonox::Pawn because WeaponSlot inherits from @ref orxonox::StaticEntity.
Modified: code/trunk/src/orxonox/weaponsystem/WeaponSystem.cc
===================================================================
--- code/trunk/src/orxonox/weaponsystem/WeaponSystem.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/weaponsystem/WeaponSystem.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -284,7 +284,7 @@
/**
@brief
- Fires the @ref Orxonox::WeaponSet with the specified firemode.
+ Fires the @ref orxonox::WeaponSet with the specified firemode.
*/
void WeaponSystem::fire(unsigned int firemode)
{
Modified: code/trunk/src/orxonox/worldentities/Actionpoint.h
===================================================================
--- code/trunk/src/orxonox/worldentities/Actionpoint.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/worldentities/Actionpoint.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -48,6 +48,7 @@
location.
Example XML code:
+ @code
<SpaceShip position="-2000, 1500, -1000" lookat="0,0,0" team=0 name="thisShipName">
<templates>
<Template link=spaceshipassff />
@@ -64,9 +65,11 @@
</DivisionController>
</controller>
</SpaceShip>
-
+ @endcode
+
Example with loops:
+ @code
<SpaceShip position="-1500, 1500, -1000" lookat="0,0,0" team=0 name="thisShipName">
<templates>
<Template link=spaceshipassff />
@@ -82,6 +85,7 @@
</DivisionController>
</controller>
</SpaceShip>
+ @endcode
One can also use other Worldentities instead of Actionpoints just like Waypoints, but those points
will be included in loop.
Modified: code/trunk/src/orxonox/worldentities/WorldEntity.h
===================================================================
--- code/trunk/src/orxonox/worldentities/WorldEntity.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/worldentities/WorldEntity.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -399,6 +399,8 @@
Virtual function that gets called when this object collides with another.
@param otherObject
The object this one has collided into.
+ @param ownCollisionShape
+ The collision shape of the other object
@param contactPoint
Contact point provided by Bullet. Holds more information and can me modified. See return value.
@return
Modified: code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.cc
===================================================================
--- code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -206,7 +206,7 @@
/**
@brief
Add a ShipPart to the SpaceShip.
- @param engine
+ @param part
A pointer to the ShipPart to be added.
*/
void ModularSpaceShip::addShipPart(ShipPart* part)
Modified: code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.h
===================================================================
--- code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.h 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.h 2016-01-27 17:50:51 UTC (rev 11099)
@@ -57,7 +57,7 @@
- The <b>lift</b> creates a more natural flight feeling through the addition of a lift force. There are again tow parameters that can be specified. The <b>lift</b> which is the lift force that is applied. And the <b>stallSpeed</b> which is the forward speed after which no more lift is generated.
As mentioned @ref orxonox::Engine Engines can be mounted on the ModularSpaceShip.
- In order to assign attached entities to a ShipPart, a ShipPart with the same name as the corresponding entity needs to be created in the <parts> tag.
+ In order to assign attached entities to a ShipPart, a ShipPart with the same name as the corresponding entity needs to be created in the \<parts\> tag.
Here is a (primitive) example of a ModularSpaceShip defined in XML:
@code
<ModularSpaceShip
Modified: code/trunk/src/orxonox/worldentities/pawns/Pawn.cc
===================================================================
--- code/trunk/src/orxonox/worldentities/pawns/Pawn.cc 2016-01-26 19:32:16 UTC (rev 11098)
+++ code/trunk/src/orxonox/worldentities/pawns/Pawn.cc 2016-01-27 17:50:51 UTC (rev 11099)
@@ -424,7 +424,7 @@
/**
@brief
- Check whether the Pawn has a @ref Orxonox::WeaponSystem and fire it with the specified firemode if it has one.
+ Check whether the Pawn has a @ref orxonox::WeaponSystem and fire it with the specified firemode if it has one.
*/
void Pawn::fired(unsigned int firemode)
More information about the Orxonox-commit
mailing list