3d axis aligned bounding box class More...

#include <BoundingBox.hh>

Public Types
typedef T	PointPosition
	3d point position More...

Public Member Functions
	BoundingBox ()=default
	default constructor More...

	BoundingBox (PointPosition const &pp)
	point constructor More...

	BoundingBox (PointPosition const &lower, PointPosition const &upper)
	corner constructor More...

	BoundingBox (BoundingBox const &bb)
	copy constructor More...

	~BoundingBox ()=default
	default destructor More...

BoundingBox &	operator= (BoundingBox const &bb)
	copy assignment More...

void	add (PointPosition const &pp)
	add a point, expands bounds if necessary More...

PointPosition const &	lower () const
	get lower corner More...

PointPosition const &	upper () const
	get upper corner More...

void	set_lower (PointPosition const &p)
	set lower corner More...

void	set_upper (PointPosition const &p)
	set upper corner More...

void	reset (PointPosition const &p=PointPosition())
	reset corners More...

template<typename U >
void	expand (U const &scalar)
	expand box corners (additive) More...

template<typename U >
void	contract (U const &scalar)

void	translate (PointPosition const &t)
	translate bounding box More...

bool	intersects (BoundingBox const &bb) const
	intersects another bounding box? More...

template<typename U >
bool	contains (U const &x, U const &y, U const &z) const
	is point contained within this bounding box? More...

bool	contains (PointPosition const &p) const
	is point contained within this bounding box? More...

Private Attributes
PointPosition	lower_

PointPosition	upper_

Detailed Description

template<typename T>
class numeric::geometry::BoundingBox< T >

3d axis aligned bounding box class

template type must be 3d and have .x(), .y(), .z() accessors

Member Typedef Documentation

◆ PointPosition

template<typename T >

typedef T numeric::geometry::BoundingBox< T >::PointPosition

3d point position

Constructor & Destructor Documentation

◆ BoundingBox() [1/4]

template<typename T >

numeric::geometry::BoundingBox< T >::BoundingBox ( )

inlinedefault

default constructor

Warning: no initialization of corners for speed, make sure you reset(); or otherwise set corners before adding points

◆ BoundingBox() [2/4]

template<typename T >

numeric::geometry::BoundingBox< T >::BoundingBox ( PointPosition const & pp )

inline

point constructor

◆ BoundingBox() [3/4]

template<typename T >

numeric::geometry::BoundingBox< T >::BoundingBox	(	PointPosition const &	lower,
		PointPosition const &	upper
	)

inline

corner constructor

◆ BoundingBox() [4/4]

template<typename T >

numeric::geometry::BoundingBox< T >::BoundingBox ( BoundingBox< T > const & bb )

inline

copy constructor

◆ ~BoundingBox()

template<typename T >

numeric::geometry::BoundingBox< T >::~BoundingBox ( )

inlinedefault

default destructor

Member Function Documentation

◆ add()

template<typename T >

void numeric::geometry::BoundingBox< T >::add ( PointPosition const & pp )

inline

add a point, expands bounds if necessary

References numeric::geometry::BoundingBox< T >::lower_, and numeric::geometry::BoundingBox< T >::upper_.

Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ contains() [1/2]

template<typename T >

bool numeric::geometry::BoundingBox< T >::contains ( PointPosition const & p ) const

inline

is point contained within this bounding box?

References numeric::geometry::BoundingBox< T >::contains(), and kmeans_adaptive_kernel_density_bb_dependent_rotlib::p.

◆ contains() [2/2]

template<typename T >

template<typename U >

bool numeric::geometry::BoundingBox< T >::contains	(	U const &	x,
		U const &	y,
		U const &	z
	)		const

inline

is point contained within this bounding box?

References numeric::geometry::BoundingBox< T >::lower_, numeric::geometry::BoundingBox< T >::upper_, x, predPRE::y, and predPRE::z.

Referenced by numeric::geometry::hashing::SixDCoordinateBinner::bin6(), numeric::geometry::BoundingBox< T >::contains(), and numeric::geometry::hashing::SixDCoordinateBinner::contains().

◆ contract()

template<typename T >

template<typename U >

void numeric::geometry::BoundingBox< T >::contract ( U const & scalar )

inline

References numeric::geometry::BoundingBox< T >::lower_, and numeric::geometry::BoundingBox< T >::upper_.

◆ expand()

template<typename T >

template<typename U >

void numeric::geometry::BoundingBox< T >::expand ( U const & scalar )

inline

expand box corners (additive)

References numeric::geometry::BoundingBox< T >::lower_, and numeric::geometry::BoundingBox< T >::upper_.

◆ intersects()

template<typename T >

bool numeric::geometry::BoundingBox< T >::intersects ( BoundingBox< T > const & bb ) const

inline

intersects another bounding box?

References numeric::geometry::BoundingBox< T >::lower_, and numeric::geometry::BoundingBox< T >::upper_.

◆ lower()

template<typename T >

PointPosition const& numeric::geometry::BoundingBox< T >::lower ( ) const

