HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::math::CoordBBox Class Reference

Axis-aligned bounding box of signed integer coordinates. More...

#include <Coord.h>

Classes

class  Iterator
 Iterator over the Coord domain covered by a CoordBBox. More...
 

Public Types

using Index64 = uint64_t
 
using ValueType = Coord::ValueType
 
using ZYXIterator = Iterator< true >
 
using XYZIterator = Iterator< false >
 

Public Member Functions

 CoordBBox ()
 The default constructor produces an empty bounding box. More...
 
 CoordBBox (const Coord &min, const Coord &max)
 Construct a bounding box with the given min and max bounds. More...
 
 CoordBBox (ValueType xMin, ValueType yMin, ValueType zMin, ValueType xMax, ValueType yMax, ValueType zMax)
 Construct from individual components of the min and max bounds. More...
 
 CoordBBox (CoordBBox &other, const tbb::split &)
 Splitting constructor for use in TBB ranges. More...
 
const Coordmin () const
 
const Coordmax () const
 
Coordmin ()
 
Coordmax ()
 
void reset ()
 
void reset (const Coord &min, const Coord &max)
 
void resetToCube (const Coord &min, ValueType dim)
 
Coord getStart () const
 Return the minimum coordinate. More...
 
Coord getEnd () const
 Return the maximum coordinate plus one. More...
 
ZYXIterator begin () const
 Return a ZYX-order iterator that points to the minimum coordinate. More...
 
ZYXIterator beginZYX () const
 Return a ZYX-order iterator that points to the minimum coordinate. More...
 
XYZIterator beginXYZ () const
 Return an XYZ-order iterator that points to the minimum coordinate. More...
 
ZYXIterator end () const
 Return a ZYX-order iterator that points past the maximum coordinate. More...
 
ZYXIterator endZYX () const
 Return a ZYX-order iterator that points past the maximum coordinate. More...
 
XYZIterator endXYZ () const
 Return an XYZ-order iterator that points past the maximum coordinate. More...
 
bool operator== (const CoordBBox &rhs) const
 
bool operator!= (const CoordBBox &rhs) const
 
bool empty () const
 Return true if this bounding box is empty (i.e., encloses no coordinates). More...
 
 operator bool () const
 Return true if this bounding box is nonempty (i.e., encloses at least one coordinate). More...
 
bool hasVolume () const
 Return true if this bounding box is nonempty (i.e., encloses at least one coordinate). More...
 
Vec3d getCenter () const
 Return the floating-point position of the center of this bounding box. More...
 
Coord dim () const
 Return the dimensions of the coordinates spanned by this bounding box. More...
 
Coord extents () const
 
Index64 volume () const
 Return the integer volume of coordinates spanned by this bounding box. More...
 
bool is_divisible () const
 Return true if this bounding box can be subdivided [mainly for use by TBB]. More...
 
size_t minExtent () const
 Return the index (0, 1 or 2) of the shortest axis. More...
 
size_t maxExtent () const
 Return the index (0, 1 or 2) of the longest axis. More...
 
bool isInside (const Coord &xyz) const
 Return true if point (x, y, z) is inside this bounding box. More...
 
bool isInside (const CoordBBox &b) const
 Return true if the given bounding box is inside this bounding box. More...
 
bool hasOverlap (const CoordBBox &b) const
 Return true if the given bounding box overlaps with this bounding box. More...
 
void expand (ValueType padding)
 Pad this bounding box with the specified padding. More...
 
CoordBBox expandBy (ValueType padding) const
 Return a new instance that is expanded by the specified padding. More...
 
void expand (const Coord &xyz)
 Expand this bounding box to enclose point (x, y, z). More...
 
void expand (const CoordBBox &bbox)
 Union this bounding box with the given bounding box. More...
 
void intersect (const CoordBBox &bbox)
 Intersect this bounding box with the given bounding box. More...
 
void expand (const Coord &min, Coord::ValueType dim)
 Union this bounding box with the cubical bounding box of the given size and with the given minimum coordinates. More...
 
void translate (const Coord &t)
 
void getCornerPoints (Coord *p) const
 Populates an array with the eight corner points of this bounding box. More...
 
void read (std::istream &is)
 Unserialize this bounding box from the given stream. More...
 
void write (std::ostream &os) const
 Serialize this bounding box to the given stream. More...
 
