Changeset 9896 in orxonox.OLD for branches/coll_rect/src/lib/collision_reaction/collision_filter.h

Timestamp:

Oct 20, 2006, 1:09:03 AM (18 years ago)

Author:

patrick

Message:

more design, thinner interface

File:

• branches/coll_rect/src/lib/collision_reaction/collision_filter.h (modified) (2 diffs)

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

@@ -1 +1 @@
 /*!
- * @file collision_handle.h
- * @brief Definition of a collision handle: used for accessing per world entity collision events and reactions
+ * @file collision_filter.h
+ * @brief Definition of a collision filter: checks if a certain WorldEntity is responsive for another WorldEntity
+ *
 */
 
@@ -24 +25 @@
 
 
-  //! A class for defining collision reactions and storing events
+  /**
+   * A class for defining collision reactions and storing events (functional object)
+   *
+   * This class basically checks if the owner of this filter (a WorldEntity) is responsive for a certain other WorldEntity.
+   * The check is performed via the operator() (therefore it's a functional objects). For each CollisionReaction there is a list
+   * of WorldEntities (their ClassIDs) to which it listens to.
+   */
   class CollisionFilter : public BaseObject
   {
     ObjectListDeclaration(CollisionFilter);
 
+
+    /* Constructor/Deconstructors */
   public:
-    CollisionFilter(WorldEntity* owner, CREngine::ReactionType type);
+    CollisionFilter(WorldEntity* owner);
     virtual ~CollisionFilter();
 
-    void reset();
-
-    void addTarget(const ClassID& target);
-
-    /** @returns true if regiestered some new collision events in this tick frame */
-    inline bool isCollided() const { return this->bCollided; }
-    /** @returns true if this collision handle has already been dispatched */
-    inline bool isDispatched() const { return this->bDispatched; }
-    /** @returns true if this handle should be pulled also if there are no collisions */
-    inline bool isContinuousPoll() const { return this->bContinuousPoll; }
-    /** @returns the type */
-    inline CREngine::ReactionType getType() const { return this->type; }
-
-    void handleCollisions();
+  private:
+    CollisionFilter(const CollisionFilter& collisionFilter) {}
+    WorldEntity*                  _owner;                   //!< the worldenity this reaction will be applied on
 
 
-  private:
-    void flushCollisions();
-    bool filterCollisionEvent(CollisionEvent* collisionEvent);
-    bool filterCollision(Collision* collision);
+    /* Defines Operators */
+    bool operator()(const WorldEntity* entity) const;
 
 
+    /* Collision Reaction subscription unsubscription Block */
+  public:
+    void subscribeReaction(CoRe::CREngine::ReactionType type, const ClassID& target1);
+    void subscribeReaction(CoRe::CREngine::ReactionType type, const ClassID& target1, const ClassID& target2);
+    void subscribeReaction(CoRe::CREngine::ReactionType type, const ClassID& target1, const ClassID& target2, const ClassID& target3);
+
+    void unsubscribeReaction(CoRe::CREngine::ReactionType type);
+    void unsubscribeReactions();
 
   private:
-    WorldEntity*                  owner;                   //!< the worldenity this reaction will be applied on
-    CREngine::ReactionType              type;                    //!< the reaction type
+    std::vector<ClassID>          _filters[CREngine::CR_NUMBER];  //!< an array of filter targets: for each collision type a list of filter objects
 
-    bool                          bContinuousPoll;         //!< if this is true
-    bool                          bDispatched;             //!< true if this handle has already been dispatched
-    bool                          bStopOnFirstCollision;   //!< true if the cd of this object should be terminated after one match
-    bool                          bCollided;               //!< true if the CollsionHandle has registered some new collisions
 
-    std::vector<Collision*>       collisionList;           //!< a list full of collisions
-    std::vector<ClassID>          targetList;              //!< a list of target classes for filtering @TODO TAKE SET INSTEAD OF VECTOR HERE
+    /* Misc State Informations */
+  public:
+    /** @returns true if this handle should be pulled also if there are no collisions, can also be set with this function (reference)*/
+    inline bool& bContinousPoll() { return this->_bContinuousPoll; }
+    /** @returns true if this filter should be pulled always */
+    inline bool bContinousPoll() const { return this->_bContinuousPoll; }
+    /** @returns true if this @param type Collision Reaction type is a valid number */
+    inline bool validCRType(const CREngine::ReactionType& type) const {return (type >= 0 && type < CREngine::CR_NUMBER); }
+    /** @returns true if this filter is reactive i.e. at least one filter criterion installed */
+    inline bool bReactive() const { return this->_bReactive; }
 
-    CollisionReaction*            collisionReaction;       //!< reference to the collision reaction object
+  private:
+    bool                          _bContinuousPoll;         //!< if this is true
+    bool                          _bStopOnFirstCollision;   //!< true if the cd of this object should be terminated after one match
+    bool                          _bReactive;               //!< true if this class has at least one filter criterion == one target
 
   };