Generic octree data structure. More...

#include <Core/Geometry/Octree.hpp>

Inheritance diagram for CubbyFlow::Octree< T >:

Public Types
using	ContainerType = std::vector< T >

using	Iterator = typename ContainerType::iterator

using	ConstIterator = typename ContainerType::const_iterator

Public Member Functions
	Octree ()=default
	Default constructor.

	Octree (const Octree &)=default
	Default copy constructor.

	Octree (Octree &&) noexcept=default
	Default move constructor.

virtual	~Octree ()=default
	Default virtual destructor.

Octree &	operator= (const Octree &)=default
	Default copy assignment operator.

Octree &	operator= (Octree &&) noexcept=default
	Default move assignment operator.

void	Build (const std::vector< T > &items, const BoundingBox3D &bound, const BoxIntersectionTestFunc3< T > &testFunc, size_t maxDepth)

void	Clear ()
	Clears all the contents of this instance.

NearestNeighborQueryResult3< T >	Nearest (const Vector3D &pt, const NearestNeighborDistanceFunc3< T > &distanceFunc) const override

bool	Intersects (const BoundingBox3D &box, const BoxIntersectionTestFunc3< T > &testFunc) const override
	Returns true if given `box` intersects with any of the stored items.

bool	Intersects (const Ray3D &ray, const RayIntersectionTestFunc3< T > &testFunc) const override
	Returns true if given `ray` intersects with any of the stored items.

void	ForEachIntersectingItem (const BoundingBox3D &box, const BoxIntersectionTestFunc3< T > &testFunc, const IntersectionVisitorFunc< T > &visitorFunc) const override
	Invokes `visitorFunc` for every intersecting items.

void	ForEachIntersectingItem (const Ray3D &ray, const RayIntersectionTestFunc3< T > &testFunc, const IntersectionVisitorFunc< T > &visitorFunc) const override
	Invokes `visitorFunc` for every intersecting items.

ClosestIntersectionQueryResult3< T >	ClosestIntersection (const Ray3D &ray, const GetRayIntersectionFunc3< T > &testFunc) const override
	Returns the closest intersection for given `ray`.

Iterator	begin ()
	Returns the begin iterator of the item.

Iterator	end ()
	Returns the end iterator of the item.

ConstIterator	begin () const
	Returns the immutable begin iterator of the item.

ConstIterator	end () const
	Returns the immutable end iterator of the item.

size_t	GetNumberOfItems () const
	Returns the number of items.

const T &	GetItem (size_t i) const
	Returns the item at `i`.

size_t	GetNumberOfNodes () const
	Returns the number of octree nodes.

const std::vector< size_t > &	GetItemsAtNode (size_t nodeIdx) const
	Returns the list of the items for given node index.

size_t	GetChildIndex (size_t nodeIdx, size_t childIdx) const
	Returns a child's index for given node.

const BoundingBox3D &	GetBoundingBox () const
	Returns the bounding box of this octree.

size_t	GetMaxDepth () const
	Returns the maximum depth of the tree.

Public Member Functions inherited from CubbyFlow::IntersectionQueryEngine< T, N >
	IntersectionQueryEngine ()=default
	Default constructor.

virtual	~IntersectionQueryEngine ()=default
	Default virtual destructor.

	IntersectionQueryEngine (const IntersectionQueryEngine &other)=default
	Default copy constructor.

	IntersectionQueryEngine (IntersectionQueryEngine &&other) noexcept=default
	Default move constructor.

IntersectionQueryEngine &	operator= (const IntersectionQueryEngine &other)=default
	Default copy assignment operator.

IntersectionQueryEngine &	operator= (IntersectionQueryEngine &&other) noexcept=default
	Default move assignment operator.

virtual bool	Intersects (const BoundingBox< double, N > &box, const BoxIntersectionTestFunc< T, N > &testFunc) const =0
	Returns true if given `box` intersects with any of the stored items.

virtual bool	Intersects (const Ray< double, N > &ray, const RayIntersectionTestFunc< T, N > &testFunc) const =0
	Returns true if given `ray` intersects with any of the stored items.

virtual void	ForEachIntersectingItem (const BoundingBox< double, N > &box, const BoxIntersectionTestFunc< T, N > &testFunc, const IntersectionVisitorFunc< T > &visitorFunc) const =0
	Invokes `visitorFunc` for every intersecting items.

