hpp-fcl  3.0.0
HPP fork of FCL -- The Flexible Collision Library
BV_node.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011-2014, Willow Garage, Inc.
5  * Copyright (c) 2014-2015, 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 HPP_FCL_BV_NODE_H
39 #define HPP_FCL_BV_NODE_H
40 
41 #include <hpp/fcl/data_types.h>
42 #include <hpp/fcl/BV/BV.h>
43 
44 namespace hpp {
45 namespace fcl {
46 
50 
58 
62  unsigned int first_primitive;
63 
65  unsigned int num_primitives;
66 
69  : first_child(0),
70  first_primitive(
71  (std::numeric_limits<unsigned int>::max)()) // value we should help
72  // to raise an issue
73  ,
74  num_primitives(0) {}
75 
77  bool operator==(const BVNodeBase& other) const {
78  return first_child == other.first_child &&
79  first_primitive == other.first_primitive &&
80  num_primitives == other.num_primitives;
81  }
82 
84  bool operator!=(const BVNodeBase& other) const { return !(*this == other); }
85 
88  inline bool isLeaf() const { return first_child < 0; }
89 
92  inline int primitiveId() const { return -(first_child + 1); }
93 
96  inline int leftChild() const { return first_child; }
97 
100  inline int rightChild() const { return first_child + 1; }
101 };
102 
106 template <typename BV>
108  typedef BVNodeBase Base;
109 
111  BV bv;
112 
114  bool operator==(const BVNode& other) const {
115  return Base::operator==(other) && bv == other.bv;
116  }
117 
119  bool operator!=(const BVNode& other) const { return !(*this == other); }
120 
122  bool overlap(const BVNode& other) const { return bv.overlap(other.bv); }
124  bool overlap(const BVNode& other, const CollisionRequest& request,
125  FCL_REAL& sqrDistLowerBound) const {
126  return bv.overlap(other.bv, request, sqrDistLowerBound);
127  }
128 
131  FCL_REAL distance(const BVNode& other, Vec3f* P1 = NULL,
132  Vec3f* P2 = NULL) const {
133  return bv.distance(other.bv, P1, P2);
134  }
135 
137  Vec3f getCenter() const { return bv.center(); }
138 
140  const Matrix3f& getOrientation() const {
141  static const Matrix3f id3 = Matrix3f::Identity();
142  return id3;
143  }
144 
146  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
148 };
149 
150 template <>
151 inline const Matrix3f& BVNode<OBB>::getOrientation() const {
152  return bv.axes;
153 }
154 
155 template <>
156 inline const Matrix3f& BVNode<RSS>::getOrientation() const {
157  return bv.axes;
158 }
159 
160 template <>
162  return bv.obb.axes;
163 }
164 
165 } // namespace fcl
166 
167 } // namespace hpp
168 
169 #endif
#define HPP_FCL_DLLAPI
Definition: config.hh:88
int first_child
An index for first child node or primitive If the value is positive, it is the index of the first chi...
Definition: BV_node.h:57
bool operator!=(const BVNodeBase &other) const
Difference operator.
Definition: BV_node.h:84
bool operator!=(const BVNode &other) const
Difference operator.
Definition: BV_node.h:119
unsigned int first_primitive
The start id the primitive belonging to the current node. The index is referred to the primitive_indi...
Definition: BV_node.h:62
int rightChild() const
Return the index of the second child. The index is referred to the bounding volume array (i....
Definition: BV_node.h:100
int leftChild() const
Return the index of the first child. The index is referred to the bounding volume array (i....
Definition: BV_node.h:96
FCL_REAL distance(const BVNode &other, Vec3f *P1=NULL, Vec3f *P2=NULL) const
Compute the distance between two BVNode. P1 and P2, if not NULL and the underlying BV supports distan...
Definition: BV_node.h:131
BV bv
bounding volume storing the geometry
Definition: BV_node.h:111
BVNodeBase()
Default constructor.
Definition: BV_node.h:68
bool operator==(const BVNodeBase &other) const
Equality operator.
Definition: BV_node.h:77
bool operator==(const BVNode &other) const
Equality operator.
Definition: BV_node.h:114
const Matrix3f & getOrientation() const
Access to the orientation of the BV.
Definition: BV_node.h:140
BVNodeBase Base
Definition: BV_node.h:108
unsigned int num_primitives
The number of primitives belonging to the current node.
Definition: BV_node.h:65
Vec3f getCenter() const
Access to the center of the BV.
Definition: BV_node.h:137
bool isLeaf() const
Whether current node is a leaf node (i.e. contains a primitive index.
Definition: BV_node.h:88
int primitiveId() const
Return the primitive index. The index is referred to the original data (i.e. vertices or tri_indices)...
Definition: BV_node.h:92
bool overlap(const BVNode &other) const
Check whether two BVNode collide.
Definition: BV_node.h:122
bool overlap(const BVNode &other, const CollisionRequest &request, FCL_REAL &sqrDistLowerBound) const
Check whether two BVNode collide.
Definition: BV_node.h:124
Eigen::Matrix< FCL_REAL, 3, 3 > Matrix3f
Definition: data_types.h:71
Eigen::Matrix< FCL_REAL, 3, 1 > Vec3f
Definition: data_types.h:67
double FCL_REAL
Definition: data_types.h:66
Main namespace.
Definition: broadphase_bruteforce.h:44
BVNodeBase encodes the tree structure for BVH.
Definition: BV_node.h:52
A class describing a bounding volume node. It includes the tree structure providing in BVNodeBase and...
Definition: BV_node.h:107
request to the collision algorithm
Definition: collision_data.h:312