Changeset 9892 in orxonox.OLD for branches/coll_rect/src/lib/collision_reaction/collision_tube.h

Timestamp:

Oct 14, 2006, 1:25:47 AM (18 years ago)

Author:

patrick

Message:

new interface to collision registers, more transparent. some more functionality

File:

• branches/coll_rect/src/lib/collision_reaction/collision_tube.h (modified) (3 diffs)

branches/coll_rect/src/lib/collision_reaction/collision_tube.h

@@ -3 +3 @@
  *
  * collision tube collects all collisions from all entities
+ *
+ *  The collision events are saved in the _collisionList vector in a fixed hirarchy: a collision is defined by the world entities
+ *  that collide. For each collision there is an entry in _collisionList. Each collision itself again contains collision events which are
+ *  defined as collisions between the boundibg volumes (BV) of the world entities. This could look like this:
+ *
+ *  - Collision (WorldEntity_i  <=> WorldEntity_j)
+ *     +- CollisionEvent( some BV <=> some other BV)
+ *     +- CollisionEvent( some BV <=> some other BV)
+ *  - Collision (WorldEntity_k <=> WorldEntity_l)
+ *     +- CollisionEvent( some BV <=> some other BV)
+ *     +- CollisionEvent( some BV <=> some other BV)
+ *     +- CollisionEvent( some BV <=> some other BV)
+ *     +- CollisionEvent( some BV <=> some other BV)
+ *  - ... etc ...
+ *
+ *
+ *  When the collisions are processed by the handleCollision() function each collision pair is checked for their reactions (since each
+ *  WorldEntity can define several reactions to a collision). After all the reactions are calculated and applied the collision object is
+ *  put back.
  */
 
@@ -24 +43 @@
   class CollisionReaction;
 
-  //! A class for defining collision reactions and storing events
+  //! A class containing all CollisionEvents (structured as defined in the file doxygen tags)
   class CollisionTube : public BaseObject
   {
@@ -32 +51 @@
   public:
     CollisionTube();
-    ~CollisionTube();
+    virtual ~CollisionTube();
 
     /** @returns true if at least one of both WorldEntities are subscribed for a collision check */