virtual void	ForEachIntersectingItem (const Ray< double, N > &ray, const RayIntersectionTestFunc< T, N > &testFunc, const IntersectionVisitorFunc< T > &visitorFunc) const =0
	Invokes `visitorFunc` for every intersecting items.

virtual ClosestIntersectionQueryResult< T, N >	ClosestIntersection (const Ray< double, N > &ray, const GetRayIntersectionFunc< T, N > &testFunc) const =0
	Returns the closest intersection for given `ray`.

Public Member Functions inherited from CubbyFlow::NearestNeighborQueryEngine< T, N >
	NearestNeighborQueryEngine ()=default
	Default constructor.

virtual	~NearestNeighborQueryEngine ()=default
	Default virtual destructor.

	NearestNeighborQueryEngine (const NearestNeighborQueryEngine &other)=default
	Default copy constructor.

	NearestNeighborQueryEngine (NearestNeighborQueryEngine &&other) noexcept=default
	Default move constructor.

NearestNeighborQueryEngine &	operator= (const NearestNeighborQueryEngine &other)=default
	Default copy assignment operator.

NearestNeighborQueryEngine &	operator= (NearestNeighborQueryEngine &&other) noexcept=default
	Default move assignment operator.

virtual NearestNeighborQueryResult< T, N >	Nearest (const Vector< double, N > &pt, const NearestNeighborDistanceFunc< T, N > &distanceFunc) const =0

Detailed Description

template<typename T>
class CubbyFlow::Octree< T >

Generic octree data structure.

This class is a generic octree representation to store arbitrary spatial data. The octree supports closest neighbor search, overlapping test, and ray intersection test.

Template Parameters

T	Value type.

Member Typedef Documentation

◆ ConstIterator

template<typename T >

using CubbyFlow::Octree< T >::ConstIterator = typename ContainerType::const_iterator

◆ ContainerType

template<typename T >

using CubbyFlow::Octree< T >::ContainerType = std::vector<T>

◆ Iterator

template<typename T >

using CubbyFlow::Octree< T >::Iterator = typename ContainerType::iterator

Constructor & Destructor Documentation

◆ Octree() [1/3]

template<typename T >

CubbyFlow::Octree< T >::Octree ( )

default

Default constructor.

◆ Octree() [2/3]

template<typename T >

CubbyFlow::Octree< T >::Octree ( const Octree< T > & )

default

Default copy constructor.

◆ Octree() [3/3]

template<typename T >

CubbyFlow::Octree< T >::Octree ( Octree< T > && )

defaultnoexcept

Default move constructor.

◆ ~Octree()

template<typename T >

virtual CubbyFlow::Octree< T >::~Octree ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

◆ begin() [1/2]

template<typename T >

Octree< T >::Iterator CubbyFlow::Octree< T >::begin ( )

Returns the begin iterator of the item.

◆ begin() [2/2]

template<typename T >

Octree< T >::ConstIterator CubbyFlow::Octree< T >::begin ( ) const

Returns the immutable begin iterator of the item.

◆ Build()

template<typename T >

void CubbyFlow::Octree< T >::Build	(	const std::vector< T > &	items,
		const BoundingBox3D &	bound,
		const BoxIntersectionTestFunc3< T > &	testFunc,
		size_t	maxDepth
	)

Builds an octree with given list of items, bounding box of the items, overlapping test function, and max depth of the tree.

◆ Clear()

template<typename T >

void CubbyFlow::Octree< T >::Clear ( )

Clears all the contents of this instance.

◆ ClosestIntersection()

template<typename T >

ClosestIntersectionQueryResult3< T > CubbyFlow::Octree< T >::ClosestIntersection	(	const Ray3D &	ray,
		const GetRayIntersectionFunc3< T > &	testFunc
	)		const

override

Returns the closest intersection for given ray.

◆ end() [1/2]

template<typename T >

Octree< T >::Iterator CubbyFlow::Octree< T >::end ( )

Returns the end iterator of the item.

◆ end() [2/2]

template<typename T >

Octree< T >::ConstIterator CubbyFlow::Octree< T >::end ( ) const

Returns the immutable end iterator of the item.

◆ ForEachIntersectingItem() [1/2]

template<typename T >

