FCL  0.6.0
Flexible Collision Library
broadphase_collision_manager.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011-2014, Willow Garage, Inc.
5  * Copyright (c) 2014-2016, Open Source Robotics Foundation
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of Open Source Robotics Foundation nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
38 #ifndef FCL_BROADPHASE_BROADPHASECOLLISIONMANAGER_H
39 #define FCL_BROADPHASE_BROADPHASECOLLISIONMANAGER_H
40 
41 #include <set>
42 #include <vector>
43 
44 #include "fcl/narrowphase/collision_object.h"
45 
46 namespace fcl
47 {
48 
51 template <typename S>
52 using CollisionCallBack = bool (*)(
53  CollisionObject<S>* o1, CollisionObject<S>* o2, void* cdata);
54 
57 template <typename S>
58 using DistanceCallBack = bool (*)(
60  CollisionObject<S>* o2, void* cdata, S& dist);
61 
65 template <typename S>
67 {
68 public:
70 
71  virtual ~BroadPhaseCollisionManager();
72 
74  virtual void registerObjects(const std::vector<CollisionObject<S>*>& other_objs);
75 
77  virtual void registerObject(CollisionObject<S>* obj) = 0;
78 
80  virtual void unregisterObject(CollisionObject<S>* obj) = 0;
81 
83  virtual void setup() = 0;
84 
86  virtual void update() = 0;
87 
89  virtual void update(CollisionObject<S>* updated_obj);
90 
92  virtual void update(const std::vector<CollisionObject<S>*>& updated_objs);
93 
95  virtual void clear() = 0;
96 
98  virtual void getObjects(std::vector<CollisionObject<S>*>& objs) const = 0;
99 
101  virtual void collide(CollisionObject<S>* obj, void* cdata, CollisionCallBack<S> callback) const = 0;
102 
104  virtual void distance(CollisionObject<S>* obj, void* cdata, DistanceCallBack<S> callback) const = 0;
105 
107  virtual void collide(void* cdata, CollisionCallBack<S> callback) const = 0;
108 
110  virtual void distance(void* cdata, DistanceCallBack<S> callback) const = 0;
111 
113  virtual void collide(BroadPhaseCollisionManager* other_manager, void* cdata, CollisionCallBack<S> callback) const = 0;
114 
116  virtual void distance(BroadPhaseCollisionManager* other_manager, void* cdata, DistanceCallBack<S> callback) const = 0;
117 
119  virtual bool empty() const = 0;
120 
122  virtual size_t size() const = 0;
123 
124 protected:
125 
127  mutable std::set<std::pair<CollisionObject<S>*, CollisionObject<S>*> > tested_set;
128  mutable bool enable_tested_set_;
129 
130  bool inTestedSet(CollisionObject<S>* a, CollisionObject<S>* b) const;
131 
132  void insertTestedSet(CollisionObject<S>* a, CollisionObject<S>* b) const;
133 
134 };
135 
138 
139 } // namespace fcl
140 
141 #include "fcl/broadphase/broadphase_collision_manager-inl.h"
142 
143 #endif
Main namespace.
Definition: broadphase_bruteforce-inl.h:45
virtual size_t size() const =0
the number of objects managed by the manager
virtual void setup()=0
initialize the manager, related with the specific type of manager
virtual void collide(CollisionObject< S > *obj, void *cdata, CollisionCallBack< S > callback) const =0
perform collision test between one object and all the objects belonging to the manager ...
virtual void unregisterObject(CollisionObject< S > *obj)=0
remove one object from the manager
std::set< std::pair< CollisionObject< S > *, CollisionObject< S > * > > tested_set
tools help to avoid repeating collision or distance callback for the pairs of objects tested before...
Definition: broadphase_collision_manager.h:127
virtual void registerObjects(const std::vector< CollisionObject< S > * > &other_objs)
add objects to the manager
Definition: broadphase_collision_manager-inl.h:66
virtual void registerObject(CollisionObject< S > *obj)=0
add one object to the manager
bool(*)(CollisionObject< S > *o1, CollisionObject< S > *o2, void *cdata) CollisionCallBack
Callback for collision between two objects. Return value is whether can stop now. ...
Definition: broadphase_collision_manager.h:53
virtual void update()=0
update the condition of manager
bool(*)(CollisionObject< S > *o1, CollisionObject< S > *o2, void *cdata, S &dist) DistanceCallBack
Callback for distance between two objects, Return value is whether can stop now, also return the mini...
Definition: broadphase_collision_manager.h:60
virtual void distance(CollisionObject< S > *obj, void *cdata, DistanceCallBack< S > callback) const =0
perform distance computation between one object and all the objects belonging to the manager ...
virtual void clear()=0
clear the manager
the object for collision or distance computation, contains the geometry and the transform information...
Definition: collision_object.h:51
Base class for broad phase collision. It helps to accelerate the collision/distance between N objects...
Definition: broadphase_collision_manager.h:66
virtual void getObjects(std::vector< CollisionObject< S > * > &objs) const =0
return the objects managed by the manager
virtual bool empty() const =0
whether the manager is empty