Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
Eigen::KdBVH< _Scalar, _Dim, _Object > Class Template Reference

A simple bounding volume hierarchy based on AlignedBox. More...

#include <KdBVH.h>

List of all members.

Classes

struct  VectorComparator

Public Types

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

Public Member Functions

EIGEN_STRONG_INLINE void getChildren (Index index, VolumeIterator &outVBegin, VolumeIterator &outVEnd, ObjectIterator &outOBegin, ObjectIterator &outOEnd) const
Index getRootIndex () const
const VolumegetVolume (Index index) const
template<typename Iter >
void init (Iter begin, Iter end)
template<typename OIter , typename BIter >
void init (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)
 KdBVH ()
template<typename Iter >
 KdBVH (Iter begin, Iter end)
template<typename OIter , typename BIter >
 KdBVH (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)

Private Types

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

Private Member Functions

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

Private Attributes

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

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 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 67 of file KdBVH.h.


Member Typedef Documentation

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

Definition at line 76 of file KdBVH.h.

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

Definition at line 71 of file KdBVH.h.

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

Definition at line 78 of file KdBVH.h.

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

Definition at line 72 of file KdBVH.h.

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

Definition at line 73 of file KdBVH.h.

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

Definition at line 172 of file KdBVH.h.

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

Definition at line 170 of file KdBVH.h.

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

Definition at line 171 of file KdBVH.h.

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

Definition at line 74 of file KdBVH.h.

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

Definition at line 77 of file KdBVH.h.

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

Definition at line 75 of file KdBVH.h.


Member Enumeration Documentation

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

Definition at line 70 of file KdBVH.h.


Constructor & Destructor Documentation

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

Definition at line 80 of file KdBVH.h.

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 bounding_box(Object) return a Volume.

Definition at line 83 of file KdBVH.h.

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 86 of file KdBVH.h.


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 183 of file KdBVH.h.

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 132 of file KdBVH.h.

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 128 of file KdBVH.h.

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 164 of file KdBVH.h.

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 bounding_box(Object) return a Volume.

Definition at line 90 of file KdBVH.h.

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 94 of file KdBVH.h.


Member Data Documentation

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

Definition at line 216 of file KdBVH.h.

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

Definition at line 215 of file KdBVH.h.

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

Definition at line 217 of file KdBVH.h.


The documentation for this class was generated from the following file:


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:15