A bounding volume hierarchy to quickly select 3d shapes. More...

#include <BVH3.h>

Inheritance diagram for maquina::BVH3:

Public Member Functions
	BVH3 ()

	BVH3 (const Value &v)
	Cast a Value object in BVH3. More...

	BVH3 (const gsl::span< const Imath::V3f > &points, int obj_per_leaf=4)
	Build a BVH of 3d points. More...

	BVH3 (const gsl::span< const Imath::Box3f > &boxes, int obj_per_leaf=4)
	Build a BVH of axis aligned boxes. More...

void	select (const Imath::V3f &position, float max_distance, std::vector< uint32_t > &result) const
	Returns a rough selection of the elements at a distance of position smaller than max_distance. More...

int	closest (const Imath::V3f &position, float &max_distance, const std::function< float(int entry, const Imath::V3f &p)> &distance, bool use_square_distance) const
	Find the closest element to a given position in space. More...

Public Member Functions inherited from maquina::Value
	Value ()

Value	duplicate () const
	Duplicate the value. More...

bool	as_bool () const
	Returns the value as a bool. More...

int	as_int () const
	Returns the value as an integer. More...

float	as_float () const
	Returns the value as a float. More...

double	as_double () const
	Returns the value as a double. More...

const std::string &	as_string () const
	Returns the value as a string. More...

std::wstring	as_wstring () const
	Returns the value as a wstring. More...

Imath::V2f	as_V2f () const
	Returns the value as a V2f. More...

Imath::V3f	as_V3f () const
	Returns the value as a V3f. More...

Imath::V4f	as_V4f () const
	Returns the value as a V4f. More...

const Imath::V2d &	as_V2d () const
	Returns the value as a V2d. More...

const Imath::V3d &	as_V3d () const
	Returns the value as a V3d. More...

const Imath::V4d &	as_V4d () const
	Returns the value as a V4d. More...

const Imath::V2i &	as_V2i () const
	Returns the value as a V2i. More...

const Imath::V3i &	as_V3i () const
	Returns the value as a V3i. More...

const Imath::V4i &	as_V4i () const
	Returns the value as a V4i. More...

Imath::M44f	as_M44f () const
	Returns the value as a M44f. More...

const Imath::M44d &	as_M44d () const
	Returns the value as a M44d. More...

const Imath::Box3f &	as_Box3f () const
	Returns the value as a Box3f. More...

const Imath::Color4f &	as_Color4f () const
	Returns the value as a Color4f. More...

Imath::Quatf	as_Quatf () const
	Returns the value as a Quatf. More...

const Imath::Quatd &	as_Quatd () const
	Returns the value as a Quatd. More...

std::shared_ptr< const UserData >	as_user_data () const
	Returns the value as a user data. More...

StringView	type_name () const
	Return the type name of the Value. More...

bool	has_node_delegate () const
	Check if this value can produces a NodeDelegate. More...

std::shared_ptr< NodeDelegate >	node_delegate (const std::shared_ptr< NodeDelegate > &parent, const StringView &name) const

bool	operator== (const Value &o) const
	Compare the two values. More...

bool	operator!= (const Value &o) const

bool	is_instance (const char *value_type_name) const
	Check if this type derives from another value type. More...

bool	is_interpolable () const
	Checks if the value is interpolable. More...

