Eigen::KdBVH< Scalar_, Dim_, Object_ > Class Template Reference

#include <unsupported/Eigen/src/BVH/KdBVH.h>

Detailed Description

template<typename Scalar_, int Dim_, typename Object_>
class Eigen::KdBVH< Scalar_, Dim_, Object_ >

A simple bounding volume hierarchy based on AlignedBox.

Parameters

Scalar_	The underlying scalar type of the bounding boxes
Dim_	The dimension of the space in which the hierarchy lives
Object_	The 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.

Public Member Functions
void	getChildren (Index index, VolumeIterator &outVBegin, VolumeIterator &outVEnd, ObjectIterator &outOBegin, ObjectIterator &outOEnd) const
Index	getRootIndex () const
const Volume &	getVolume (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)
template<typename Iter>
	KdBVH (Iter begin, Iter end)
template<typename OIter, typename BIter>
	KdBVH (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)

Constructor & Destructor Documentation

KdBVH() [1/2]

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.

KdBVH() [2/2]

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

Member Function Documentation

getChildren()

template<typename Scalar_, int Dim_, typename Object_>

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

getRootIndex()

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

getVolume()

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

init() [1/2]

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.

init() [2/2]

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.

---

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

• /builds/libeigen/eigen/unsupported/Eigen/src/BVH/KdBVH.h