CoordBBox operator>> (size_t n) const
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBox operator<< (size_t n) const
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBoxoperator<<= (size_t n)
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBoxoperator>>= (size_t n)
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBox operator& (Coord::Int32 n) const
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBox operator| (Coord::Int32 n) const
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBoxoperator&= (Coord::Int32 n)
 Bit-wise operations performed on both the min and max members. More...
 
CoordBBoxoperator|= (Coord::Int32 n)
 Bit-wise operations performed on both the min and max members. More...
 

Static Public Member Functions

static CoordBBox createCube (const Coord &min, ValueType dim)
 
static CoordBBox inf ()
 Return an "infinite" bounding box, as defined by the Coord value range. More...
 

Detailed Description

Axis-aligned bounding box of signed integer coordinates.

Note
The range of the integer coordinates, [min, max], is inclusive. Thus, a bounding box with min = max is not empty but rather encloses a single coordinate.

Definition at line 264 of file Coord.h.

Member Typedef Documentation

Definition at line 267 of file Coord.h.

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::CoordBBox ( )
inline

The default constructor produces an empty bounding box.

Definition at line 310 of file Coord.h.

openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::CoordBBox ( const Coord min,
const Coord max 
)
inline

Construct a bounding box with the given min and max bounds.

Definition at line 312 of file Coord.h.

openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::CoordBBox ( ValueType  xMin,
ValueType  yMin,
ValueType  zMin,
ValueType  xMax,
ValueType  yMax,
ValueType  zMax 
)
inline

Construct from individual components of the min and max bounds.

Definition at line 314 of file Coord.h.

openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::CoordBBox ( CoordBBox other,
const tbb::split &   
)
inline

Splitting constructor for use in TBB ranges.

Note
The other bounding box is assumed to be divisible.

Definition at line 321 of file Coord.h.

Member Function Documentation

ZYXIterator openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::begin ( void  ) const
inline

Return a ZYX-order iterator that points to the minimum coordinate.

Definition at line 355 of file Coord.h.

XYZIterator openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::beginXYZ ( ) const
inline

Return an XYZ-order iterator that points to the minimum coordinate.

Definition at line 359 of file Coord.h.

ZYXIterator openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::beginZYX ( ) const
inline

Return a ZYX-order iterator that points to the minimum coordinate.

Definition at line 357 of file Coord.h.

static CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::createCube ( const Coord min,
ValueType  dim 
)
inlinestatic

Definition at line 329 of file Coord.h.

Coord openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::dim ( ) const
inline

Return the dimensions of the coordinates spanned by this bounding box.

Note
Since coordinates are inclusive, a bounding box with min = max has dimensions of (1, 1, 1).

Definition at line 384 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::empty ( void  ) const
inline

Return true if this bounding box is empty (i.e., encloses no coordinates).

Definition at line 372 of file Coord.h.

ZYXIterator openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::end ( void  ) const
inline

Return a ZYX-order iterator that points past the maximum coordinate.

Definition at line 362 of file Coord.h.

XYZIterator openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::endXYZ ( ) const
inline

Return an XYZ-order iterator that points past the maximum coordinate.

Definition at line 366 of file Coord.h.

ZYXIterator openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::endZYX ( ) const
inline

Return a ZYX-order iterator that points past the maximum coordinate.

Definition at line 364 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::expand ( ValueType  padding)
inline

Pad this bounding box with the specified padding.

Definition at line 422 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::expand ( const Coord xyz)
inline

Expand this bounding box to enclose point (x, y, z).

Definition at line 435 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::expand ( const CoordBBox bbox)
inline

Union this bounding box with the given bounding box.

Definition at line 442 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::expand ( const Coord min,
Coord::ValueType  dim 
)
inline

Union this bounding box with the cubical bounding box of the given size and with the given minimum coordinates.

Definition at line 455 of file Coord.h.

CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::expandBy ( ValueType  padding) const
inline

Return a new instance that is expanded by the specified padding.

Definition at line 429 of file Coord.h.

Coord openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::extents ( ) const
inline
Todo:
deprecate - use dim instead

Definition at line 386 of file Coord.h.

Vec3d openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::getCenter ( ) const
inline

Return the floating-point position of the center of this bounding box.

Definition at line 379 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::getCornerPoints ( Coord p) const
inline

Populates an array with the eight corner points of this bounding box.

The ordering of the corner points is lexicographic.

