FCL  0.6.0
Flexible Collision Library
broadphase_SSaP.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_BROAD_PHASE_SSAP_H
39 #define FCL_BROAD_PHASE_SSAP_H
40 
41 #include <vector>
42 #include "fcl/broadphase/broadphase_collision_manager.h"
43 
44 namespace fcl
45 {
46 
48 template <typename S>
50 {
51 public:
53 
56 
59 
61  void setup();
62 
64  void update();
65 
67  void clear();
68 
70  void getObjects(std::vector<CollisionObject<S>*>& objs) const;
71 
73  void collide(CollisionObject<S>* obj, void* cdata, CollisionCallBack<S> callback) const;
74 
76  void distance(CollisionObject<S>* obj, void* cdata, DistanceCallBack<S> callback) const;
77 
79  void collide(void* cdata, CollisionCallBack<S> callback) const;
80 
82  void distance(void* cdata, DistanceCallBack<S> callback) const;
83 
85  void collide(BroadPhaseCollisionManager<S>* other_manager, void* cdata, CollisionCallBack<S> callback) const;
86 
88  void distance(BroadPhaseCollisionManager<S>* other_manager, void* cdata, DistanceCallBack<S> callback) const;
89 
91  bool empty() const;
92 
94  size_t size() const;
95 
96 protected:
98  bool checkColl(typename std::vector<CollisionObject<S>*>::const_iterator pos_start, typename std::vector<CollisionObject<S>*>::const_iterator pos_end,
99  CollisionObject<S>* obj, void* cdata, CollisionCallBack<S> callback) const;
100 
102  bool checkDis(typename std::vector<CollisionObject<S>*>::const_iterator pos_start, typename std::vector<CollisionObject<S>*>::const_iterator pos_end,
103  CollisionObject<S>* obj, void* cdata, DistanceCallBack<S> callback, S& min_dist) const;
104 
105  bool collide_(CollisionObject<S>* obj, void* cdata, CollisionCallBack<S> callback) const;
106 
107  bool distance_(CollisionObject<S>* obj, void* cdata, DistanceCallBack<S> callback, S& min_dist) const;
108 
109  static size_t selectOptimalAxis(
110  const std::vector<CollisionObject<S>*>& objs_x,
111  const std::vector<CollisionObject<S>*>& objs_y,
112  const std::vector<CollisionObject<S>*>& objs_z,
113  typename std::vector<CollisionObject<S>*>::const_iterator& it_beg,
114  typename std::vector<CollisionObject<S>*>::const_iterator& it_end);
115 
117  std::vector<CollisionObject<S>*> objs_x;
118 
120  std::vector<CollisionObject<S>*> objs_y;
121 
123  std::vector<CollisionObject<S>*> objs_z;
124 
126  bool setup_;
127 };
128 
131 
132 } // namespace fcl
133 
134 #include "fcl/broadphase/broadphase_SSaP-inl.h"
135 
136 #endif
void distance(CollisionObject< S > *obj, void *cdata, DistanceCallBack< S > callback) const
perform distance computation between one object and all the objects belonging to the manager ...
Definition: broadphase_SSaP-inl.h:303
void collide(CollisionObject< S > *obj, void *cdata, CollisionCallBack< S > callback) const
perform collision test between one object and all the objects belonging to the manager ...
Definition: broadphase_SSaP-inl.h:245
size_t size() const
the number of objects managed by the manager
Definition: broadphase_SSaP-inl.h:588
void getObjects(std::vector< CollisionObject< S > * > &objs) const
return the objects managed by the manager
Definition: broadphase_SSaP-inl.h:197
Main namespace.
Definition: broadphase_bruteforce-inl.h:45
void unregisterObject(CollisionObject< S > *obj)
add one object to the manager
Definition: broadphase_SSaP-inl.h:101
bool setup_
tag about whether the environment is maintained suitably (i.e., the objs_x, objs_y, objs_z are sorted correctly
Definition: broadphase_SSaP.h:126
std::vector< CollisionObject< S > * > objs_x
Objects sorted according to lower x value.
Definition: broadphase_SSaP.h:117
static size_t selectOptimalAxis(const std::vector< CollisionObject< S > * > &objs_x, const std::vector< CollisionObject< S > * > &objs_y, const std::vector< CollisionObject< S > * > &objs_z, typename std::vector< CollisionObject< S > * >::const_iterator &it_beg, typename std::vector< CollisionObject< S > * >::const_iterator &it_end)
Definition: broadphase_SSaP-inl.h:412
bool checkColl(typename std::vector< CollisionObject< S > * >::const_iterator pos_start, typename std::vector< CollisionObject< S > * >::const_iterator pos_end, CollisionObject< S > *obj, void *cdata, CollisionCallBack< S > callback) const
check collision between one object and a list of objects, return value is whether stop is possible ...
Definition: broadphase_SSaP-inl.h:205
std::vector< CollisionObject< S > * > objs_z
Objects sorted according to lower z value.
Definition: broadphase_SSaP.h:123
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
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
bool empty() const
whether the manager is empty
Definition: broadphase_SSaP-inl.h:581
void clear()
clear the manager
Definition: broadphase_SSaP-inl.h:187
Simple SAP collision manager.
Definition: broadphase_SSaP.h:49
bool checkDis(typename std::vector< CollisionObject< S > * >::const_iterator pos_start, typename std::vector< CollisionObject< S > * >::const_iterator pos_end, CollisionObject< S > *obj, void *cdata, DistanceCallBack< S > callback, S &min_dist) const
check distance between one object and a list of objects, return value is whether stop is possible ...
Definition: broadphase_SSaP-inl.h:225
void update()
update the condition of manager
Definition: broadphase_SSaP-inl.h:179
the object for collision or distance computation, contains the geometry and the transform information...
Definition: collision_object.h:51
std::vector< CollisionObject< S > * > objs_y
Objects sorted according to lower y value.
Definition: broadphase_SSaP.h:120
Base class for broad phase collision. It helps to accelerate the collision/distance between N objects...
Definition: broadphase_collision_manager.h:66
void setup()
initialize the manager, related with the specific type of manager
Definition: broadphase_SSaP-inl.h:166
void registerObject(CollisionObject< S > *obj)
remove one object from the manager
Definition: broadphase_SSaP-inl.h:156