Changeset 10437 for code/trunk/src/orxonox/worldentities/StaticEntity.h

Timestamp:

May 8, 2015, 12:17:03 AM (9 years ago)

Author:

fvultier

Message:

Removed unnecessary output to console in kump minigame. Added a small description to some classes often used by PPS students: Pawn, StaticEntity, MobileEntity, ControllableEntity.

File:

• code/trunk/src/orxonox/worldentities/StaticEntity.h (modified) (1 diff)

code/trunk/src/orxonox/worldentities/StaticEntity.h

@@ -36 +36 @@
 namespace orxonox
 {
+    /**
+    @brief
+        The StaticEntity is the simplest derivative of the @ref orxonox::WorldEntity class. This means all StaticEntity instances also have
+        a position in space, a mass, a scale, a frication, ... because every StaticEntity is a WorldEntity. You can attach StaticEntities to eachother ike @ref orxonox::WorldEntity WorldEntities.
+
+        In contrast to the MobileEntity the StaticEntity cannot move with respect to the parent to which it is attached. That's why
+        it is called StaticEntity. It will keep the same position (always with respect to its parent) forever unless you call the
+        function @see setPosition to changee it.
+    */
+
     class _OrxonoxExport StaticEntity : public WorldEntity
     {