void CubbyFlow::Octree< T >::ForEachIntersectingItem	(	const BoundingBox3D &	box,
		const BoxIntersectionTestFunc3< T > &	testFunc,
		const IntersectionVisitorFunc< T > &	visitorFunc
	)		const

override

Invokes visitorFunc for every intersecting items.

◆ ForEachIntersectingItem() [2/2]

template<typename T >

void CubbyFlow::Octree< T >::ForEachIntersectingItem	(	const Ray3D &	ray,
		const RayIntersectionTestFunc3< T > &	testFunc,
		const IntersectionVisitorFunc< T > &	visitorFunc
	)		const

override

Invokes visitorFunc for every intersecting items.

◆ GetBoundingBox()

template<typename T >

const BoundingBox3D & CubbyFlow::Octree< T >::GetBoundingBox ( ) const

Returns the bounding box of this octree.

◆ GetChildIndex()

template<typename T >

size_t CubbyFlow::Octree< T >::GetChildIndex	(	size_t	nodeIdx,
		size_t	childIdx
	)		const

Returns a child's index for given node.

For a given node, its children is stored continuously, such that if the node's first child's index is i, then i + 1, i + 2, ... , i + 7 are the indices for its children. The order of octant is x-major.

Parameters

[in]	nodeIdx	The node index.
[in]	childIdx	The child index (0 to 7).

Returns: Index of the selected child.

◆ GetItem()

template<typename T >

const T & CubbyFlow::Octree< T >::GetItem ( size_t i ) const

Returns the item at i.

◆ GetItemsAtNode()

template<typename T >

const std::vector< size_t > & CubbyFlow::Octree< T >::GetItemsAtNode ( size_t nodeIdx ) const

Returns the list of the items for given node index.

◆ GetMaxDepth()

template<typename T >

size_t CubbyFlow::Octree< T >::GetMaxDepth ( ) const

Returns the maximum depth of the tree.

◆ GetNumberOfItems()

template<typename T >

size_t CubbyFlow::Octree< T >::GetNumberOfItems ( ) const

Returns the number of items.

◆ GetNumberOfNodes()

template<typename T >

size_t CubbyFlow::Octree< T >::GetNumberOfNodes ( ) const

Returns the number of octree nodes.

◆ Intersects() [1/2]

template<typename T >

bool CubbyFlow::Octree< T >::Intersects	(	const BoundingBox3D &	box,
		const BoxIntersectionTestFunc3< T > &	testFunc
	)		const

override

Returns true if given box intersects with any of the stored items.

◆ Intersects() [2/2]

template<typename T >

bool CubbyFlow::Octree< T >::Intersects	(	const Ray3D &	ray,
		const RayIntersectionTestFunc3< T > &	testFunc
	)		const

override

Returns true if given ray intersects with any of the stored items.

◆ Nearest()

template<typename T >

NearestNeighborQueryResult3< T > CubbyFlow::Octree< T >::Nearest	(	const Vector3D &	pt,
		const NearestNeighborDistanceFunc3< T > &	distanceFunc
	)		const

override

Returns the nearest neighbor for given point and distance measure function.

◆ operator=() [1/2]

template<typename T >

Octree & CubbyFlow::Octree< T >::operator= ( const Octree< T > & )

default

Default copy assignment operator.

◆ operator=() [2/2]

template<typename T >

Octree & CubbyFlow::Octree< T >::operator= ( Octree< T > && )

defaultnoexcept

Default move assignment operator.

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

Core/Geometry/Octree.hpp
Core/Geometry/Octree-Impl.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstIterator

◆ ContainerType

◆ Iterator

Constructor & Destructor Documentation

◆ Octree() [1/3]

◆ Octree() [2/3]

◆ Octree() [3/3]

◆ ~Octree()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ Build()

◆ Clear()

◆ ClosestIntersection()

◆ end() [1/2]

◆ end() [2/2]

◆ ForEachIntersectingItem() [1/2]

◆ ForEachIntersectingItem() [2/2]

◆ GetBoundingBox()

◆ GetChildIndex()

◆ GetItem()

◆ GetItemsAtNode()

◆ GetMaxDepth()

◆ GetNumberOfItems()

◆ GetNumberOfNodes()

◆ Intersects() [1/2]

◆ Intersects() [2/2]

◆ Nearest()

◆ operator=() [1/2]

◆ operator=() [2/2]