Main MRPT website > C++ reference
MRPT logo
Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
Eigen::KdBVH< _Scalar, _Dim, _Object > Class Template Reference

Detailed Description

template<typename _Scalar, int _Dim, typename _Object>
class Eigen::KdBVH< _Scalar, _Dim, _Object >

A simple bounding volume hierarchy based on AlignedBox.

Parameters:
_ScalarThe underlying scalar type of the bounding boxes
_DimThe dimension of the space in which the hierarchy lives
_ObjectThe object type that lives in the hierarchy. It must have value semantics. Either internal::bounding_box(_Object) must be defined and return an AlignedBox<_Scalar, _Dim> or bounding boxes must be provided to the tree initializer.

This class provides a simple (as opposed to optimized) implementation of a bounding volume hierarchy analogous to a Kd-tree. Given a sequence of objects, it computes their bounding boxes, constructs a Kd-tree of their centers and builds a BVH with the structure of that Kd-tree. When the elements of the tree are too expensive to be copied around, it is useful for _Object to be a pointer.

Definition at line 81 of file BVH.

List of all members.

Classes

struct  VectorComparator

Public Types

enum  { Dim = _Dim }
typedef _Object Object
typedef std::vector< Object,
aligned_allocator< Object > > 
ObjectList
typedef _Scalar Scalar
typedef AlignedBox< Scalar, Dim > Volume
typedef std::vector< Volume,
aligned_allocator< Volume > > 
VolumeList
typedef int Index
typedef const int * VolumeIterator
typedef const ObjectObjectIterator

Public Member Functions

 KdBVH ()
template<typename Iter >
 KdBVH (Iter begin, Iter end)
 Given an iterator range over Object references, constructs the BVH.
template<typename OIter , typename BIter >
 KdBVH (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)
 Given an iterator range over Object references and an iterator range over their bounding boxes, constructs the BVH.
template<typename Iter >
void init (Iter begin, Iter end)
 Given an iterator range over Object references, constructs the BVH, overwriting whatever is in there currently.
template<typename OIter , typename BIter >
void init (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)
 Given an iterator range over Object references and an iterator range over their bounding boxes, constructs the BVH, overwriting whatever is in there currently.
Index getRootIndex () const
EIGEN_STRONG_INLINE void getChildren (Index index, VolumeIterator &outVBegin, VolumeIterator &outVEnd, ObjectIterator &outOBegin, ObjectIterator &outOEnd) const
 Given an index of a node, on exit, outVBegin and outVEnd range over the indices of the volume children of the node and outOBegin and outOEnd range over the object children of the node.
const VolumegetVolume (Index index) const

Private Types

typedef
internal::vector_int_pair
< Scalar, Dim > 
VIPair
typedef std::vector< VIPair,
aligned_allocator< VIPair > > 
VIPairList
typedef Matrix< Scalar, Dim, 1 > VectorType

Private Member Functions

void build (VIPairList &objCenters, int from, int to, const VolumeList &objBoxes, int dim)

Private Attributes

std::vector< int > children
VolumeList boxes
ObjectList objects

Member Typedef Documentation

template<typename _Scalar , int _Dim, typename _Object >
typedef int Eigen::KdBVH< _Scalar, _Dim, _Object >::Index

Definition at line 90 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef _Object Eigen::KdBVH< _Scalar, _Dim, _Object >::Object

Definition at line 85 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef const Object* Eigen::KdBVH< _Scalar, _Dim, _Object >::ObjectIterator

Definition at line 92 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef std::vector<Object, aligned_allocator<Object> > Eigen::KdBVH< _Scalar, _Dim, _Object >::ObjectList

Definition at line 86 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef _Scalar Eigen::KdBVH< _Scalar, _Dim, _Object >::Scalar

Definition at line 87 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef Matrix<Scalar, Dim, 1> Eigen::KdBVH< _Scalar, _Dim, _Object >::VectorType [private]

Definition at line 186 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef internal::vector_int_pair<Scalar, Dim> Eigen::KdBVH< _Scalar, _Dim, _Object >::VIPair [private]

Definition at line 184 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef std::vector<VIPair, aligned_allocator<VIPair> > Eigen::KdBVH< _Scalar, _Dim, _Object >::VIPairList [private]

