Represent an axis-aligned 3D bounds in space. More...

#include <Bounds.h>

Public Member Functions
VTKM_EXEC_CONT	Bounds ()

	Bounds (const Bounds &)=default

VTKM_EXEC_CONT	Bounds (const vtkm::Range &xRange, const vtkm::Range &yRange, const vtkm::Range &zRange)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
VTKM_EXEC_CONT	Bounds (const T1 &minX, const T2 &maxX, const T3 &minY, const T4 &maxY, const T5 &minZ, const T6 &maxZ)

template<typename T >
VTKM_EXEC_CONT	Bounds (const T bounds[6])
	Initialize bounds with an array of 6 values in the order xmin, xmax, ymin, ymax, zmin, zmax. More...

template<typename T >
VTKM_EXEC_CONT	Bounds (const vtkm::Vec< T, 3 > &minPoint, const vtkm::Vec< T, 3 > &maxPoint)
	Initialize bounds with the minimum corner point and the maximum corner point. More...

vtkm::Bounds &	operator= (const vtkm::Bounds &src)=default

VTKM_EXEC_CONT bool	IsNonEmpty () const
	Determine if the bounds are valid (i.e. More...

template<typename T >
VTKM_EXEC_CONT bool	Contains (const vtkm::Vec< T, 3 > &point) const
	Determines if a point coordinate is within the bounds. More...

VTKM_EXEC_CONT vtkm::Float64	Volume () const
	Returns the volume of the bounds. More...

VTKM_EXEC_CONT vtkm::Float64	Area () const
	Returns the area of the bounds in the X-Y-plane. More...

VTKM_EXEC_CONT vtkm::Vec3f_64	Center () const
	Returns the center of the range. More...

VTKM_EXEC_CONT vtkm::Vec3f_64	MinCorner () const
	Returns the min point of the bounds More...

VTKM_EXEC_CONT vtkm::Vec3f_64	MaxCorner () const
	Returns the max point of the bounds More...

template<typename T >
VTKM_EXEC_CONT void	Include (const vtkm::Vec< T, 3 > &point)
	Expand bounds to include a point. More...

VTKM_EXEC_CONT void	Include (const vtkm::Bounds &bounds)
	Expand bounds to include other bounds. More...

VTKM_EXEC_CONT vtkm::Bounds	Union (const vtkm::Bounds &otherBounds) const
	Return the union of this and another bounds. More...

VTKM_EXEC_CONT vtkm::Bounds	Intersection (const vtkm::Bounds &otherBounds) const
	Return the intersection of this and another range. More...

VTKM_EXEC_CONT vtkm::Bounds	operator+ (const vtkm::Bounds &otherBounds) const
	Operator for union More...

VTKM_EXEC_CONT bool	operator== (const vtkm::Bounds &bounds) const

VTKM_EXEC_CONT bool	operator!= (const vtkm::Bounds &bounds) const

Public Attributes
vtkm::Range	X

vtkm::Range	Y

vtkm::Range	Z

Detailed Description

Represent an axis-aligned 3D bounds in space.

vtkm::Bounds is a helper class for representing the axis-aligned box representing some region in space. The typical use of this class is to express the containing box of some geometry. The box is specified as ranges in the x, y, and z directions.

Bounds also contains several helper functions for computing and maintaining the bounds.

Constructor & Destructor Documentation

◆ Bounds() [1/6]

VTKM_EXEC_CONT vtkm::Bounds::Bounds ( )

inline

◆ Bounds() [2/6]

vtkm::Bounds::Bounds ( const Bounds & )

default

◆ Bounds() [3/6]

VTKM_EXEC_CONT vtkm::Bounds::Bounds	(	const vtkm::Range &	xRange,
		const vtkm::Range &	yRange,
		const vtkm::Range &	zRange
	)

inline

◆ Bounds() [4/6]

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >

VTKM_EXEC_CONT vtkm::Bounds::Bounds	(	const T1 &	minX,
		const T2 &	maxX,
		const T3 &	minY,
		const T4 &	maxY,
		const T5 &	minZ,
		const T6 &	maxZ
	)

inline

◆ Bounds() [5/6]

template<typename T >

VTKM_EXEC_CONT vtkm::Bounds::Bounds ( const T bounds[6] )

inlineexplicit

Initialize bounds with an array of 6 values in the order xmin, xmax, ymin, ymax, zmin, zmax.

◆ Bounds() [6/6]

template<typename T >

VTKM_EXEC_CONT vtkm::Bounds::Bounds	(	const vtkm::Vec< T, 3 > &	minPoint,
		const vtkm::Vec< T, 3 > &	maxPoint
	)

inline

Initialize bounds with the minimum corner point and the maximum corner point.

Member Function Documentation

◆ Area()

VTKM_EXEC_CONT vtkm::Float64 vtkm::Bounds::Area ( ) const

inline

Returns the area of the bounds in the X-Y-plane.

Area computes the product of the lengths of the ranges in dimensions X and Y. If the bounds are empty, 0 is returned.

◆ Center()

VTKM_EXEC_CONT vtkm::Vec3f_64 vtkm::Bounds::Center ( ) const

inline

Returns the center of the range.

Center computes the point at the middle of the bounds. If the bounds are empty, the results are undefined.

◆ Contains()

template<typename T >

VTKM_EXEC_CONT bool vtkm::Bounds::Contains ( const vtkm::Vec< T, 3 > & point ) const

inline

Determines if a point coordinate is within the bounds.

◆ Include() [1/2]

VTKM_EXEC_CONT void vtkm::Bounds::Include ( const vtkm::Bounds & bounds )

inline

Expand bounds to include other bounds.

This version of Include expands these bounds just enough to include that of another bounds. Essentially it is the union of the two bounds.

◆ Include() [2/2]

template<typename T >

VTKM_EXEC_CONT void vtkm::Bounds::Include ( const vtkm::Vec< T, 3 > & point )

inline

Expand bounds to include a point.

This version of Include expands the bounds just enough to include the given point coordinates. If the bounds already include this point, then nothing is done.

◆ Intersection()

VTKM_EXEC_CONT vtkm::Bounds vtkm::Bounds::Intersection ( const vtkm::Bounds & otherBounds ) const

inline

Return the intersection of this and another range.

◆ IsNonEmpty()

VTKM_EXEC_CONT bool vtkm::Bounds::IsNonEmpty ( ) const

inline

Determine if the bounds are valid (i.e.

has at least one valid point).

IsNonEmpty returns true if the bounds contain some valid points. If the bounds are any real region, even if a single point or it expands to infinity, true is returned.

◆ MaxCorner()

VTKM_EXEC_CONT vtkm::Vec3f_64 vtkm::Bounds::MaxCorner ( ) const

inline

Returns the max point of the bounds

MaxCorder returns the minium point of the bounds.If the bounds are empty, the results are undefined.

◆ MinCorner()

VTKM_EXEC_CONT vtkm::Vec3f_64 vtkm::Bounds::MinCorner ( ) const

inline

Returns the min point of the bounds

MinCorder returns the minium point of the bounds.If the bounds are empty, the results are undefined.

◆ operator!=()

VTKM_EXEC_CONT bool vtkm::Bounds::operator!= ( const vtkm::Bounds & bounds ) const

inline

◆ operator+()

VTKM_EXEC_CONT vtkm::Bounds vtkm::Bounds::operator+ ( const vtkm::Bounds & otherBounds ) const

inline

Operator for union

◆ operator=()

vtkm::Bounds& vtkm::Bounds::operator= ( const vtkm::Bounds & src )

default

◆ operator==()

VTKM_EXEC_CONT bool vtkm::Bounds::operator== ( const vtkm::Bounds & bounds ) const

inline

◆ Union()

VTKM_EXEC_CONT vtkm::Bounds vtkm::Bounds::Union ( const vtkm::Bounds & otherBounds ) const

inline

Return the union of this and another bounds.

This is a nondestructive form of Include.

◆ Volume()

VTKM_EXEC_CONT vtkm::Float64 vtkm::Bounds::Volume ( ) const

inline

Returns the volume of the bounds.

Volume computes the product of the lengths of the ranges in each dimension. If the bounds are empty, 0 is returned.

Member Data Documentation

◆ X

vtkm::Range vtkm::Bounds::X

◆ Y

vtkm::Range vtkm::Bounds::Y

◆ Z

vtkm::Range vtkm::Bounds::Z

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

Bounds.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Bounds() [1/6]

◆ Bounds() [2/6]

◆ Bounds() [3/6]

◆ Bounds() [4/6]

◆ Bounds() [5/6]

◆ Bounds() [6/6]

Member Function Documentation

◆ Area()

◆ Center()

◆ Contains()

◆ Include() [1/2]

◆ Include() [2/2]

◆ Intersection()

◆ IsNonEmpty()

◆ MaxCorner()

◆ MinCorner()

◆ operator!=()

◆ operator+()

◆ operator=()

◆ operator==()

◆ Union()

◆ Volume()

Member Data Documentation

◆ X

◆ Y

◆ Z