Value	lerp (const Value &other, double weight) const
	Performs linear interpolation between this value and another value. More...

	Value (bool)
	Create a boolean value. More...

	Value (int)
	Create an integer value. More...

	Value (float)
	Create a float value. More...

	Value (double)
	Create a double value. More...

	Value (const char *string)
	Create a string value. More...

	Value (const wchar_t *string)
	Create a string value. More...

	Value (const std::string &string)
	Create a string value. More...

	Value (const std::wstring &string)
	Create a wide string value. More...

	Value (const Imath::V2f &)
	Create a Imath::V2f value. More...

	Value (const Imath::V3f &)
	Create a Imath::V3f value. More...

	Value (const Imath::V4f &)
	Create a Imath::V4f value. More...

	Value (const Imath::V2d &)
	Create a Imath::V2d value. More...

	Value (const Imath::V3d &)
	Create a Imath::V3d value. More...

	Value (const Imath::V4d &)
	Create a Imath::V4d value. More...

	Value (const Imath::V2i &)
	Create a Imath::V2i value. More...

	Value (const Imath::V3i &)
	Create a Imath::V3i value. More...

	Value (const Imath::V4i &)
	Create a Imath::V4i value. More...

	Value (const Imath::Color4f &)
	Create a Imath::Color4f value. More...

	Value (const Imath::M44f &)
	Create a Imath::M44f value. More...

	Value (const Imath::M44d &)
	Create a Imath::M44d value. More...

	Value (const Imath::Box3f &)
	Create a Imath::Box3f value. More...

	Value (const Imath::Quatf &)
	Create a Imath::Quatf value. More...

	Value (const Imath::Quatd &)
	Create a Imath::Quatd value. More...

	Value (const std::shared_ptr< const UserData > &user_data)
	Create a user data value. More...

Additional Inherited Members
Static Public Member Functions inherited from maquina::Value
static bool	validate_type_name (const char *type_name)
	Return true if the name is a valid type name. More...

static Value	get_default_value (const char *type_name)
	Return a default value for a given type. More...

Static Public Attributes inherited from maquina::Value
static const Value	default_value
	The default value. More...

Detailed Description

A bounding volume hierarchy to quickly select 3d shapes.

Constructor & Destructor Documentation

◆ BVH3() [1/4]

maquina::BVH3::BVH3 ( )

◆ BVH3() [2/4]

maquina::BVH3::BVH3 ( const Value & v )

Cast a Value object in BVH3.

If v has not the good type, a default value is constructed.

◆ BVH3() [3/4]

maquina::BVH3::BVH3	(	const gsl::span< const Imath::V3f > &	points,
		int	obj_per_leaf = `4`
	)

Build a BVH of 3d points.

Parameters

points	The points
obj_per_leaf	Number of points per BVH leaf. Smaller numbers give larger BVHs but faster object selection.

◆ BVH3() [4/4]

maquina::BVH3::BVH3	(	const gsl::span< const Imath::Box3f > &	boxes,
		int	obj_per_leaf = `4`
	)

Build a BVH of axis aligned boxes.

Parameters

boxes	The boxes
obj_per_leaf	Number of boxes per BVH leaf. Smaller numbers give larger BVHs but faster object selection.

Member Function Documentation

◆ closest()

int maquina::BVH3::closest	(	const Imath::V3f &	position,
		float &	max_distance,
		const std::function< float(int entry, const Imath::V3f &p)> &	distance,
		bool	use_square_distance
	)		const

Find the closest element to a given position in space.

Returns the index of the closest element to the specified position. If no element is found, returns -1.

Parameters

position	The position in space to which the closest element will be found.
max_distance	The initial search distance. If a closest element is found, this will be updated to the distance to that element. If `use_square_distance` is true, `max_distance` is a squared distance.
distance	A user-defined function that calculates the distance between the element at the given index and the position `p`. If `use_square_distance` is true, this function should return the squared distance.
use_square_distance	If true, the distances (both in `max_distance` and the result of the `distance` function) will be squared.

Returns: The index of the closest element, or -1 if no element was found.

◆ select()

void maquina::BVH3::select	(	const Imath::V3f &	position,
		float	max_distance,
		std::vector< uint32_t > &	result
	)		const

Returns a rough selection of the elements at a distance of position smaller than max_distance.

All the objects closer to position than max_distance are returned once. Objects farther to position than max_distance may be also returned once. A more precise test should be performed after this rough selection.

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

maquina/include/Maquina/BVH3.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BVH3() [1/4]

◆ BVH3() [2/4]

◆ BVH3() [3/4]

◆ BVH3() [4/4]

Member Function Documentation

◆ closest()

◆ select()