Definition at line 185 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef AlignedBox<Scalar, Dim> Eigen::KdBVH< _Scalar, _Dim, _Object >::Volume

Definition at line 88 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef const int* Eigen::KdBVH< _Scalar, _Dim, _Object >::VolumeIterator

Definition at line 91 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
typedef std::vector<Volume, aligned_allocator<Volume> > Eigen::KdBVH< _Scalar, _Dim, _Object >::VolumeList

Definition at line 89 of file BVH.


Member Enumeration Documentation

template<typename _Scalar , int _Dim, typename _Object >
anonymous enum
Enumerator:
Dim 

Definition at line 84 of file BVH.


Constructor & Destructor Documentation

template<typename _Scalar , int _Dim, typename _Object >
Eigen::KdBVH< _Scalar, _Dim, _Object >::KdBVH ( ) [inline]

Definition at line 94 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
template<typename Iter >
Eigen::KdBVH< _Scalar, _Dim, _Object >::KdBVH ( Iter  begin,
Iter  end 
) [inline]

Given an iterator range over Object references, constructs the BVH.

Requires that internal::bounding_box(Object) return a Volume.

Definition at line 97 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
template<typename OIter , typename BIter >
Eigen::KdBVH< _Scalar, _Dim, _Object >::KdBVH ( OIter  begin,
OIter  end,
BIter  boxBegin,
BIter  boxEnd 
) [inline]

Given an iterator range over Object references and an iterator range over their bounding boxes, constructs the BVH.

Definition at line 100 of file BVH.


Member Function Documentation

template<typename _Scalar , int _Dim, typename _Object >
void Eigen::KdBVH< _Scalar, _Dim, _Object >::build ( VIPairList objCenters,
int  from,
int  to,
const VolumeList objBoxes,
int  dim 
) [inline, private]

Definition at line 197 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
EIGEN_STRONG_INLINE void Eigen::KdBVH< _Scalar, _Dim, _Object >::getChildren ( Index  index,
VolumeIterator outVBegin,
VolumeIterator outVEnd,
ObjectIterator outOBegin,
ObjectIterator outOEnd 
) const [inline]

Given an index of a node, on exit, outVBegin and outVEnd range over the indices of the volume children of the node and outOBegin and outOEnd range over the object children of the node.

Definition at line 146 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
Index Eigen::KdBVH< _Scalar, _Dim, _Object >::getRootIndex ( ) const [inline]
Returns:
the index of the root of the hierarchy

Definition at line 142 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
const Volume& Eigen::KdBVH< _Scalar, _Dim, _Object >::getVolume ( Index  index) const [inline]
Returns:
the bounding box of the node at index

Definition at line 178 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
template<typename Iter >
void Eigen::KdBVH< _Scalar, _Dim, _Object >::init ( Iter  begin,
Iter  end 
) [inline]

Given an iterator range over Object references, constructs the BVH, overwriting whatever is in there currently.

Requires that internal::bounding_box(Object) return a Volume.

Definition at line 104 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
template<typename OIter , typename BIter >
void Eigen::KdBVH< _Scalar, _Dim, _Object >::init ( OIter  begin,
OIter  end,
BIter  boxBegin,
BIter  boxEnd 
) [inline]

Given an iterator range over Object references and an iterator range over their bounding boxes, constructs the BVH, overwriting whatever is in there currently.

Definition at line 108 of file BVH.


Member Data Documentation

template<typename _Scalar , int _Dim, typename _Object >
VolumeList Eigen::KdBVH< _Scalar, _Dim, _Object >::boxes [private]

Definition at line 230 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
std::vector<int> Eigen::KdBVH< _Scalar, _Dim, _Object >::children [private]

Definition at line 229 of file BVH.

template<typename _Scalar , int _Dim, typename _Object >
ObjectList Eigen::KdBVH< _Scalar, _Dim, _Object >::objects [private]

Definition at line 231 of file BVH.




Page generated by Doxygen 1.7.4 for MRPT 0.9.5 SVN:2717 at Sun Oct 16 16:08:03 PDT 2011 Hosted on:
SourceForge.net Logo