vtkm::Box Class Reference

Implicit function for a box. More...

#include <ImplicitFunction.h>

Inheritance diagram for vtkm::Box:

Public Member Functions
	Box ()
	Construct box with center at (0,0,0) and each side of length 1.0. More...
	Box (const Vector &minPoint, const Vector &maxPoint)
	Construct a box with the specified minimum and maximum point. More...
	Box (Scalar xmin, Scalar xmax, Scalar ymin, Scalar ymax, Scalar zmin, Scalar zmax)
	Construct a box with the specified minimum and maximum point. More...
	Box (const vtkm::Bounds &bounds)
	Construct a box that encompasses the given bounds. More...
void	SetMinPoint (const Vector &point)
	Specify the minimum coordinate of the box. More...
void	SetMaxPoint (const Vector &point)
	Specify the maximum coordinate of the box. More...
const Vector &	GetMinPoint () const
	Specify the minimum coordinate of the box. More...
const Vector &	GetMaxPoint () const
	Specify the maximum coordinate of the box. More...
void	SetBounds (const vtkm::Bounds &bounds)
	Specify the size and location of the box by the bounds it encompasses. More...
vtkm::Bounds	GetBounds () const
	Specify the size and location of the box by the bounds it encompasses. More...
Scalar	Value (const Vector &point) const
	Evaluate the value of the implicit function. More...
Vector	Gradient (const Vector &point) const
	Evaluate the gradient of the implicit function. More...

Private Attributes
Vector	MinPoint
Vector	MaxPoint

Detailed Description

Implicit function for a box.

Box computes the implicit function and/or gradient for a axis-aligned bounding box. Each side of the box is orthogonal to all other sides meeting along shared edges and all faces are orthogonal to the x-y-z coordinate axes.

Constructor & Destructor Documentation

Box() [1/4]

vtkm::Box::Box ( )

inline

Construct box with center at (0,0,0) and each side of length 1.0.

Box() [2/4]

vtkm::Box::Box ( const Vector &  minPoint, const Vector &  maxPoint  )

inline

Construct a box with the specified minimum and maximum point.

Box() [3/4]

vtkm::Box::Box ( Scalar  xmin, Scalar  xmax, Scalar  ymin, Scalar  ymax, Scalar  zmin, Scalar  zmax  )

inline

Construct a box with the specified minimum and maximum point.

Box() [4/4]

vtkm::Box::Box ( const vtkm::Bounds &  bounds )

inline

Construct a box that encompasses the given bounds.

Member Function Documentation

GetBounds()

vtkm::Bounds vtkm::Box::GetBounds ( ) const

inline

Specify the size and location of the box by the bounds it encompasses.

GetMaxPoint()

const Vector& vtkm::Box::GetMaxPoint ( ) const

inline

Specify the maximum coordinate of the box.

GetMinPoint()

const Vector& vtkm::Box::GetMinPoint ( ) const

inline

Specify the minimum coordinate of the box.

Gradient()

Vector vtkm::Box::Gradient ( const Vector &  point ) const

inline

Evaluate the gradient of the implicit function.

The Gradient() method for an implicit function takes a vtkm::Vec3f and returns a vtkm::Vec3f representing the pointing direction from the implicit function's shape. Gradient calculations are more object shape specific. It is advised to look at the individual shape implementations for specific implicit functions.

SetBounds()

void vtkm::Box::SetBounds ( const vtkm::Bounds &  bounds )

inline

Specify the size and location of the box by the bounds it encompasses.

SetMaxPoint()

void vtkm::Box::SetMaxPoint ( const Vector &  point )

inline

Specify the maximum coordinate of the box.

SetMinPoint()

void vtkm::Box::SetMinPoint ( const Vector &  point )

inline

Specify the minimum coordinate of the box.

Value()

Scalar vtkm::Box::Value ( const Vector &  point ) const

inline

Evaluate the value of the implicit function.

The Value() method for an implicit function takes a vtkm::Vec3f and returns a vtkm::FloatDefault representing the orientation of the point with respect to the implicit function's shape. Negative scalar values represent vector points inside of the implicit function's shape. Positive scalar values represent vector points outside the implicit function's shape. Zero values represent vector points that lie on the surface of the implicit function.

Member Data Documentation

MaxPoint

Vector vtkm::Box::MaxPoint

private

MinPoint

Vector vtkm::Box::MinPoint

private

---

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

• ImplicitFunction.h