BV_node.h 4.75 KB
Newer Older
sachinc's avatar
sachinc committed
1
2
3
/*
 * Software License Agreement (BSD License)
 *
4
5
 *  Copyright (c) 2011-2014, Willow Garage, Inc.
 *  Copyright (c) 2014-2015, Open Source Robotics Foundation
sachinc's avatar
sachinc committed
6
7
8
9
10
11
12
13
14
15
16
17
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
18
 *   * Neither the name of Open Source Robotics Foundation nor the names of its
sachinc's avatar
sachinc committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

/** \author Jia Pan */


Joseph Mirabel's avatar
Joseph Mirabel committed
39
40
#ifndef HPP_FCL_BV_NODE_H
#define HPP_FCL_BV_NODE_H
sachinc's avatar
sachinc committed
41

42
#include <hpp/fcl/data_types.h>
jpan's avatar
   
jpan committed
43

44
#include <hpp/fcl/BV/BV.h>
jpan's avatar
jpan committed
45
#include <iostream>
jpan's avatar
   
jpan committed
46

47
48
namespace hpp
{
sachinc's avatar
sachinc committed
49
50
51
namespace fcl
{

52
53
54
55
/// @defgroup Construction_Of_BVH 
/// regroup class which are used to build BVH (Bounding Volume Hierarchy)
/// @{

jpan's avatar
jpan committed
56
/// @brief BVNodeBase encodes the tree structure for BVH
jpan's avatar
   
jpan committed
57
struct BVNodeBase
sachinc's avatar
sachinc committed
58
{
jpan's avatar
jpan committed
59
60
61
62
  /// @brief An index for first child node or primitive
  /// If the value is positive, it is the index of the first child bv node
  /// If the value is negative, it is -(primitive index + 1)
  /// Zero is not used.
sachinc's avatar
sachinc committed
63
64
  int first_child;

jpan's avatar
jpan committed
65
66
  /// @brief The start id the primitive belonging to the current node. The index is referred to the primitive_indices in BVHModel and from that
  /// we can obtain the primitive's index in original data indirectly.
sachinc's avatar
sachinc committed
67
68
  int first_primitive;

jpan's avatar
jpan committed
69
  /// @brief The number of primitives belonging to the current node 
sachinc's avatar
sachinc committed
70
71
  int num_primitives;

jpan's avatar
jpan committed
72
  /// @brief Whether current node is a leaf node (i.e. contains a primitive index
jpan's avatar
   
jpan committed
73
  inline bool isLeaf() const { return first_child < 0; }
sachinc's avatar
sachinc committed
74

jpan's avatar
jpan committed
75
  /// @brief Return the primitive index. The index is referred to the original data (i.e. vertices or tri_indices) in BVHModel
jpan's avatar
   
jpan committed
76
  inline int primitiveId() const { return -(first_child + 1); }
sachinc's avatar
sachinc committed
77

jpan's avatar
jpan committed
78
  /// @brief Return the index of the first child. The index is referred to the bounding volume array (i.e. bvs) in BVHModel
jpan's avatar
   
jpan committed
79
  inline int leftChild() const { return first_child; }
sachinc's avatar
sachinc committed
80

jpan's avatar
jpan committed
81
  /// @brief Return the index of the second child. The index is referred to the bounding volume array (i.e. bvs) in BVHModel
jpan's avatar
   
jpan committed
82
83
84
  inline int rightChild() const { return first_child + 1; }
};

jpan's avatar
jpan committed
85
/// @brief A class describing a bounding volume node. It includes the tree structure providing in BVNodeBase and also the geometry data provided in BV template parameter.
jpan's avatar
   
jpan committed
86
87
88
template<typename BV>
struct BVNode : public BVNodeBase
{
jpan's avatar
jpan committed
89
  /// @brief bounding volume storing the geometry
jpan's avatar
   
jpan committed
90
  BV bv;
sachinc's avatar
sachinc committed
91

jpan's avatar
jpan committed
92
  /// @brief Check whether two BVNode collide
sachinc's avatar
sachinc committed
93
94
95
96
  bool overlap(const BVNode& other) const
  {
    return bv.overlap(other.bv);
  }
97
  /// @brief Check whether two BVNode collide
98
99
  bool overlap(const BVNode& other, const CollisionRequest& request,
               FCL_REAL& sqrDistLowerBound) const
100
  {
101
    return bv.overlap(other.bv, request, sqrDistLowerBound);
102
  }
sachinc's avatar
sachinc committed
103

jpan's avatar
jpan committed
104
  /// @brief Compute the distance between two BVNode. P1 and P2, if not NULL and the underlying BV supports distance, return the nearest points.
105
  FCL_REAL distance(const BVNode& other, Vec3f* P1 = NULL, Vec3f* P2 = NULL) const
sachinc's avatar
sachinc committed
106
107
108
109
  {
    return bv.distance(other.bv, P1, P2);
  }

jpan's avatar
jpan committed
110
111
112
113
  /// @brief Access the center of the BV
  Vec3f getCenter() const { return bv.center(); }

  /// @brief Access the orientation of the BV
114
  const Matrix3f& getOrientation() const { return Matrix3f::Identity(); }
jpan's avatar
   
jpan committed
115
116
117
};

template<>
118
inline const Matrix3f& BVNode<OBB>::getOrientation() const 
jpan's avatar
   
jpan committed
119
{
Joseph Mirabel's avatar
Joseph Mirabel committed
120
  return bv.axes;
jpan's avatar
jpan committed
121
}
jpan's avatar
   
jpan committed
122
123

template<>
124
inline const Matrix3f& BVNode<RSS>::getOrientation() const 
jpan's avatar
   
jpan committed
125
{
Joseph Mirabel's avatar
Joseph Mirabel committed
126
  return bv.axes;
jpan's avatar
jpan committed
127
}
jpan's avatar
   
jpan committed
128

jpan's avatar
jpan committed
129
template<>
130
inline const Matrix3f& BVNode<OBBRSS>::getOrientation() const 
jpan's avatar
jpan committed
131
{
Joseph Mirabel's avatar
Joseph Mirabel committed
132
  return bv.obb.axes;
jpan's avatar
jpan committed
133
}
jpan's avatar
   
jpan committed
134

sachinc's avatar
sachinc committed
135
136
137

}

138
139
} // namespace hpp

sachinc's avatar
sachinc committed
140
#endif