Warning
It is assumed that the pointer can be incremented at least seven times, i.e. has storage for eight Coord elements!

Definition at line 468 of file Coord.h.

Coord openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::getEnd ( void  ) const
inline

Return the maximum coordinate plus one.

Note
This end coordinate is exclusive.

Definition at line 352 of file Coord.h.

Coord openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::getStart ( ) const
inline

Return the minimum coordinate.

Note
The start coordinate is inclusive.

Definition at line 349 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::hasOverlap ( const CoordBBox b) const
inline

Return true if the given bounding box overlaps with this bounding box.

Definition at line 416 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::hasVolume ( ) const
inline

Return true if this bounding box is nonempty (i.e., encloses at least one coordinate).

Definition at line 376 of file Coord.h.

static CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::inf ( )
inlinestatic

Return an "infinite" bounding box, as defined by the Coord value range.

Definition at line 335 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::intersect ( const CoordBBox bbox)
inline

Intersect this bounding box with the given bounding box.

Definition at line 448 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::is_divisible ( ) const
inline

Return true if this bounding box can be subdivided [mainly for use by TBB].

Definition at line 395 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::isInside ( const Coord xyz) const
inline

Return true if point (x, y, z) is inside this bounding box.

Definition at line 404 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::isInside ( const CoordBBox b) const
inline

Return true if the given bounding box is inside this bounding box.

Definition at line 410 of file Coord.h.

const Coord& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::max ( ) const
inline

Definition at line 338 of file Coord.h.

Coord& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::max ( )
inline

Definition at line 341 of file Coord.h.

size_t openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::maxExtent ( ) const
inline

Return the index (0, 1 or 2) of the longest axis.

Definition at line 401 of file Coord.h.

const Coord& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::min ( ) const
inline

Definition at line 337 of file Coord.h.

Coord& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::min ( )
inline

Definition at line 340 of file Coord.h.

size_t openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::minExtent ( ) const
inline

Return the index (0, 1 or 2) of the shortest axis.

Definition at line 398 of file Coord.h.

openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator bool ( ) const
inline

Return true if this bounding box is nonempty (i.e., encloses at least one coordinate).

Definition at line 374 of file Coord.h.

Definition at line 369 of file Coord.h.

CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator& ( Coord::Int32  n) const
inline

Bit-wise operations performed on both the min and max members.

Definition at line 487 of file Coord.h.

CoordBBox& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator&= ( Coord::Int32  n)
inline

Bit-wise operations performed on both the min and max members.

Definition at line 489 of file Coord.h.

CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator<< ( size_t  n) const
inline

Bit-wise operations performed on both the min and max members.

Definition at line 484 of file Coord.h.

CoordBBox& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator<<= ( size_t  n)
inline

Bit-wise operations performed on both the min and max members.

Definition at line 485 of file Coord.h.

bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator== ( const CoordBBox rhs) const
inline

Definition at line 368 of file Coord.h.

CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator>> ( size_t  n) const
inline

Bit-wise operations performed on both the min and max members.

Definition at line 483 of file Coord.h.

CoordBBox& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator>>= ( size_t  n)
inline

Bit-wise operations performed on both the min and max members.

Definition at line 486 of file Coord.h.

CoordBBox openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator| ( Coord::Int32  n) const
inline

Bit-wise operations performed on both the min and max members.

Definition at line 488 of file Coord.h.

CoordBBox& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::operator|= ( Coord::Int32  n)
inline

Bit-wise operations performed on both the min and max members.

Definition at line 490 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::read ( std::istream &  is)
inline

Unserialize this bounding box from the given stream.

Definition at line 494 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::reset ( void  )
inline

Definition at line 343 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::reset ( const Coord min,
const Coord max 
)
inline

Definition at line 344 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::resetToCube ( const Coord min,
ValueType  dim 
)
inline

Definition at line 345 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::translate ( const Coord t)
inline

Translate this bounding box by (tx, ty, tz).

Definition at line 462 of file Coord.h.

Index64 openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::volume ( ) const
inline

Return the integer volume of coordinates spanned by this bounding box.

Note
Since coordinates are inclusive, a bounding box with min = max has volume one.

Definition at line 389 of file Coord.h.

void openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::write ( std::ostream &  os) const
inline

Serialize this bounding box to the given stream.

Definition at line 496 of file Coord.h.


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