Changeset 9888 in orxonox.OLD for branches/coll_rect/src/lib/collision_reaction/collision.h

Timestamp:

Oct 13, 2006, 2:33:30 PM (18 years ago)

Author:

patrick

Message:

new structure in docs

File:

• branches/coll_rect/src/lib/collision_reaction/collision.h (modified) (1 diff)

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

@@ -1 +1 @@
 /*!
  * @file collision.h
- *  Definition of a collision as a two WE hit each other
+ *  Definition of a collision relation of two WorldEntities
  *
- *  A is shared between two WorldEntity's CollisionHandles if both are subscribed to this event. In this case only one
+ *  Is shared between two WorldEntity's CollisionHandles if both are subscribed to this event. In this case only one
  *  of the two CollisionHandles will calculate the CollisionReaction and the bDispatched flag will be set afterwards
  *  to signal that it's already cared about and should be ignored.
+ *
+ *  The collisions itself are saved in this container (CollisionEvent). Since there can be multiple collision events
+ *  for one collision. Imagine: two objects are intersecting (this throws a Collision): many collision boxes will fire
+ *  each of this boxes will "create" a CollisionEvent.
  */