viskores::RangeId3 Struct Reference

Represent 3D integer range. More...

#include <RangeId3.h>

Public Member Functions
	RangeId3 ()=default
	Construct an empty 3D range. More...
	RangeId3 (const viskores::RangeId &xrange, const viskores::RangeId &yrange, const viskores::RangeId &zrange)
	Construct a range with the given x, y, and z directions. More...
	RangeId3 (viskores::Id minX, viskores::Id maxX, viskores::Id minY, viskores::Id maxY, viskores::Id minZ, viskores::Id maxZ)
	Construct a range with the given minimum (inclusive) and maximum (exclusive) points. More...
	RangeId3 (const viskores::Id range[6])
	Initialize range with an array of 6 values in the order xmin, xmax, ymin, ymax, zmin, zmax. More...
	RangeId3 (const viskores::Id3 &min, const viskores::Id3 &max)
	Initialize range with the minimum and the maximum corners. More...
bool	IsNonEmpty () const
	Determine if the range is non-empty. More...
bool	Contains (const viskores::Id3 &val) const
	Determines if an Id3 value is within the range. More...
viskores::Id3	Center () const
	Returns the center of the range. More...
viskores::Id3	Dimensions () const
template<typename T >
void	Include (const viskores::Vec< T, 3 > &point)
	Expand range to include a value. More...
void	Include (const viskores::RangeId3 &range)
	Expand range to include other range. More...
viskores::RangeId3	Union (const viskores::RangeId3 &other) const
	Return the union of this and another range. More...
viskores::RangeId3	operator+ (const viskores::RangeId3 &other) const
	Operator for union More...
bool	operator== (const viskores::RangeId3 &range) const
bool	operator!= (const viskores::RangeId3 &range) const
viskores::RangeId &	operator[] (IdComponent c) noexcept
const viskores::RangeId &	operator[] (IdComponent c) const noexcept

Public Attributes
viskores::RangeId	X
	The range of values in the X direction. More...
viskores::RangeId	Y
	The range of values in the Y direction. More...
viskores::RangeId	Z
	The range of values in the Z direction. More...

Detailed Description

Represent 3D integer range.

viskores::RangeId3 is a helper class for representing a 3D range of integer values. The typical use of this class is to express a box of indices in the x, y, and z directions.

RangeId3 also contains several helper functions for computing and maintaining the range.

Constructor & Destructor Documentation

RangeId3() [1/5]

viskores::RangeId3::RangeId3 ( )

default

Construct an empty 3D range.

RangeId3() [2/5]

viskores::RangeId3::RangeId3 ( const viskores::RangeId &  xrange, const viskores::RangeId &  yrange, const viskores::RangeId &  zrange  )

inline

Construct a range with the given x, y, and z directions.

RangeId3() [3/5]

viskores::RangeId3::RangeId3 ( viskores::Id  minX, viskores::Id  maxX, viskores::Id  minY, viskores::Id  maxY, viskores::Id  minZ, viskores::Id  maxZ  )

inline

Construct a range with the given minimum (inclusive) and maximum (exclusive) points.

RangeId3() [4/5]

viskores::RangeId3::RangeId3 ( const viskores::Id  range[6] )

inlineexplicit

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

RangeId3() [5/5]

viskores::RangeId3::RangeId3 ( const viskores::Id3 &  min, const viskores::Id3 &  max  )

inline

Initialize range with the minimum and the maximum corners.

Member Function Documentation

Center()

viskores::Id3 viskores::RangeId3::Center ( ) const

inline

Returns the center of the range.

Center computes the middle of the range.

Contains()

bool viskores::RangeId3::Contains ( const viskores::Id3 &  val ) const

inline

Determines if an Id3 value is within the range.

Dimensions()

viskores::Id3 viskores::RangeId3::Dimensions ( ) const

inline

Include() [1/2]

void viskores::RangeId3::Include ( const viskores::RangeId3 &  range )

inline

Expand range to include other range.

This version of Include expands the range just enough to include the other range. Essentially it is the union of the two ranges.

Include() [2/2]

template<typename T >

void viskores::RangeId3::Include ( const viskores::Vec< T, 3 > &  point )

inline

Expand range to include a value.

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

IsNonEmpty()

bool viskores::RangeId3::IsNonEmpty ( ) const

inline

Determine if the range is non-empty.

IsNonEmpty returns true if the range is non-empty.

operator!=()

bool viskores::RangeId3::operator!= ( const viskores::RangeId3 &  range ) const

inline

operator+()

viskores::RangeId3 viskores::RangeId3::operator+ ( const viskores::RangeId3 &  other ) const

inline

Operator for union

operator==()

bool viskores::RangeId3::operator== ( const viskores::RangeId3 &  range ) const

inline

operator[]() [1/2]

const viskores::RangeId& viskores::RangeId3::operator[] ( IdComponent  c ) const

inlinenoexcept

operator[]() [2/2]

viskores::RangeId& viskores::RangeId3::operator[] ( IdComponent  c )

inlinenoexcept

Union()

viskores::RangeId3 viskores::RangeId3::Union ( const viskores::RangeId3 &  other ) const

inline

Return the union of this and another range.

This is a nondestructive form of Include.

Member Data Documentation

X

viskores::RangeId viskores::RangeId3::X

The range of values in the X direction.

The viskores::RangeId struct provides the minimum and maximum along that axis.

Y

viskores::RangeId viskores::RangeId3::Y

The range of values in the Y direction.

The viskores::RangeId struct provides the minimum and maximum along that axis.

Z

viskores::RangeId viskores::RangeId3::Z

The range of values in the Z direction.

The viskores::RangeId struct provides the minimum and maximum along that axis.

---

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

• RangeId3.h