OpenVDB 10.0.1
Loading...
Searching...
No Matches
Coord.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: MPL-2.0
3
4#ifndef OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
5#define OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
6
7#include <functional>// for std::hash
8#include <algorithm> // for std::min(), std::max()
9#include <array> // for std::array
10#include <iostream>
11#include <limits>
12#include <openvdb/Platform.h>
13#include "Math.h"
14#include "Vec3.h"
15
16#include <tbb/blocked_range.h> // for tbb::split
17
18namespace openvdb {
20namespace OPENVDB_VERSION_NAME {
21namespace math {
22
23/// @brief Signed (x, y, z) 32-bit integer coordinates
24class Coord
25{
26public:
27 using Int32 = int32_t;
28 using Index32 = uint32_t;
31
33 using Limits = std::numeric_limits<ValueType>;
34
35 Coord(): mVec{{0, 0, 0}} {}
36 explicit Coord(Int32 xyz): mVec{{xyz, xyz, xyz}} {}
37 Coord(Int32 x, Int32 y, Int32 z): mVec{{x, y, z}} {}
38 explicit Coord(const Vec3i& v): mVec{{v[0], v[1], v[2]}} {}
39 explicit Coord(const Vec3I& v): mVec{{Int32(v[0]), Int32(v[1]), Int32(v[2])}} {}
40 explicit Coord(const Int32* v): mVec{{v[0], v[1], v[2]}} {}
41
42 /// @brief Return the smallest possible coordinate
43 static Coord min() { return Coord(Limits::min()); }
44
45 /// @brief Return the largest possible coordinate
46 static Coord max() { return Coord(Limits::max()); }
47
48 /// @brief Return @a xyz rounded to the closest integer coordinates
49 /// (cell centered conversion).
50 template<typename T> static Coord round(const Vec3<T>& xyz)
51 {
52 return Coord(Int32(Round(xyz[0])), Int32(Round(xyz[1])), Int32(Round(xyz[2])));
53 }
54 /// @brief Return the largest integer coordinates that are not greater
55 /// than @a xyz (node centered conversion).
56 template<typename T> static Coord floor(const Vec3<T>& xyz)
57 {
58 return Coord(Int32(Floor(xyz[0])), Int32(Floor(xyz[1])), Int32(Floor(xyz[2])));
59 }
60
61 /// @brief Return the largest integer coordinates that are not greater
62 /// than @a xyz+1 (node centered conversion).
63 template<typename T> static Coord ceil(const Vec3<T>& xyz)
64 {
65 return Coord(Int32(Ceil(xyz[0])), Int32(Ceil(xyz[1])), Int32(Ceil(xyz[2])));
66 }
67
68 /// @brief Reset all three coordinates with the specified arguments
70 {
71 mVec[0] = x;
72 mVec[1] = y;
73 mVec[2] = z;
74 return *this;
75 }
76 /// @brief Reset all three coordinates with the same specified argument
77 Coord& reset(Int32 xyz) { return this->reset(xyz, xyz, xyz); }
78
79 Coord& setX(Int32 x) { mVec[0] = x; return *this; }
80 Coord& setY(Int32 y) { mVec[1] = y; return *this; }
81 Coord& setZ(Int32 z) { mVec[2] = z; return *this; }
82
84 {
85 mVec[0] += dx;
86 mVec[1] += dy;
87 mVec[2] += dz;
88 return *this;
89 }
90 Coord& offset(Int32 n) { return this->offset(n, n, n); }
91 Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
92 {
93 return Coord(mVec[0] + dx, mVec[1] + dy, mVec[2] + dz);
94 }
95 Coord offsetBy(Int32 n) const { return offsetBy(n, n, n); }
96
97 Coord& operator+=(const Coord& rhs)
98 {
99 mVec[0] += rhs[0];
100 mVec[1] += rhs[1];
101 mVec[2] += rhs[2];
102 return *this;
103 }
104 Coord& operator-=(const Coord& rhs)
105 {
106 mVec[0] -= rhs[0];
107 mVec[1] -= rhs[1];
108 mVec[2] -= rhs[2];
109 return *this;
110 }
111 Coord operator+(const Coord& rhs) const
112 {
113 return Coord(mVec[0] + rhs[0], mVec[1] + rhs[1], mVec[2] + rhs[2]);
114 }
115 Coord operator-(const Coord& rhs) const
116 {
117 return Coord(mVec[0] - rhs[0], mVec[1] - rhs[1], mVec[2] - rhs[2]);
118 }
119 Coord operator-() const { return Coord(-mVec[0], -mVec[1], -mVec[2]); }
120
121 Coord operator>> (size_t n) const { return Coord(mVec[0]>>n, mVec[1]>>n, mVec[2]>>n); }
122 Coord operator<< (size_t n) const { return Coord(mVec[0]<<n, mVec[1]<<n, mVec[2]<<n); }
123 Coord& operator<<=(size_t n) { mVec[0]<<=n; mVec[1]<<=n; mVec[2]<<=n; return *this; }
124 Coord& operator>>=(size_t n) { mVec[0]>>=n; mVec[1]>>=n; mVec[2]>>=n; return *this; }
125 Coord operator& (Int32 n) const { return Coord(mVec[0] & n, mVec[1] & n, mVec[2] & n); }
126 Coord operator| (Int32 n) const { return Coord(mVec[0] | n, mVec[1] | n, mVec[2] | n); }
127 Coord& operator&= (Int32 n) { mVec[0]&=n; mVec[1]&=n; mVec[2]&=n; return *this; }
128 Coord& operator|= (Int32 n) { mVec[0]|=n; mVec[1]|=n; mVec[2]|=n; return *this; }
129
130 Int32 x() const { return mVec[0]; }
131 Int32 y() const { return mVec[1]; }
132 Int32 z() const { return mVec[2]; }
133 Int32 operator[](size_t i) const { assert(i < 3); return mVec[i]; }
134 Int32& x() { return mVec[0]; }
135 Int32& y() { return mVec[1]; }
136 Int32& z() { return mVec[2]; }
137 Int32& operator[](size_t i) { assert(i < 3); return mVec[i]; }
138
139 const Int32* data() const { return mVec.data(); }
140 Int32* data() { return mVec.data(); }
141 const Int32* asPointer() const { return mVec.data(); }
142 Int32* asPointer() { return mVec.data(); }
143 Vec3d asVec3d() const { return Vec3d(double(mVec[0]), double(mVec[1]), double(mVec[2])); }
144 Vec3s asVec3s() const { return Vec3s(float(mVec[0]), float(mVec[1]), float(mVec[2])); }
145 Vec3i asVec3i() const { return Vec3i(mVec.data()); }
146 Vec3I asVec3I() const { return Vec3I(Index32(mVec[0]), Index32(mVec[1]), Index32(mVec[2])); }
147 void asXYZ(Int32& x, Int32& y, Int32& z) const { x = mVec[0]; y = mVec[1]; z = mVec[2]; }
148
149 bool operator==(const Coord& rhs) const
150 {
151 return (mVec[0] == rhs.mVec[0] && mVec[1] == rhs.mVec[1] && mVec[2] == rhs.mVec[2]);
152 }
153 bool operator!=(const Coord& rhs) const { return !(*this == rhs); }
154
155 /// Lexicographic less than
156 bool operator<(const Coord& rhs) const
157 {
158 return this->x() < rhs.x() ? true : this->x() > rhs.x() ? false
159 : this->y() < rhs.y() ? true : this->y() > rhs.y() ? false
160 : this->z() < rhs.z() ? true : false;
161 }
162 /// Lexicographic less than or equal to
163 bool operator<=(const Coord& rhs) const
164 {
165 return this->x() < rhs.x() ? true : this->x() > rhs.x() ? false
166 : this->y() < rhs.y() ? true : this->y() > rhs.y() ? false
167 : this->z() <=rhs.z() ? true : false;
168 }
169 /// Lexicographic greater than
170 bool operator>(const Coord& rhs) const { return !(*this <= rhs); }
171 /// Lexicographic greater than or equal to
172 bool operator>=(const Coord& rhs) const { return !(*this < rhs); }
173
174 /// Perform a component-wise minimum with the other Coord.
175 void minComponent(const Coord& other)
176 {
177 mVec[0] = std::min(mVec[0], other.mVec[0]);
178 mVec[1] = std::min(mVec[1], other.mVec[1]);
179 mVec[2] = std::min(mVec[2], other.mVec[2]);
180 }
181
182 /// Perform a component-wise maximum with the other Coord.
183 void maxComponent(const Coord& other)
184 {
185 mVec[0] = std::max(mVec[0], other.mVec[0]);
186 mVec[1] = std::max(mVec[1], other.mVec[1]);
187 mVec[2] = std::max(mVec[2], other.mVec[2]);
188 }
189
190 /// Return the component-wise minimum of the two Coords.
191 static inline Coord minComponent(const Coord& lhs, const Coord& rhs)
192 {
193 return Coord(std::min(lhs.x(), rhs.x()),
194 std::min(lhs.y(), rhs.y()),
195 std::min(lhs.z(), rhs.z()));
196 }
197
198 /// Return the component-wise maximum of the two Coords.
199 static inline Coord maxComponent(const Coord& lhs, const Coord& rhs)
200 {
201 return Coord(std::max(lhs.x(), rhs.x()),
202 std::max(lhs.y(), rhs.y()),
203 std::max(lhs.z(), rhs.z()));
204 }
205
206 /// Return true if any of the components of @a a are smaller than the
207 /// corresponding components of @a b.
208 static inline bool lessThan(const Coord& a, const Coord& b)
209 {
210 return (a[0] < b[0] || a[1] < b[1] || a[2] < b[2]);
211 }
212
213 /// @brief Return the index (0, 1 or 2) with the smallest value.
214 size_t minIndex() const { return MinIndex(mVec); }
215
216 /// @brief Return the index (0, 1 or 2) with the largest value.
217 size_t maxIndex() const { return MaxIndex(mVec); }
218
219 void read(std::istream& is) { is.read(reinterpret_cast<char*>(mVec.data()), sizeof(mVec)); }
220 void write(std::ostream& os) const
221 {
222 os.write(reinterpret_cast<const char*>(mVec.data()), sizeof(mVec));
223 }
224
225 /// @brief Return a hash value for this coordinate
226 /// @note Log2N is the binary logarithm of the hash table size.
227 /// @details The hash function is taken from the SIGGRAPH paper:
228 /// "VDB: High-resolution sparse volumes with dynamic topology"
229 template<int Log2N = 20>
230 size_t hash() const
231 {
232 const uint32_t* vec = reinterpret_cast<const uint32_t*>(mVec.data());
233 return ((1<<Log2N)-1) & (vec[0]*73856093 ^ vec[1]*19349663 ^ vec[2]*83492791);
234 }
235
236private:
237 std::array<Int32, 3> mVec;
238}; // class Coord
239
240
241////////////////////////////////////////
242
243
244/// @brief Axis-aligned bounding box of signed integer coordinates
245/// @note The range of the integer coordinates, [min, max], is inclusive.
246/// Thus, a bounding box with min = max is not empty but rather encloses
247/// a single coordinate.
249{
250public:
251 using Index64 = uint64_t;
253
254 /// @brief Iterator over the Coord domain covered by a CoordBBox
255 /// @note If ZYXOrder is @c true, @e z is the fastest-moving coordinate,
256 /// otherwise the traversal is in XYZ order (i.e., @e x is fastest-moving).
257 template<bool ZYXOrder>
259 {
260 public:
261 /// @brief C-tor from a bounding box
262 Iterator(const CoordBBox& b): mPos(b.min()), mMin(b.min()), mMax(b.max()) {}
263 /// @brief Increment the iterator to point to the next coordinate.
264 /// @details Iteration stops one past the maximum coordinate
265 /// along the axis determined by the template parameter.
266 Iterator& operator++() { ZYXOrder ? next<2,1,0>() : next<0,1,2>(); return *this; }
267 /// @brief Return @c true if the iterator still points to a valid coordinate.
268 operator bool() const { return ZYXOrder ? (mPos[0] <= mMax[0]) : (mPos[2] <= mMax[2]); }
269 /// @brief Return a const reference to the coordinate currently pointed to.
270 const Coord& operator*() const { return mPos; }
271 /// Return @c true if this iterator and the given iterator point to the same coordinate.
272 bool operator==(const Iterator& other) const
273 {
274 return ((mPos == other.mPos) && (mMin == other.mMin) && (mMax == other.mMax));
275 }
276 /// Return @c true if this iterator and the given iterator point to different coordinates.
277 bool operator!=(const Iterator& other) const { return !(*this == other); }
278 private:
279 template<size_t a, size_t b, size_t c>
280 void next()
281 {
282 if (mPos[a] < mMax[a]) { ++mPos[a]; } // this is the most common case
283 else if (mPos[b] < mMax[b]) { mPos[a] = mMin[a]; ++mPos[b]; }
284 else if (mPos[c] <= mMax[c]) { mPos[a] = mMin[a]; mPos[b] = mMin[b]; ++mPos[c]; }
285 }
286 Coord mPos, mMin, mMax;
287 friend class CoordBBox; // for CoordBBox::end()
288 };// CoordBBox::Iterator
289
290 using ZYXIterator = Iterator</*ZYX=*/true>;
291 using XYZIterator = Iterator</*ZYX=*/false>;
292
293 /// @brief The default constructor produces an empty bounding box.
294 CoordBBox(): mMin(Coord::max()), mMax(Coord::min()) {}
295 /// @brief Construct a bounding box with the given @a min and @a max bounds.
296 CoordBBox(const Coord& min, const Coord& max): mMin(min), mMax(max) {}
297 /// @brief Construct from individual components of the min and max bounds.
299 ValueType xMax, ValueType yMax, ValueType zMax)
300 : mMin(xMin, yMin, zMin), mMax(xMax, yMax, zMax)
301 {
302 }
303 /// @brief Splitting constructor for use in TBB ranges
304 /// @note The other bounding box is assumed to be divisible.
305 CoordBBox(CoordBBox& other, const tbb::split&): mMin(other.mMin), mMax(other.mMax)
306 {
307 assert(this->is_divisible());
308 const size_t n = this->maxExtent();
309 mMax[n] = (mMin[n] + mMax[n]) >> 1;
310 other.mMin[n] = mMax[n] + 1;
311 }
312
313 static CoordBBox createCube(const Coord& min, ValueType dim)
314 {
315 return CoordBBox(min, min.offsetBy(dim - 1));
316 }
317
318 /// Return an "infinite" bounding box, as defined by the Coord value range.
319 static CoordBBox inf() { return CoordBBox(Coord::min(), Coord::max()); }
320
321 const Coord& min() const { return mMin; }
322 const Coord& max() const { return mMax; }
323
324 Coord& min() { return mMin; }
325 Coord& max() { return mMax; }
326
327 void reset() { mMin = Coord::max(); mMax = Coord::min(); }
328 void reset(const Coord& min, const Coord& max) { mMin = min; mMax = max; }
329 void resetToCube(const Coord& min, ValueType dim) { mMin = min; mMax = min.offsetBy(dim - 1); }
330
331 /// @brief Return the minimum coordinate.
332 /// @note The start coordinate is inclusive.
333 Coord getStart() const { return mMin; }
334 /// @brief Return the maximum coordinate plus one.
335 /// @note This end coordinate is exclusive.
336 Coord getEnd() const { return mMax.offsetBy(1); }
337
338 /// @brief Return a ZYX-order iterator that points to the minimum coordinate.
339 ZYXIterator begin() const { return ZYXIterator{*this}; }
340 /// @brief Return a ZYX-order iterator that points to the minimum coordinate.
341 ZYXIterator beginZYX() const { return ZYXIterator{*this}; }
342 /// @brief Return an XYZ-order iterator that points to the minimum coordinate.
343 XYZIterator beginXYZ() const { return XYZIterator{*this}; }
344
345 /// @brief Return a ZYX-order iterator that points past the maximum coordinate.
346 ZYXIterator end() const { ZYXIterator it{*this}; it.mPos[0] = mMax[0] + 1; return it; }
347 /// @brief Return a ZYX-order iterator that points past the maximum coordinate.
348 ZYXIterator endZYX() const { return end(); }
349 /// @brief Return an XYZ-order iterator that points past the maximum coordinate.
350 XYZIterator endXYZ() const { XYZIterator it{*this}; it.mPos[2] = mMax[2] + 1; return it; }
351
352 bool operator==(const CoordBBox& rhs) const { return mMin == rhs.mMin && mMax == rhs.mMax; }
353 bool operator!=(const CoordBBox& rhs) const { return !(*this == rhs); }
354
355 /// @brief Return @c true if this bounding box is empty (i.e., encloses no coordinates).
356 bool empty() const
357 {
358#if defined(__GNUC__) && !defined(__INTEL_COMPILER)
359 #pragma GCC diagnostic push
360 #pragma GCC diagnostic ignored "-Wstrict-overflow"
361#endif
362 return (mMin[0] > mMax[0] || mMin[1] > mMax[1] || mMin[2] > mMax[2]);
363#if defined(__GNUC__) && !defined(__INTEL_COMPILER)
364 #pragma GCC diagnostic pop
365#endif
366 }
367 /// @brief Return @c true if this bounding box is nonempty
368 /// (i.e., encloses at least one coordinate).
369 operator bool() const { return !this->empty(); }
370 /// @brief Return @c true if this bounding box is nonempty
371 /// (i.e., encloses at least one coordinate).
372 bool hasVolume() const { return !this->empty(); }
373
374 /// @brief Return the floating-point position of the center of this bounding box.
375 Vec3d getCenter() const { return 0.5 * Vec3d((mMin + mMax).asPointer()); }
376
377 /// @brief Return the dimensions of the coordinates spanned by this bounding box.
378 /// @note Since coordinates are inclusive, a bounding box with min = max
379 /// has dimensions of (1, 1, 1).
380 Coord dim() const { return empty() ? Coord(0) : (mMax.offsetBy(1) - mMin); }
381 /// @todo deprecate - use dim instead
382 Coord extents() const { return this->dim(); }
383 /// @brief Return the integer volume of coordinates spanned by this bounding box.
384 /// @note Since coordinates are inclusive, a bounding box with min = max has volume one.
386 {
387 const Coord d = this->dim();
388 return Index64(d[0]) * Index64(d[1]) * Index64(d[2]);
389 }
390 /// @brief Return @c true if this bounding box can be subdivided [mainly for use by TBB].
391 bool is_divisible() const { return mMin[0]<mMax[0] && mMin[1]<mMax[1] && mMin[2]<mMax[2]; }
392
393 /// @brief Return the index (0, 1 or 2) of the shortest axis.
394 size_t minExtent() const { return this->dim().minIndex(); }
395
396 /// @brief Return the index (0, 1 or 2) of the longest axis.
397 size_t maxExtent() const { return this->dim().maxIndex(); }
398
399 /// @brief Return @c true if point (x, y, z) is inside this bounding box.
400 bool isInside(const Coord& xyz) const
401 {
402 return !(Coord::lessThan(xyz,mMin) || Coord::lessThan(mMax,xyz));
403 }
404
405 /// @brief Return @c true if the given bounding box is inside this bounding box.
406 bool isInside(const CoordBBox& b) const
407 {
408 return !(Coord::lessThan(b.mMin,mMin) || Coord::lessThan(mMax,b.mMax));
409 }
410
411 /// @brief Return @c true if the given bounding box overlaps with this bounding box.
412 bool hasOverlap(const CoordBBox& b) const
413 {
414 return !(Coord::lessThan(mMax,b.mMin) || Coord::lessThan(b.mMax,mMin));
415 }
416
417 /// @brief Pad this bounding box with the specified padding.
418 void expand(ValueType padding)
419 {
420 mMin.offset(-padding);
421 mMax.offset( padding);
422 }
423
424 /// @brief Return a new instance that is expanded by the specified padding.
426 {
427 return CoordBBox(mMin.offsetBy(-padding),mMax.offsetBy(padding));
428 }
429
430 /// @brief Expand this bounding box to enclose point (x, y, z).
431 void expand(const Coord& xyz)
432 {
433 mMin.minComponent(xyz);
434 mMax.maxComponent(xyz);
435 }
436
437 /// @brief Union this bounding box with the given bounding box.
438 void expand(const CoordBBox& bbox)
439 {
440 mMin.minComponent(bbox.min());
441 mMax.maxComponent(bbox.max());
442 }
443 /// @brief Intersect this bounding box with the given bounding box.
444 void intersect(const CoordBBox& bbox)
445 {
446 mMin.maxComponent(bbox.min());
447 mMax.minComponent(bbox.max());
448 }
449 /// @brief Union this bounding box with the cubical bounding box
450 /// of the given size and with the given minimum coordinates.
451 void expand(const Coord& min, Coord::ValueType dim)
452 {
453 mMin.minComponent(min);
454 mMax.maxComponent(min.offsetBy(dim-1));
455 }
456 /// @brief Translate this bounding box by
457 /// (<i>t<sub>x</sub></i>, <i>t<sub>y</sub></i>, <i>t<sub>z</sub></i>).
458 void translate(const Coord& t) { mMin += t; mMax += t; }
459
460 /// @brief Move this bounding box to the specified min
461 void moveMin(const Coord& min) { mMax += min - mMin; mMin = min; }
462
463 /// @brief Move this bounding box to the specified max
464 void moveMax(const Coord& max) { mMin += max - mMax; mMax = max; }
465
466 /// @brief Populates an array with the eight corner points of this bounding box.
467 /// @details The ordering of the corner points is lexicographic.
468 /// @warning It is assumed that the pointer can be incremented at
469 /// least seven times, i.e. has storage for eight Coord elements!
470 void getCornerPoints(Coord *p) const
471 {
472 assert(p != nullptr);
473 p->reset(mMin.x(), mMin.y(), mMin.z()); ++p;
474 p->reset(mMin.x(), mMin.y(), mMax.z()); ++p;
475 p->reset(mMin.x(), mMax.y(), mMin.z()); ++p;
476 p->reset(mMin.x(), mMax.y(), mMax.z()); ++p;
477 p->reset(mMax.x(), mMin.y(), mMin.z()); ++p;
478 p->reset(mMax.x(), mMin.y(), mMax.z()); ++p;
479 p->reset(mMax.x(), mMax.y(), mMin.z()); ++p;
480 p->reset(mMax.x(), mMax.y(), mMax.z());
481 }
482
483 //@{
484 /// @brief Bit-wise operations performed on both the min and max members
485 CoordBBox operator>> (size_t n) const { return CoordBBox(mMin>>n, mMax>>n); }
486 CoordBBox operator<< (size_t n) const { return CoordBBox(mMin<<n, mMax<<n); }
487 CoordBBox& operator<<=(size_t n) { mMin <<= n; mMax <<= n; return *this; }
488 CoordBBox& operator>>=(size_t n) { mMin >>= n; mMax >>= n; return *this; }
489 CoordBBox operator& (Coord::Int32 n) const { return CoordBBox(mMin & n, mMax & n); }
490 CoordBBox operator| (Coord::Int32 n) const { return CoordBBox(mMin | n, mMax | n); }
491 CoordBBox& operator&= (Coord::Int32 n) { mMin &= n; mMax &= n; return *this; }
492 CoordBBox& operator|= (Coord::Int32 n) { mMin |= n; mMax |= n; return *this; }
493 //@}
494
495 /// @brief Unserialize this bounding box from the given stream.
496 void read(std::istream& is) { mMin.read(is); mMax.read(is); }
497 /// @brief Serialize this bounding box to the given stream.
498 void write(std::ostream& os) const { mMin.write(os); mMax.write(os); }
499
500private:
501 Coord mMin, mMax;
502}; // class CoordBBox
503
504
505////////////////////////////////////////
506
507
508inline std::ostream& operator<<(std::ostream& os, const Coord& xyz)
509{
510 os << xyz.asVec3i(); return os;
511}
512
513
514inline Coord
515Abs(const Coord& xyz)
516{
517 return Coord(Abs(xyz[0]), Abs(xyz[1]), Abs(xyz[2]));
518}
519
520
521//@{
522/// Allow a Coord to be added to or subtracted from a Vec3.
523template<typename T>
525operator+(const Vec3<T>& v0, const Coord& v1)
526{
528 result[0] += v1[0];
529 result[1] += v1[1];
530 result[2] += v1[2];
531 return result;
532}
533
534template<typename T>
536operator+(const Coord& v1, const Vec3<T>& v0)
537{
539 result[0] += v1[0];
540 result[1] += v1[1];
541 result[2] += v1[2];
542 return result;
543}
544//@}
545
546
547//@{
548/// Allow a Coord to be subtracted from a Vec3.
549template <typename T>
551operator-(const Vec3<T>& v0, const Coord& v1)
552{
554 result[0] -= v1[0];
555 result[1] -= v1[1];
556 result[2] -= v1[2];
557 return result;
558}
559
560template <typename T>
562operator-(const Coord& v1, const Vec3<T>& v0)
563{
565 result[0] -= v1[0];
566 result[1] -= v1[1];
567 result[2] -= v1[2];
568 return -result;
569}
570//@}
571
572inline std::ostream&
573operator<<(std::ostream& os, const CoordBBox& b)
574{
575 os << b.min() << " -> " << b.max();
576 return os;
577}
578
579} // namespace math
580} // namespace OPENVDB_VERSION_NAME
581} // namespace openvdb
582
583////////////////////////////////////////
584
585// template specialization of std::hash with Coord, which
586// allows for Coord to be used as the key in std::unordered_map
587namespace std {// injected in namespace std
588
589template<>
590struct hash<openvdb::math::Coord>
591{
592 using Coord = openvdb::math::Coord;
594 using result_type = std::size_t;
595 std::size_t operator()(const Coord& ijk) const noexcept { return ijk.Coord::hash<>(); }
596};// std::hash<openvdb::math::Coord>
597
598}// namespace std
599
600#endif // OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
Iterator over the Coord domain covered by a CoordBBox.
Definition: Coord.h:259
bool operator!=(const Iterator &other) const
Return true if this iterator and the given iterator point to different coordinates.
Definition: Coord.h:277
const Coord & operator*() const
Return a const reference to the coordinate currently pointed to.
Definition: Coord.h:270
Iterator & operator++()
Increment the iterator to point to the next coordinate.
Definition: Coord.h:266
bool operator==(const Iterator &other) const
Return true if this iterator and the given iterator point to the same coordinate.
Definition: Coord.h:272
Iterator(const CoordBBox &b)
C-tor from a bounding box.
Definition: Coord.h:262
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:249
bool operator!=(const CoordBBox &rhs) const
Definition: Coord.h:353
CoordBBox()
The default constructor produces an empty bounding box.
Definition: Coord.h:294
bool isInside(const CoordBBox &b) const
Return true if the given bounding box is inside this bounding box.
Definition: Coord.h:406
ZYXIterator beginZYX() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:341
size_t minExtent() const
Return the index (0, 1 or 2) of the shortest axis.
Definition: Coord.h:394
void moveMax(const Coord &max)
Move this bounding box to the specified max.
Definition: Coord.h:464
bool is_divisible() const
Return true if this bounding box can be subdivided [mainly for use by TBB].
Definition: Coord.h:391
Coord::ValueType ValueType
Definition: Coord.h:252
Coord extents() const
Definition: Coord.h:382
void write(std::ostream &os) const
Serialize this bounding box to the given stream.
Definition: Coord.h:498
void translate(const Coord &t)
Translate this bounding box by (tx, ty, tz).
Definition: Coord.h:458
bool hasVolume() const
Return true if this bounding box is nonempty (i.e., encloses at least one coordinate).
Definition: Coord.h:372
Vec3d getCenter() const
Return the floating-point position of the center of this bounding box.
Definition: Coord.h:375
ZYXIterator end() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:346
XYZIterator beginXYZ() const
Return an XYZ-order iterator that points to the minimum coordinate.
Definition: Coord.h:343
void expand(ValueType padding)
Pad this bounding box with the specified padding.
Definition: Coord.h:418
void expand(const Coord &xyz)
Expand this bounding box to enclose point (x, y, z).
Definition: Coord.h:431
CoordBBox(CoordBBox &other, const tbb::split &)
Splitting constructor for use in TBB ranges.
Definition: Coord.h:305
CoordBBox & operator>>=(size_t n)
Definition: Coord.h:488
ZYXIterator endZYX() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:348
bool empty() const
Return true if this bounding box is empty (i.e., encloses no coordinates).
Definition: Coord.h:356
Coord & max()
Definition: Coord.h:325
void moveMin(const Coord &min)
Move this bounding box to the specified min.
Definition: Coord.h:461
const Coord & min() const
Definition: Coord.h:321
bool hasOverlap(const CoordBBox &b) const
Return true if the given bounding box overlaps with this bounding box.
Definition: Coord.h:412
const Coord & max() const
Definition: Coord.h:322
size_t maxExtent() const
Return the index (0, 1 or 2) of the longest axis.
Definition: Coord.h:397
XYZIterator endXYZ() const
Return an XYZ-order iterator that points past the maximum coordinate.
Definition: Coord.h:350
CoordBBox & operator<<=(size_t n)
Definition: Coord.h:487
void resetToCube(const Coord &min, ValueType dim)
Definition: Coord.h:329
bool operator==(const CoordBBox &rhs) const
Definition: Coord.h:352
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:451
CoordBBox expandBy(ValueType padding) const
Return a new instance that is expanded by the specified padding.
Definition: Coord.h:425
Index64 volume() const
Return the integer volume of coordinates spanned by this bounding box.
Definition: Coord.h:385
static CoordBBox inf()
Return an "infinite" bounding box, as defined by the Coord value range.
Definition: Coord.h:319
CoordBBox(const Coord &min, const Coord &max)
Construct a bounding box with the given min and max bounds.
Definition: Coord.h:296
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:298
Coord & min()
Definition: Coord.h:324
void expand(const CoordBBox &bbox)
Union this bounding box with the given bounding box.
Definition: Coord.h:438
bool isInside(const Coord &xyz) const
Return true if point (x, y, z) is inside this bounding box.
Definition: Coord.h:400
Coord dim() const
Return the dimensions of the coordinates spanned by this bounding box.
Definition: Coord.h:380
Coord getStart() const
Return the minimum coordinate.
Definition: Coord.h:333
Coord getEnd() const
Return the maximum coordinate plus one.
Definition: Coord.h:336
uint64_t Index64
Definition: Coord.h:251
void intersect(const CoordBBox &bbox)
Intersect this bounding box with the given bounding box.
Definition: Coord.h:444
void reset()
Definition: Coord.h:327
void getCornerPoints(Coord *p) const
Populates an array with the eight corner points of this bounding box.
Definition: Coord.h:470
static CoordBBox createCube(const Coord &min, ValueType dim)
Definition: Coord.h:313
ZYXIterator begin() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:339
void reset(const Coord &min, const Coord &max)
Definition: Coord.h:328
void read(std::istream &is)
Unserialize this bounding box from the given stream.
Definition: Coord.h:496
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:25
Int32 ValueType
Definition: Coord.h:32
Coord operator-(const Coord &rhs) const
Definition: Coord.h:115
Coord & offset(Int32 dx, Int32 dy, Int32 dz)
Definition: Coord.h:83
Int32 & z()
Definition: Coord.h:136
Vec3d asVec3d() const
Definition: Coord.h:143
Coord operator-() const
Definition: Coord.h:119
Int32 y() const
Definition: Coord.h:131
size_t hash() const
Return a hash value for this coordinate.
Definition: Coord.h:230
Vec3s asVec3s() const
Definition: Coord.h:144
static Coord round(const Vec3< T > &xyz)
Return xyz rounded to the closest integer coordinates (cell centered conversion).
Definition: Coord.h:50
Int32 operator[](size_t i) const
Definition: Coord.h:133
Vec3I asVec3I() const
Definition: Coord.h:146
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:63
Coord & operator-=(const Coord &rhs)
Definition: Coord.h:104
std::numeric_limits< ValueType > Limits
Definition: Coord.h:33
Int32 * asPointer()
Definition: Coord.h:142
Coord(const Vec3I &v)
Definition: Coord.h:39
void asXYZ(Int32 &x, Int32 &y, Int32 &z) const
Definition: Coord.h:147
Coord operator+(const Coord &rhs) const
Definition: Coord.h:111
Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
Definition: Coord.h:91
void write(std::ostream &os) const
Definition: Coord.h:220
size_t maxIndex() const
Return the index (0, 1 or 2) with the largest value.
Definition: Coord.h:217
Coord offsetBy(Int32 n) const
Definition: Coord.h:95
bool operator<(const Coord &rhs) const
Lexicographic less than.
Definition: Coord.h:156
void minComponent(const Coord &other)
Perform a component-wise minimum with the other Coord.
Definition: Coord.h:175
Int32 * data()
Definition: Coord.h:140
Coord & operator+=(const Coord &rhs)
Definition: Coord.h:97
bool operator>=(const Coord &rhs) const
Lexicographic greater than or equal to.
Definition: Coord.h:172
Int32 & x()
Definition: Coord.h:134
Coord & operator<<=(size_t n)
Definition: Coord.h:123
Coord()
Definition: Coord.h:35
static Coord maxComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise maximum of the two Coords.
Definition: Coord.h:199
void maxComponent(const Coord &other)
Perform a component-wise maximum with the other Coord.
Definition: Coord.h:183
Coord & reset(Int32 x, Int32 y, Int32 z)
Reset all three coordinates with the specified arguments.
Definition: Coord.h:69
Coord(const Int32 *v)
Definition: Coord.h:40
uint32_t Index32
Definition: Coord.h:28
const Int32 * asPointer() const
Definition: Coord.h:141
Int32 x() const
Definition: Coord.h:130
Vec3i asVec3i() const
Definition: Coord.h:145
size_t minIndex() const
Return the index (0, 1 or 2) with the smallest value.
Definition: Coord.h:214
bool operator!=(const Coord &rhs) const
Definition: Coord.h:153
static Coord min()
Return the smallest possible coordinate.
Definition: Coord.h:43
Coord & reset(Int32 xyz)
Reset all three coordinates with the same specified argument.
Definition: Coord.h:77
Coord(Int32 xyz)
Definition: Coord.h:36
Coord & setZ(Int32 z)
Definition: Coord.h:81
int32_t Int32
Definition: Coord.h:27
Coord & setY(Int32 y)
Definition: Coord.h:80
bool operator==(const Coord &rhs) const
Definition: Coord.h:149
static Coord floor(const Vec3< T > &xyz)
Return the largest integer coordinates that are not greater than xyz (node centered conversion).
Definition: Coord.h:56
bool operator<=(const Coord &rhs) const
Lexicographic less than or equal to.
Definition: Coord.h:163
static Coord max()
Return the largest possible coordinate.
Definition: Coord.h:46
Int32 & operator[](size_t i)
Definition: Coord.h:137
Coord(Int32 x, Int32 y, Int32 z)
Definition: Coord.h:37
Coord(const Vec3i &v)
Definition: Coord.h:38
static bool lessThan(const Coord &a, const Coord &b)
Definition: Coord.h:208
Int32 z() const
Definition: Coord.h:132
Coord & setX(Int32 x)
Definition: Coord.h:79
Coord & offset(Int32 n)
Definition: Coord.h:90
const Int32 * data() const
Definition: Coord.h:139
bool operator>(const Coord &rhs) const
Lexicographic greater than.
Definition: Coord.h:170
static Coord minComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise minimum of the two Coords.
Definition: Coord.h:191
Coord & operator>>=(size_t n)
Definition: Coord.h:124
Int32 & y()
Definition: Coord.h:135
void read(std::istream &is)
Definition: Coord.h:219
Definition: Vec3.h:24
__hostdev__ uint32_t hash(uint32_t x)
Definition: common.h:13
size_t MaxIndex(const Vec3T &v)
Return the index [0,1,2] of the largest value in a 3D vector.
Definition: Math.h:947
int Ceil(float x)
Return the ceiling of x.
Definition: Math.h:856
Vec3< typename promote< T, Coord::ValueType >::type > operator-(const Vec3< T > &v0, const Coord &v1)
Allow a Coord to be subtracted from a Vec3.
Definition: Coord.h:551
size_t MinIndex(const Vec3T &v)
Return the index [0,1,2] of the smallest value in a 3D vector.
Definition: Math.h:931
Vec3< typename promote< T, typename Coord::ValueType >::type > operator+(const Vec3< T > &v0, const Coord &v1)
Allow a Coord to be added to or subtracted from a Vec3.
Definition: Coord.h:525
Coord Abs(const Coord &xyz)
Definition: Coord.h:515
float Round(float x)
Return x rounded to the nearest integer.
Definition: Math.h:819
int Floor(float x)
Return the floor of x.
Definition: Math.h:848
std::ostream & operator<<(std::ostream &ostr, const Metadata &metadata)
Write a Metadata to an output stream.
Definition: Metadata.h:351
Definition: Exceptions.h:13
Definition: Coord.h:587
std::size_t result_type
Definition: Coord.h:594
std::size_t operator()(const Coord &ijk) const noexcept
Definition: Coord.h:595
openvdb::math::Coord Coord
Definition: Coord.h:592
Coord argument_type
Definition: Coord.h:593
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:121
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:212