inline

get lower corner

References numeric::geometry::BoundingBox< T >::lower_.

Referenced by numeric::geometry::hashing::SixDCoordinateBinner::bin6(), numeric::geometry::hashing::SixDCoordinateBinner::bin_center_point(), numeric::geometry::hashing::SixDCoordinateBinner::bounding_volume_from_index(), options_class.Option::getDoxygenRow(), options_class.Option::getMarkdownRow(), options_class.Option::getOptionCC(), options_class.Option::getWikiTableRow(), numeric::geometry::hashing::SixDCoordinateBinner::halfbin6(), and numeric::geometry::hashing::SixDCoordinateBinner::SixDCoordinateBinner().

◆ operator=()

template<typename T >

BoundingBox& numeric::geometry::BoundingBox< T >::operator= ( BoundingBox< T > const & bb )

inline

copy assignment

References numeric::geometry::BoundingBox< T >::lower_, and numeric::geometry::BoundingBox< T >::upper_.

◆ reset()

template<typename T >

void numeric::geometry::BoundingBox< T >::reset ( PointPosition const & p = PointPosition() )

inline

reset corners

References numeric::geometry::BoundingBox< T >::lower_, kmeans_adaptive_kernel_density_bb_dependent_rotlib::p, and numeric::geometry::BoundingBox< T >::upper_.

◆ set_lower()

template<typename T >

void numeric::geometry::BoundingBox< T >::set_lower ( PointPosition const & p )

inline

set lower corner

References numeric::geometry::BoundingBox< T >::lower_, and kmeans_adaptive_kernel_density_bb_dependent_rotlib::p.

◆ set_upper()

template<typename T >

void numeric::geometry::BoundingBox< T >::set_upper ( PointPosition const & p )

inline

set upper corner

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::p, and numeric::geometry::BoundingBox< T >::upper_.

Referenced by numeric::geometry::hashing::SixDCoordinateBinner::SixDCoordinateBinner().

◆ translate()

template<typename T >

void numeric::geometry::BoundingBox< T >::translate ( PointPosition const & t )

inline

translate bounding box

References numeric::geometry::BoundingBox< T >::lower_, predPRE::t, and numeric::geometry::BoundingBox< T >::upper_.

◆ upper()

template<typename T >

PointPosition const& numeric::geometry::BoundingBox< T >::upper ( ) const

inline

get upper corner

References numeric::geometry::BoundingBox< T >::upper_.

Referenced by options_class.Option::getDoxygenRow(), options_class.Option::getMarkdownRow(), options_class.Option::getOptionCC(), options_class.Option::getWikiTableRow(), and numeric::geometry::hashing::SixDCoordinateBinner::SixDCoordinateBinner().

Member Data Documentation

◆ lower_

template<typename T >

PointPosition numeric::geometry::BoundingBox< T >::lower_

private

Referenced by numeric::geometry::BoundingBox< T >::add(), numeric::geometry::BoundingBox< T >::contains(), numeric::geometry::BoundingBox< T >::contract(), numeric::geometry::BoundingBox< T >::expand(), numeric::geometry::BoundingBox< T >::intersects(), numeric::geometry::BoundingBox< T >::lower(), numeric::geometry::BoundingBox< T >::operator=(), numeric::geometry::BoundingBox< T >::reset(), numeric::geometry::BoundingBox< T >::set_lower(), and numeric::geometry::BoundingBox< T >::translate().

◆ upper_

template<typename T >

PointPosition numeric::geometry::BoundingBox< T >::upper_

private

Referenced by numeric::geometry::BoundingBox< T >::add(), numeric::geometry::BoundingBox< T >::contains(), numeric::geometry::BoundingBox< T >::contract(), numeric::geometry::BoundingBox< T >::expand(), numeric::geometry::BoundingBox< T >::intersects(), numeric::geometry::BoundingBox< T >::operator=(), numeric::geometry::BoundingBox< T >::reset(), numeric::geometry::BoundingBox< T >::set_upper(), numeric::geometry::BoundingBox< T >::translate(), and numeric::geometry::BoundingBox< T >::upper().

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

src/numeric/geometry/BoundingBox.fwd.hh
src/numeric/geometry/BoundingBox.hh

Public Types

Public Member Functions

Private Attributes

Detailed Description

template<typename T> class numeric::geometry::BoundingBox< T >

Member Typedef Documentation

◆ PointPosition

Constructor & Destructor Documentation

◆ BoundingBox() [1/4]

◆ BoundingBox() [2/4]

◆ BoundingBox() [3/4]

◆ BoundingBox() [4/4]

◆ ~BoundingBox()

Member Function Documentation

◆ add()

◆ contains() [1/2]

◆ contains() [2/2]

◆ contract()

◆ expand()

◆ intersects()

◆ lower()

◆ operator=()

◆ reset()

◆ set_lower()

◆ set_upper()

◆ translate()

◆ upper()

Member Data Documentation

◆ lower_

◆ upper_

template<typename T>
class numeric::geometry::BoundingBox< T >