Go to the documentation of this file.
31 #ifndef OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
32 #define OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
43 namespace tbb {
class split; }
61 using Limits = std::numeric_limits<ValueType>;
66 explicit Coord(
const Vec3i& v): mVec{{v[0], v[1], v[2]}} {}
68 explicit Coord(
const Int32* v): mVec{{v[0], v[1], v[2]}} {}
121 return Coord(mVec[0] + dx, mVec[1] + dy, mVec[2] + dz);
141 return Coord(mVec[0] + rhs[0], mVec[1] + rhs[1], mVec[2] + rhs[2]);
145 return Coord(mVec[0] - rhs[0], mVec[1] - rhs[1], mVec[2] - rhs[2]);
149 Coord operator>> (
size_t n)
const {
return Coord(mVec[0]>>n, mVec[1]>>n, mVec[2]>>n); }
153 Coord operator& (
Int32 n)
const {
return Coord(mVec[0] & n, mVec[1] & n, mVec[2] & n); }
154 Coord operator| (
Int32 n)
const {
return Coord(mVec[0] | n, mVec[1] | n, mVec[2] | n); }
155 Coord& operator&= (
Int32 n) { mVec[0]&=n; mVec[1]&=n; mVec[2]&=n;
return *
this; }
156 Coord& operator|= (
Int32 n) { mVec[0]|=n; mVec[1]|=n; mVec[2]|=n;
return *
this; }
179 return (mVec[0] == rhs.mVec[0] && mVec[1] == rhs.mVec[1] && mVec[2] == rhs.mVec[2]);
186 return this->x() < rhs.
x() ? true : this->x() > rhs.
x() ? false
187 : this->y() < rhs.
y() ? true : this->y() > rhs.
y() ? false
188 : this->z() < rhs.
z() ? true :
false;
193 return this->x() < rhs.
x() ? true : this->x() > rhs.
x() ? false
194 : this->y() < rhs.
y() ? true : this->y() > rhs.
y() ? false
195 : this->z() <=rhs.
z() ? true :
false;
205 mVec[0] =
std::min(mVec[0], other.mVec[0]);
206 mVec[1] =
std::min(mVec[1], other.mVec[1]);
207 mVec[2] =
std::min(mVec[2], other.mVec[2]);
213 mVec[0] =
std::max(mVec[0], other.mVec[0]);
214 mVec[1] =
std::max(mVec[1], other.mVec[1]);
215 mVec[2] =
std::max(mVec[2], other.mVec[2]);
238 return (a[0] < b[0] || a[1] < b[1] || a[2] < b[2]);
247 void read(std::istream& is) { is.read(reinterpret_cast<char*>(mVec.data()),
sizeof(mVec)); }
250 os.write(reinterpret_cast<const char*>(mVec.data()),
sizeof(mVec));
256 template <
int Log2N = 20>
257 inline size_t hash()
const {
return ( (1<<Log2N)-1 ) & (mVec[0]*73856093 ^ mVec[1]*19349663 ^ mVec[2]*83492791); }
260 std::array<Int32, 3> mVec;
280 template<
bool ZYXOrder>
291 operator bool()
const {
return ZYXOrder ? (mPos[0] <= mMax[0]) : (mPos[2] <= mMax[2]); }
297 return ((mPos == other.mPos) && (mMin == other.mMin) && (mMax == other.mMax));
302 template<
size_t a,
size_t b,
size_t c>
305 if (mPos[a] < mMax[a]) { ++mPos[a]; }
306 else if (mPos[b] < mMax[b]) { mPos[a] = mMin[a]; ++mPos[b]; }
307 else if (mPos[c] <= mMax[c]) { mPos[a] = mMin[a]; mPos[b] = mMin[b]; ++mPos[c]; }
309 Coord mPos, mMin, mMax;
323 : mMin(xMin, yMin, zMin), mMax(xMax, yMax, zMax)
330 assert(this->is_divisible());
331 const size_t n = this->maxExtent();
332 mMax[n] = (mMin[n] + mMax[n]) >> 1;
333 other.mMin[n] = mMax[n] + 1;
381 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
382 #pragma GCC diagnostic push
383 #pragma GCC diagnostic ignored "-Wstrict-overflow"
385 return (mMin[0] > mMax[0] || mMin[1] > mMax[1] || mMin[2] > mMax[2]);
386 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
387 #pragma GCC diagnostic pop
391 operator bool()
const {
return !this->empty(); }
408 const Coord d = this->dim();
412 bool is_divisible()
const {
return mMin[0]<mMax[0] && mMin[1]<mMax[1] && mMin[2]<mMax[2]; }
415 size_t minExtent()
const {
return this->dim().minIndex(); }
418 size_t maxExtent()
const {
return this->dim().maxIndex(); }
441 mMin.offset(-padding);
442 mMax.offset( padding);
448 return CoordBBox(mMin.offsetBy(-padding),mMax.offsetBy(padding));
454 mMin.minComponent(xyz);
455 mMax.maxComponent(xyz);
461 mMin.minComponent(bbox.
min());
462 mMax.maxComponent(bbox.
max());
467 mMin.maxComponent(bbox.
min());
468 mMax.minComponent(bbox.
max());
474 mMin.minComponent(
min);
475 mMax.maxComponent(
min.offsetBy(dim-1));
493 assert(p !=
nullptr);
494 p->
reset(mMin.x(), mMin.y(), mMin.z()); ++p;
495 p->
reset(mMin.x(), mMin.y(), mMax.z()); ++p;
496 p->
reset(mMin.x(), mMax.y(), mMin.z()); ++p;
497 p->
reset(mMin.x(), mMax.y(), mMax.z()); ++p;
498 p->
reset(mMax.x(), mMin.y(), mMin.z()); ++p;
499 p->
reset(mMax.x(), mMin.y(), mMax.z()); ++p;
500 p->
reset(mMax.x(), mMax.y(), mMin.z()); ++p;
501 p->
reset(mMax.x(), mMax.y(), mMax.z());
517 void read(std::istream& is) { mMin.read(is); mMax.read(is); }
519 void write(std::ostream& os)
const { mMin.write(os); mMax.write(os); }
531 os << xyz.
asVec3i();
return os;
569 template <
typename T>
581 template <
typename T>
596 os << b.
min() <<
" -> " << b.
max();
616 std::size_t
operator()(
const Coord& ijk)
const noexcept {
return ijk.Coord::hash<>(); }
621 #endif // OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
size_t maxExtent() const
Return the index (0, 1 or 2) of the longest axis.
Definition: Coord.h:418
Coord(Int32 x, Int32 y, Int32 z)
Definition: Coord.h:65
uint64_t Index64
Definition: Coord.h:274
Coord argument_type
Definition: Coord.h:614
CoordBBox & operator>>=(size_t n)
Definition: Coord.h:509
bool operator>(const Coord &rhs) const
Lexicographic greater than.
Definition: Coord.h:198
Int32 & y()
Definition: Coord.h:163
void expand(const CoordBBox &bbox)
Union this bounding box with the given bounding box.
Definition: Coord.h:459
Coord(const Vec3I &v)
Definition: Coord.h:67
Coord & setX(Int32 x)
Definition: Coord.h:107
bool empty() const
Return true if this bounding box is empty (i.e., encloses no coordinates).
Definition: Coord.h:379
openvdb::math::Coord Coord
Definition: Coord.h:613
Int32 & z()
Definition: Coord.h:164
Coord(const Int32 *v)
Definition: Coord.h:68
void reset(const Coord &min, const Coord &max)
Definition: Coord.h:351
Coord & min()
Definition: Coord.h:347
Coord & max()
Definition: Coord.h:348
std::numeric_limits< ValueType > Limits
Definition: Coord.h:61
bool operator!=(const Iterator &other) const
Return true if this iterator and the given iterator point to different coordinates.
Definition: Coord.h:300
Coord & offset(Int32 dx, Int32 dy, Int32 dz)
Definition: Coord.h:111
Coord & operator+=(const Coord &rhs)
Definition: Coord.h:125
Vec3< int32_t > Vec3i
Definition: Vec3.h:686
Coord & reset(Int32 x, Int32 y, Int32 z)
Reset all three coordinates with the specified arguments.
Definition: Coord.h:97
void moveMin(const Coord &min)
Move this bounding box to the specified min.
Definition: Coord.h:482
const Int32 * data() const
Definition: Coord.h:167
size_t maxIndex() const
Return the index (0, 1 or 2) with the largest value.
Definition: Coord.h:245
bool isInside(const Coord &xyz) const
Return true if point (x, y, z) is inside this bounding box.
Definition: Coord.h:421
static Coord max()
Return the largest possible coordinate.
Definition: Coord.h:74
Vec3s asVec3s() const
Definition: Coord.h:172
uint32_t Index32
Definition: Coord.h:56
static CoordBBox inf()
Return an "infinite" bounding box, as defined by the Coord value range.
Definition: Coord.h:342
void getCornerPoints(Coord *p) const
Populates an array with the eight corner points of this bounding box.
Definition: Coord.h:491
Index64 volume() const
Return the integer volume of coordinates spanned by this bounding box.
Definition: Coord.h:406
Coord Abs(const Coord &xyz)
Definition: Coord.h:536
void asXYZ(Int32 &x, Int32 &y, Int32 &z) const
Definition: Coord.h:175
void minComponent(const Coord &other)
Perform a component-wise minimum with the other Coord.
Definition: Coord.h:203
size_t hash() const
Return a hash value for this coordinate.
Definition: Coord.h:257
XYZIterator endXYZ() const
Return an XYZ-order iterator that points past the maximum coordinate.
Definition: Coord.h:373
const Int32 * asPointer() const
Definition: Coord.h:169
Vec3d getCenter() const
Return the floating-point position of the center of this bounding box.
Definition: Coord.h:396
void resetToCube(const Coord &min, ValueType dim)
Definition: Coord.h:352
Int32 * asPointer()
Definition: Coord.h:170
int32_t Int32
Definition: Types.h:63
Vec3d asVec3d() const
Definition: Coord.h:171
void expand(ValueType padding)
Pad this bounding box with the specified padding.
Definition: Coord.h:439
void read(std::istream &is)
Unserialize this bounding box from the given stream.
Definition: Coord.h:517
bool operator==(const Iterator &other) const
Return true if this iterator and the given iterator point to the same coordinate.
Definition: Coord.h:295
static CoordBBox createCube(const Coord &min, ValueType dim)
Definition: Coord.h:336
Coord & operator>>=(size_t n)
Definition: Coord.h:152
void expand(const Coord &xyz)
Expand this bounding box to enclose point (x, y, z).
Definition: Coord.h:452
bool operator!=(const Coord &rhs) const
Definition: Coord.h:181
static Coord maxComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise maximum of the two Coords.
Definition: Coord.h:227
Int32 z() const
Definition: Coord.h:160
Coord operator-(const Coord &rhs) const
Definition: Coord.h:143
Vec3i asVec3i() const
Definition: Coord.h:173
Iterator & operator++()
Increment the iterator to point to the next coordinate.
Definition: Coord.h:289
Vec3< typename promote< T, typename Coord::ValueType >::type > operator+(const Coord &v1, const Vec3< T > &v0)
Definition: Coord.h:557
Vec3< typename promote< T, Coord::ValueType >::type > operator-(const Coord &v1, const Vec3< T > &v0)
Definition: Coord.h:583
bool isInside(const CoordBBox &b) const
Return true if the given bounding box is inside this bounding box.
Definition: Coord.h:427
void moveMax(const Coord &max)
Move this bounding box to the specified max.
Definition: Coord.h:485
XYZIterator beginXYZ() const
Return an XYZ-order iterator that points to the minimum coordinate.
Definition: Coord.h:366
void translate(const Coord &t)
Translate this bounding box by (tx, ty, tz).
Definition: Coord.h:479
CoordBBox()
The default constructor produces an empty bounding box.
Definition: Coord.h:317
CoordBBox(const Coord &min, const Coord &max)
Construct a bounding box with the given min and max bounds.
Definition: Coord.h:319
Coord & setZ(Int32 z)
Definition: Coord.h:109
static bool lessThan(const Coord &a, const Coord &b)
Definition: Coord.h:236
bool operator==(const CoordBBox &rhs) const
Definition: Coord.h:375
static Coord min()
Return the smallest possible coordinate.
Definition: Coord.h:71
Int32 & x()
Definition: Coord.h:162
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
bool is_divisible() const
Return true if this bounding box can be subdivided [mainly for use by TBB].
Definition: Coord.h:412
Coord getStart() const
Return the minimum coordinate.
Definition: Coord.h:356
bool hasVolume() const
Return true if this bounding box is nonempty (i.e., encloses at least one coordinate).
Definition: Coord.h:393
Iterator(const CoordBBox &b)
C-tor from a bounding box.
Definition: Coord.h:285
Coord & operator-=(const Coord &rhs)
Definition: Coord.h:132
Int32 ValueType
Definition: Coord.h:60
std::size_t result_type
Definition: Coord.h:615
Int32 & operator[](size_t i)
Definition: Coord.h:165
bool operator<(const Coord &rhs) const
Lexicographic less than.
Definition: Coord.h:184
bool hasOverlap(const CoordBBox &b) const
Return true if the given bounding box overlaps with this bounding box.
Definition: Coord.h:433
Coord offsetBy(Int32 n) const
Definition: Coord.h:123
std::ostream & operator<<(std::ostream &os, const CoordBBox &b)
Definition: Coord.h:594
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 co...
Definition: Coord.h:472
Int32 operator[](size_t i) const
Definition: Coord.h:161
uint64_t Index64
Definition: Types.h:60
static Coord round(const Vec3< T > &xyz)
Return xyz rounded to the closest integer coordinates (cell centered conversion).
Definition: Coord.h:78
CoordBBox & operator<<=(size_t n)
Definition: Coord.h:508
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:52
static Coord minComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise minimum of the two Coords.
Definition: Coord.h:219
Int32 y() const
Definition: Coord.h:159
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:271
bool operator==(const Coord &rhs) const
Definition: Coord.h:177
Coord()
Definition: Coord.h:63
math::Vec3< Index32 > Vec3I
Definition: Types.h:80
std::size_t operator()(const Coord &ijk) const noexcept
Definition: Coord.h:616
void intersect(const CoordBBox &bbox)
Intersect this bounding box with the given bounding box.
Definition: Coord.h:465
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:177
const Coord & operator*() const
Return a const reference to the coordinate currently pointed to.
Definition: Coord.h:293
Vec3< double > Vec3d
Definition: Vec3.h:689
Int32 x() const
Definition: Coord.h:158
Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
Definition: Coord.h:119
bool operator>=(const Coord &rhs) const
Lexicographic greater than or equal to.
Definition: Coord.h:200
uint32_t Index32
Definition: Types.h:59
Vec3< float > Vec3s
Definition: Vec3.h:688
Coord(Int32 xyz)
Definition: Coord.h:64
CoordBBox expandBy(ValueType padding) const
Return a new instance that is expanded by the specified padding.
Definition: Coord.h:446
int Floor(float x)
Return the floor of x.
Definition: Math.h:802
static Coord floor(const Vec3< T > &xyz)
Return the largest integer coordinates that are not greater than xyz (node centered conversion).
Definition: Coord.h:84
Coord extents() const
Definition: Coord.h:403
int Ceil(float x)
Return the ceiling of x.
Definition: Math.h:810
Coord dim() const
Return the dimensions of the coordinates spanned by this bounding box.
Definition: Coord.h:401
ZYXIterator begin() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:362
size_t MaxIndex(const Vec3T &v)
Return the index [0,1,2] of the largest value in a 3D vector.
Definition: Math.h:911
size_t minExtent() const
Return the index (0, 1 or 2) of the shortest axis.
Definition: Coord.h:415
bool operator!=(const CoordBBox &rhs) const
Definition: Coord.h:376
size_t MinIndex(const Vec3T &v)
Return the index [0,1,2] of the smallest value in a 3D vector.
Definition: Math.h:890
Vec3I asVec3I() const
Definition: Coord.h:174
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:125
const Coord & min() const
Definition: Coord.h:344
Coord & reset(Int32 xyz)
Reset all three coordinates with the same specified argument.
Definition: Coord.h:105
float Round(float x)
Return x rounded to the nearest integer.
Definition: Math.h:773
int32_t Int32
Definition: Coord.h:55
Coord & setY(Int32 y)
Definition: Coord.h:108
void read(std::istream &is)
Definition: Coord.h:247
Coord & operator<<=(size_t n)
Definition: Coord.h:151
bool operator<=(const Coord &rhs) const
Lexicographic less than or equal to.
Definition: Coord.h:191
CoordBBox(ValueType xMin, ValueType yMin, ValueType zMin, ValueType xMax, ValueType yMax, ValueType zMax)
Construct from individual components of the min and max bounds.
Definition: Coord.h:321
void maxComponent(const Coord &other)
Perform a component-wise maximum with the other Coord.
Definition: Coord.h:211
Iterator over the Coord domain covered by a CoordBBox.
Definition: Coord.h:281
ZYXIterator beginZYX() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:364
static Coord ceil(const Vec3< T > &xyz)
Return the largest integer coordinates that are not greater than xyz+1 (node centered conversion).
Definition: Coord.h:91
Coord::ValueType ValueType
Definition: Coord.h:275
ZYXIterator end() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:369
void reset()
Definition: Coord.h:350
Coord operator-() const
Definition: Coord.h:147
Definition: Exceptions.h:40
CoordBBox(CoordBBox &other, const tbb::split &)
Splitting constructor for use in TBB ranges.
Definition: Coord.h:328
ZYXIterator endZYX() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:371
size_t minIndex() const
Return the index (0, 1 or 2) with the smallest value.
Definition: Coord.h:242
Coord & offset(Int32 n)
Definition: Coord.h:118
Coord getEnd() const
Return the maximum coordinate plus one.
Definition: Coord.h:359
Coord(const Vec3i &v)
Definition: Coord.h:66
void write(std::ostream &os) const
Definition: Coord.h:248
Coord operator+(const Coord &rhs) const
Definition: Coord.h:139
Int32 * data()
Definition: Coord.h:168
const Coord & max() const
Definition: Coord.h:345
void write(std::ostream &os) const
Serialize this bounding box to the given stream.
Definition: Coord.h:519