FCL  0.6.0
Flexible Collision Library
distance_traversal_node_base.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_TRAVERSAL_DISTANCERAVERSALNODEBASE_H
39 #define FCL_TRAVERSAL_DISTANCERAVERSALNODEBASE_H
40 
41 #include "fcl/narrowphase/detail/traversal/traversal_node_base.h"
42 #include "fcl/narrowphase/distance_request.h"
43 #include "fcl/narrowphase/distance_result.h"
44 
45 namespace fcl
46 {
47 
48 namespace detail
49 {
50 
52 template <typename S>
54 {
55 public:
57 
58  virtual ~DistanceTraversalNodeBase();
59 
61  virtual S BVTesting(int b1, int b2) const;
62 
64  virtual void leafTesting(int b1, int b2) const;
65 
67  virtual bool canStop(S c) const;
68 
70  void enableStatistics(bool enable);
71 
74 
77 
80 };
81 
82 } // namespace detail
83 } // namespace fcl
84 
85 #include "fcl/narrowphase/detail/traversal/distance/distance_traversal_node_base-inl.h"
86 
87 #endif
virtual S BVTesting(int b1, int b2) const
BV test between b1 and b2.
Definition: distance_traversal_node_base-inl.h:70
Main namespace.
Definition: broadphase_bruteforce-inl.h:45
Node structure encoding the information required for traversal.
Definition: traversal_node_base.h:51
distance result
Definition: distance_request.h:48
Node structure encoding the information required for distance traversal.
Definition: distance_traversal_node_base.h:53
virtual bool canStop(S c) const
Check whether the traversal can stop.
Definition: distance_traversal_node_base-inl.h:84
virtual void leafTesting(int b1, int b2) const
Leaf test between node b1 and b2, if they are both leafs.
Definition: distance_traversal_node_base-inl.h:77
DistanceRequest< S > request
request setting for distance
Definition: distance_traversal_node_base.h:73
DistanceResult< S > * result
distance result kept during the traversal iteration
Definition: distance_traversal_node_base.h:76
request to the distance computation
Definition: distance_request.h:52
bool enable_statistics
Whether stores statistics.
Definition: distance_traversal_node_base.h:79
void enableStatistics(bool enable)
Whether store some statistics information during traversal.
Definition: distance_traversal_node_base-inl.h:91