OpenVDB  4.0.2
Coord.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2017 DreamWorks Animation LLC
4 //
5 // All rights reserved. This software is distributed under the
6 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
7 //
8 // Redistributions of source code must retain the above copyright
9 // and license notice and the following restrictions and disclaimer.
10 //
11 // * Neither the name of DreamWorks Animation nor the names of
12 // its contributors may be used to endorse or promote products derived
13 // from this software without specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
20 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 // IN NO EVENT SHALL THE COPYRIGHT HOLDERS' AND CONTRIBUTORS' AGGREGATE
27 // LIABILITY FOR ALL CLAIMS REGARDLESS OF THEIR BASIS EXCEED US$250.00.
28 //
30 
31 #ifndef OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
32 #define OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
33 
34 #include <array> // for std::array
35 #include <openvdb/Platform.h>
36 #include "Math.h"
37 #include "Vec3.h"
38 
39 namespace tbb { class split; } // forward declaration
40 
41 
42 namespace openvdb {
44 namespace OPENVDB_VERSION_NAME {
45 namespace math {
46 
48 class Coord
49 {
50 public:
51  using Int32 = int32_t;
52  using Index32 = uint32_t;
53  using Vec3i = Vec3<Int32>;
55 
56  using ValueType = Int32;
57  using Limits = std::numeric_limits<ValueType>;
58 
59  Coord(): mVec{{0, 0, 0}} {}
60  explicit Coord(Int32 xyz): mVec{{xyz, xyz, xyz}} {}
61  Coord(Int32 x, Int32 y, Int32 z): mVec{{x, y, z}} {}
62  explicit Coord(const Vec3i& v): mVec{{v[0], v[1], v[2]}} {}
63  explicit Coord(const Vec3I& v): mVec{{Int32(v[0]), Int32(v[1]), Int32(v[2])}} {}
64  explicit Coord(const Int32* v): mVec{{v[0], v[1], v[2]}} {}
65 
67  static Coord min() { return Coord(Limits::min()); }
68 
70  static Coord max() { return Coord(Limits::max()); }
71 
74  template<typename T> static Coord round(const Vec3<T>& xyz)
75  {
76  return Coord(Int32(Round(xyz[0])), Int32(Round(xyz[1])), Int32(Round(xyz[2])));
77  }
80  template<typename T> static Coord floor(const Vec3<T>& xyz)
81  {
82  return Coord(Int32(Floor(xyz[0])), Int32(Floor(xyz[1])), Int32(Floor(xyz[2])));
83  }
84 
87  template<typename T> static Coord ceil(const Vec3<T>& xyz)
88  {
89  return Coord(Int32(Ceil(xyz[0])), Int32(Ceil(xyz[1])), Int32(Ceil(xyz[2])));
90  }
91 
94  {
95  mVec[0] = x;
96  mVec[1] = y;
97  mVec[2] = z;
98  return *this;
99  }
101  Coord& reset(Int32 xyz) { return this->reset(xyz, xyz, xyz); }
102 
103  Coord& setX(Int32 x) { mVec[0] = x; return *this; }
104  Coord& setY(Int32 y) { mVec[1] = y; return *this; }
105  Coord& setZ(Int32 z) { mVec[2] = z; return *this; }
106 
107  Coord& offset(Int32 dx, Int32 dy, Int32 dz)
108  {
109  mVec[0] += dx;
110  mVec[1] += dy;
111  mVec[2] += dz;
112  return *this;
113  }
114  Coord& offset(Int32 n) { return this->offset(n, n, n); }
115  Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
116  {
117  return Coord(mVec[0] + dx, mVec[1] + dy, mVec[2] + dz);
118  }
119  Coord offsetBy(Int32 n) const { return offsetBy(n, n, n); }
120 
121  Coord& operator+=(const Coord& rhs)
122  {
123  mVec[0] += rhs[0];
124  mVec[1] += rhs[1];
125  mVec[2] += rhs[2];
126  return *this;
127  }
128  Coord& operator-=(const Coord& rhs)
129  {
130  mVec[0] -= rhs[0];
131  mVec[1] -= rhs[1];
132  mVec[2] -= rhs[2];
133  return *this;
134  }
135  Coord operator+(const Coord& rhs) const
136  {
137  return Coord(mVec[0] + rhs[0], mVec[1] + rhs[1], mVec[2] + rhs[2]);
138  }
139  Coord operator-(const Coord& rhs) const
140  {
141  return Coord(mVec[0] - rhs[0], mVec[1] - rhs[1], mVec[2] - rhs[2]);
142  }
143  Coord operator-() const { return Coord(-mVec[0], -mVec[1], -mVec[2]); }
144 
145  Coord operator>> (size_t n) const { return Coord(mVec[0]>>n, mVec[1]>>n, mVec[2]>>n); }
146  Coord operator<< (size_t n) const { return Coord(mVec[0]<<n, mVec[1]<<n, mVec[2]<<n); }
147  Coord& operator<<=(size_t n) { mVec[0]<<=n; mVec[1]<<=n; mVec[2]<<=n; return *this; }
148  Coord& operator>>=(size_t n) { mVec[0]>>=n; mVec[1]>>=n; mVec[2]>>=n; return *this; }
149  Coord operator& (Int32 n) const { return Coord(mVec[0] & n, mVec[1] & n, mVec[2] & n); }
150  Coord operator| (Int32 n) const { return Coord(mVec[0] | n, mVec[1] | n, mVec[2] | n); }
151  Coord& operator&= (Int32 n) { mVec[0]&=n; mVec[1]&=n; mVec[2]&=n; return *this; }
152  Coord& operator|= (Int32 n) { mVec[0]|=n; mVec[1]|=n; mVec[2]|=n; return *this; }
153 
154  Int32 x() const { return mVec[0]; }
155  Int32 y() const { return mVec[1]; }
156  Int32 z() const { return mVec[2]; }
157  Int32 operator[](size_t i) const { assert(i < 3); return mVec[i]; }
158  Int32& x() { return mVec[0]; }
159  Int32& y() { return mVec[1]; }
160  Int32& z() { return mVec[2]; }
161  Int32& operator[](size_t i) { assert(i < 3); return mVec[i]; }
162 
163  const Int32* data() const { return mVec.data(); }
164  Int32* data() { return mVec.data(); }
165  const Int32* asPointer() const { return mVec.data(); }
166  Int32* asPointer() { return mVec.data(); }
167  Vec3d asVec3d() const { return Vec3d(double(mVec[0]), double(mVec[1]), double(mVec[2])); }
168  Vec3s asVec3s() const { return Vec3s(float(mVec[0]), float(mVec[1]), float(mVec[2])); }
169  Vec3i asVec3i() const { return Vec3i(mVec.data()); }
170  Vec3I asVec3I() const { return Vec3I(Index32(mVec[0]), Index32(mVec[1]), Index32(mVec[2])); }
171  void asXYZ(Int32& x, Int32& y, Int32& z) const { x = mVec[0]; y = mVec[1]; z = mVec[2]; }
172 
173  bool operator==(const Coord& rhs) const
174  {
175  return (mVec[0] == rhs.mVec[0] && mVec[1] == rhs.mVec[1] && mVec[2] == rhs.mVec[2]);
176  }
177  bool operator!=(const Coord& rhs) const { return !(*this == rhs); }
178 
180  bool operator<(const Coord& rhs) const
181  {
182  return this->x() < rhs.x() ? true : this->x() > rhs.x() ? false
183  : this->y() < rhs.y() ? true : this->y() > rhs.y() ? false
184  : this->z() < rhs.z() ? true : false;
185  }
187  bool operator<=(const Coord& rhs) const
188  {
189  return this->x() < rhs.x() ? true : this->x() > rhs.x() ? false
190  : this->y() < rhs.y() ? true : this->y() > rhs.y() ? false
191  : this->z() <=rhs.z() ? true : false;
192  }
194  bool operator>(const Coord& rhs) const { return !(*this <= rhs); }
196  bool operator>=(const Coord& rhs) const { return !(*this < rhs); }
197 
199  void minComponent(const Coord& other)
200  {
201  mVec[0] = std::min(mVec[0], other.mVec[0]);
202  mVec[1] = std::min(mVec[1], other.mVec[1]);
203  mVec[2] = std::min(mVec[2], other.mVec[2]);
204  }
205 
207  void maxComponent(const Coord& other)
208  {
209  mVec[0] = std::max(mVec[0], other.mVec[0]);
210  mVec[1] = std::max(mVec[1], other.mVec[1]);
211  mVec[2] = std::max(mVec[2], other.mVec[2]);
212  }
213 
215  static inline Coord minComponent(const Coord& lhs, const Coord& rhs)
216  {
217  return Coord(std::min(lhs.x(), rhs.x()),
218  std::min(lhs.y(), rhs.y()),
219  std::min(lhs.z(), rhs.z()));
220  }
221 
223  static inline Coord maxComponent(const Coord& lhs, const Coord& rhs)
224  {
225  return Coord(std::max(lhs.x(), rhs.x()),
226  std::max(lhs.y(), rhs.y()),
227  std::max(lhs.z(), rhs.z()));
228  }
229 
232  static inline bool lessThan(const Coord& a, const Coord& b)
233  {
234  return (a[0] < b[0] || a[1] < b[1] || a[2] < b[2]);
235  }
236 
238  size_t minIndex() const { return MinIndex(mVec); }
239 
241  size_t maxIndex() const { return MaxIndex(mVec); }
242 
243  void read(std::istream& is) { is.read(reinterpret_cast<char*>(mVec.data()), sizeof(mVec)); }
244  void write(std::ostream& os) const
245  {
246  os.write(reinterpret_cast<const char*>(mVec.data()), sizeof(mVec));
247  }
248 
249 private:
250  std::array<Int32, 3> mVec;
251 }; // class Coord
252 
253 
255 
256 
262 {
263 public:
264  using Index64 = uint64_t;
266 
270  template<bool ZYXOrder>
271  class Iterator
272  {
273  public:
275  Iterator(const CoordBBox& b): mPos(b.min()), mMin(b.min()), mMax(b.max()) {}
279  Iterator& operator++() { ZYXOrder ? next<2,1,0>() : next<0,1,2>(); return *this; }
281  operator bool() const { return ZYXOrder ? (mPos[0] <= mMax[0]) : (mPos[2] <= mMax[2]); }
283  const Coord& operator*() const { return mPos; }
285  bool operator==(const Iterator& other) const
286  {
287  return ((mPos == other.mPos) && (mMin == other.mMin) && (mMax == other.mMax));
288  }
290  bool operator!=(const Iterator& other) const { return !(*this == other); }
291  private:
292  template<size_t a, size_t b, size_t c>
293  void next()
294  {
295  if (mPos[a] < mMax[a]) { ++mPos[a]; } // this is the most common case
296  else if (mPos[b] < mMax[b]) { mPos[a] = mMin[a]; ++mPos[b]; }
297  else if (mPos[c] <= mMax[c]) { mPos[a] = mMin[a]; mPos[b] = mMin[b]; ++mPos[c]; }
298  }
299  Coord mPos, mMin, mMax;
300  friend class CoordBBox; // for CoordBBox::end()
301  };// CoordBBox::Iterator
302 
303  using ZYXIterator = Iterator</*ZYX=*/true>;
304  using XYZIterator = Iterator</*ZYX=*/false>;
305 
307  CoordBBox(): mMin(Coord::max()), mMax(Coord::min()) {}
309  CoordBBox(const Coord& min, const Coord& max): mMin(min), mMax(max) {}
312  ValueType xMax, ValueType yMax, ValueType zMax)
313  : mMin(xMin, yMin, zMin), mMax(xMax, yMax, zMax)
314  {
315  }
318  CoordBBox(CoordBBox& other, const tbb::split&): mMin(other.mMin), mMax(other.mMax)
319  {
320  assert(this->is_divisible());
321  const size_t n = this->maxExtent();
322  mMax[n] = (mMin[n] + mMax[n]) >> 1;
323  other.mMin[n] = mMax[n] + 1;
324  }
325 
326  static CoordBBox createCube(const Coord& min, ValueType dim)
327  {
328  return CoordBBox(min, min.offsetBy(dim - 1));
329  }
330 
332  static CoordBBox inf() { return CoordBBox(Coord::min(), Coord::max()); }
333 
334  const Coord& min() const { return mMin; }
335  const Coord& max() const { return mMax; }
336 
337  Coord& min() { return mMin; }
338  Coord& max() { return mMax; }
339 
340  void reset() { mMin = Coord::max(); mMax = Coord::min(); }
341  void reset(const Coord& min, const Coord& max) { mMin = min; mMax = max; }
342  void resetToCube(const Coord& min, ValueType dim) { mMin = min; mMax = min.offsetBy(dim - 1); }
343 
346  Coord getStart() const { return mMin; }
349  Coord getEnd() const { return mMax.offsetBy(1); }
350 
352  ZYXIterator begin() const { return ZYXIterator{*this}; }
354  ZYXIterator beginZYX() const { return ZYXIterator{*this}; }
356  XYZIterator beginXYZ() const { return XYZIterator{*this}; }
357 
359  ZYXIterator end() const { ZYXIterator it{*this}; it.mPos[0] = mMax[0] + 1; return it; }
361  ZYXIterator endZYX() const { return end(); }
363  XYZIterator endXYZ() const { XYZIterator it{*this}; it.mPos[2] = mMax[2] + 1; return it; }
364 
365  bool operator==(const CoordBBox& rhs) const { return mMin == rhs.mMin && mMax == rhs.mMax; }
366  bool operator!=(const CoordBBox& rhs) const { return !(*this == rhs); }
367 
369  bool empty() const { return (mMin[0] > mMax[0] || mMin[1] > mMax[1] || mMin[2] > mMax[2]); }
371  operator bool() const { return !this->empty(); }
373  bool hasVolume() const { return !this->empty(); }
374 
376  Vec3d getCenter() const { return 0.5 * Vec3d((mMin + mMax).asPointer()); }
377 
381  Coord dim() const { return mMax.offsetBy(1) - mMin; }
383  Coord extents() const { return this->dim(); }
386  Index64 volume() const
387  {
388  const Coord d = this->dim();
389  return Index64(d[0]) * Index64(d[1]) * Index64(d[2]);
390  }
392  bool is_divisible() const { return mMin[0]<mMax[0] && mMin[1]<mMax[1] && mMin[2]<mMax[2]; }
393 
395  size_t minExtent() const { return this->dim().minIndex(); }
396 
398  size_t maxExtent() const { return this->dim().maxIndex(); }
399 
401  bool isInside(const Coord& xyz) const
402  {
403  return !(Coord::lessThan(xyz,mMin) || Coord::lessThan(mMax,xyz));
404  }
405 
407  bool isInside(const CoordBBox& b) const
408  {
409  return !(Coord::lessThan(b.mMin,mMin) || Coord::lessThan(mMax,b.mMax));
410  }
411 
413  bool hasOverlap(const CoordBBox& b) const
414  {
415  return !(Coord::lessThan(mMax,b.mMin) || Coord::lessThan(b.mMax,mMin));
416  }
417 
419  void expand(ValueType padding)
420  {
421  mMin.offset(-padding);
422  mMax.offset( padding);
423  }
424 
426  CoordBBox expandBy(ValueType padding) const
427  {
428  return CoordBBox(mMin.offsetBy(-padding),mMax.offsetBy(padding));
429  }
430 
432  void expand(const Coord& xyz)
433  {
434  mMin.minComponent(xyz);
435  mMax.maxComponent(xyz);
436  }
437 
439  void expand(const CoordBBox& bbox)
440  {
441  mMin.minComponent(bbox.min());
442  mMax.maxComponent(bbox.max());
443  }
445  void intersect(const CoordBBox& bbox)
446  {
447  mMin.maxComponent(bbox.min());
448  mMax.minComponent(bbox.max());
449  }
452  void expand(const Coord& min, Coord::ValueType dim)
453  {
454  mMin.minComponent(min);
455  mMax.maxComponent(min.offsetBy(dim-1));
456  }
458  void translate(const Coord& t) { mMin += t; mMax += t; }
459 
464  void getCornerPoints(Coord *p) const
465  {
466  assert(p != nullptr);
467  p->reset(mMin.x(), mMin.y(), mMin.z()); ++p;
468  p->reset(mMin.x(), mMin.y(), mMax.z()); ++p;
469  p->reset(mMin.x(), mMax.y(), mMin.z()); ++p;
470  p->reset(mMin.x(), mMax.y(), mMax.z()); ++p;
471  p->reset(mMax.x(), mMin.y(), mMin.z()); ++p;
472  p->reset(mMax.x(), mMin.y(), mMax.z()); ++p;
473  p->reset(mMax.x(), mMax.y(), mMin.z()); ++p;
474  p->reset(mMax.x(), mMax.y(), mMax.z());
475  }
476 
478  CoordBBox operator>> (size_t n) const { return CoordBBox(mMin>>n, mMax>>n); }
480  CoordBBox operator<< (size_t n) const { return CoordBBox(mMin<<n, mMax<<n); }
481  CoordBBox& operator<<=(size_t n) { mMin <<= n; mMax <<= n; return *this; }
482  CoordBBox& operator>>=(size_t n) { mMin >>= n; mMax >>= n; return *this; }
483  CoordBBox operator& (Coord::Int32 n) const { return CoordBBox(mMin & n, mMax & n); }
484  CoordBBox operator| (Coord::Int32 n) const { return CoordBBox(mMin | n, mMax | n); }
485  CoordBBox& operator&= (Coord::Int32 n) { mMin &= n; mMax &= n; return *this; }
486  CoordBBox& operator|= (Coord::Int32 n) { mMin |= n; mMax |= n; return *this; }
488 
490  void read(std::istream& is) { mMin.read(is); mMax.read(is); }
492  void write(std::ostream& os) const { mMin.write(os); mMax.write(os); }
493 
494 private:
495  Coord mMin, mMax;
496 }; // class CoordBBox
497 
498 
500 
501 
502 inline std::ostream& operator<<(std::ostream& os, const Coord& xyz)
503 {
504  os << xyz.asVec3i(); return os;
505 }
506 
507 
508 inline Coord
509 Abs(const Coord& xyz)
510 {
511  return Coord(Abs(xyz[0]), Abs(xyz[1]), Abs(xyz[2]));
512 }
513 
514 
516 template<typename T>
519 operator+(const Vec3<T>& v0, const Coord& v1)
520 {
522  result[0] += v1[0];
523  result[1] += v1[1];
524  result[2] += v1[2];
525  return result;
526 }
527 
528 template<typename T>
530 operator+(const Coord& v1, const Vec3<T>& v0)
531 {
533  result[0] += v1[0];
534  result[1] += v1[1];
535  result[2] += v1[2];
536  return result;
537 }
539 
540 
542 template <typename T>
545 operator-(const Vec3<T>& v0, const Coord& v1)
546 {
548  result[0] -= v1[0];
549  result[1] -= v1[1];
550  result[2] -= v1[2];
551  return result;
552 }
553 
554 template <typename T>
556 operator-(const Coord& v1, const Vec3<T>& v0)
557 {
559  result[0] -= v1[0];
560  result[1] -= v1[1];
561  result[2] -= v1[2];
562  return -result;
563 }
565 
566 inline std::ostream&
567 operator<<(std::ostream& os, const CoordBBox& b)
568 {
569  os << b.min() << " -> " << b.max();
570  return os;
571 }
572 
573 } // namespace math
574 } // namespace OPENVDB_VERSION_NAME
575 } // namespace openvdb
576 
577 #endif // OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
578 
579 // Copyright (c) 2012-2017 DreamWorks Animation LLC
580 // All rights reserved. This software is distributed under the
581 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
Int32 operator[](size_t i) const
Definition: Coord.h:157
Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
Definition: Coord.h:115
math::Vec3< Index32 > Vec3I
Definition: Types.h:76
bool operator!=(const Coord &rhs) const
Definition: Coord.h:177
static Coord floor(const Vec3< T > &xyz)
Return the largest integer coordinates that are not greater than xyz (node centered conversion)...
Definition: Coord.h:80
void read(std::istream &is)
Unserialize this bounding box from the given stream.
Definition: Coord.h:490
Coord operator+(const Coord &rhs) const
Definition: Coord.h:135
Coord & min()
Definition: Coord.h:337
bool operator>(const Coord &rhs) const
Lexicographic greater than.
Definition: Coord.h:194
Int32 z() const
Definition: Coord.h:156
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
Iterator & operator++()
Increment the iterator to point to the next coordinate.
Definition: Coord.h:279
std::numeric_limits< ValueType > Limits
Definition: Coord.h:57
Coord & setZ(Int32 z)
Definition: Coord.h:105
XYZIterator beginXYZ() const
Return an XYZ-order iterator that points to the minimum coordinate.
Definition: Coord.h:356
Coord()
Definition: Coord.h:59
Coord(Int32 xyz)
Definition: Coord.h:60
bool hasVolume() const
Return true if this bounding box is nonempty (i.e., encloses at least one coordinate).
Definition: Coord.h:373
void write(std::ostream &os) const
Definition: Coord.h:244
bool operator==(const CoordBBox &rhs) const
Definition: Coord.h:365
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:311
bool is_divisible() const
Return true if this bounding box can be subdivided [mainly for use by TBB].
Definition: Coord.h:392
Vec3< typename promote< T, typename Coord::ValueType >::type > operator+(const Coord &v1, const Vec3< T > &v0)
Allow a Coord to be added to or subtracted from a Vec3.
Definition: Coord.h:530
size_t MinIndex(const Vec3T &v)
Return the index [0,1,2] of the smallest value in a 3D vector.
Definition: Math.h:886
void read(std::istream &is)
Definition: Coord.h:243
static Coord min()
Return the smallest possible coordinate.
Definition: Coord.h:67
Index64 volume() const
Return the integer volume of coordinates spanned by this bounding box.
Definition: Coord.h:386
Coord & operator-=(const Coord &rhs)
Definition: Coord.h:128
Int32 y() const
Definition: Coord.h:155
Coord & max()
Definition: Coord.h:338
uint32_t Index32
Definition: Types.h:55
ZYXIterator beginZYX() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:354
Coord & operator>>=(size_t n)
Definition: Coord.h:148
ZYXIterator end() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:359
CoordBBox(CoordBBox &other, const tbb::split &)
Splitting constructor for use in TBB ranges.
Definition: Coord.h:318
tbb::atomic< Index32 > i
Definition: LeafBuffer.h:71
int Ceil(float x)
Return the ceiling of x.
Definition: Math.h:806
Vec3i asVec3i() const
Definition: Coord.h:169
const Int32 * data() const
Definition: Coord.h:163
XYZIterator endXYZ() const
Return an XYZ-order iterator that points past the maximum coordinate.
Definition: Coord.h:363
void resetToCube(const Coord &min, ValueType dim)
Definition: Coord.h:342
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:261
static Coord maxComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise maximum of the two Coords.
Definition: Coord.h:223
Coord(const Int32 *v)
Definition: Coord.h:64
Coord offsetBy(Int32 n) const
Definition: Coord.h:119
void expand(ValueType padding)
Pad this bounding box with the specified padding.
Definition: Coord.h:419
Iterator over the Coord domain covered by a CoordBBox.
Definition: Coord.h:271
Vec3< int32_t > Vec3i
Definition: Vec3.h:675
Definition: Mat.h:195
CoordBBox expandBy(ValueType padding) const
Return a new instance that is expanded by the specified padding.
Definition: Coord.h:426
Vec3< float > Vec3s
Definition: Vec3.h:677
Coord(const Vec3I &v)
Definition: Coord.h:63
CoordBBox & operator>>=(size_t n)
Bit-wise operations performed on both the min and max members.
Definition: Coord.h:482
Coord & operator<<=(size_t n)
Definition: Coord.h:147
Coord getEnd() const
Return the maximum coordinate plus one.
Definition: Coord.h:349
Vec3d getCenter() const
Return the floating-point position of the center of this bounding box.
Definition: Coord.h:376
bool isInside(const CoordBBox &b) const
Return true if the given bounding box is inside this bounding box.
Definition: Coord.h:407
const std::enable_if<!VecTraits< T >::IsVec, T >::type & max(const T &a, const T &b)
Definition: Composite.h:133
const std::enable_if<!VecTraits< T >::IsVec, T >::type & min(const T &a, const T &b)
Definition: Composite.h:129
Int32 * data()
Definition: Coord.h:164
uint64_t Index64
Definition: Types.h:56
Int32 & operator[](size_t i)
Definition: Coord.h:161
void expand(const Coord &xyz)
Expand this bounding box to enclose point (x, y, z).
Definition: Coord.h:432
bool operator<=(const Coord &rhs) const
Lexicographic less than or equal to.
Definition: Coord.h:187
const Int32 * asPointer() const
Definition: Coord.h:165
Int32 & x()
Definition: Coord.h:158
#define OPENVDB_VERSION_NAME
Definition: version.h:43
Coord extents() const
Definition: Coord.h:383
void translate(const Coord &t)
Translate this bounding box by .
Definition: Coord.h:458
Coord getStart() const
Return the minimum coordinate.
Definition: Coord.h:346
CoordBBox()
The default constructor produces an empty bounding box.
Definition: Coord.h:307
bool operator==(const Iterator &other) const
Return true if this iterator and the given iterator point to the same coordinate. ...
Definition: Coord.h:285
size_t minIndex() const
Return the index (0, 1 or 2) with the smallest value.
Definition: Coord.h:238
Coord Abs(const Coord &xyz)
Definition: Coord.h:509
Coord & operator+=(const Coord &rhs)
Definition: Coord.h:121
static CoordBBox inf()
Return an "infinite" bounding box, as defined by the Coord value range.
Definition: Coord.h:332
static Coord max()
Return the largest possible coordinate.
Definition: Coord.h:70
Coord & reset(Int32 xyz)
Reset all three coordinates with the same specified argument.
Definition: Coord.h:101
void asXYZ(Int32 &x, Int32 &y, Int32 &z) const
Definition: Coord.h:171
bool isInside(const Coord &xyz) const
Return true if point (x, y, z) is inside this bounding box.
Definition: Coord.h:401
Definition: Exceptions.h:39
Coord & setX(Int32 x)
Definition: Coord.h:103
void minComponent(const Coord &other)
Perform a component-wise minimum with the other Coord.
Definition: Coord.h:199
Coord & offset(Int32 dx, Int32 dy, Int32 dz)
Definition: Coord.h:107
Int32 & z()
Definition: Coord.h:160
const Coord & max() const
Definition: Coord.h:335
void intersect(const CoordBBox &bbox)
Intersect this bounding box with the given bounding box.
Definition: Coord.h:445
Vec3< double > Vec3d
Definition: Vec3.h:678
Int32 & y()
Definition: Coord.h:159
bool operator!=(const Iterator &other) const
Return true if this iterator and the given iterator point to different coordinates.
Definition: Coord.h:290
size_t maxIndex() const
Return the index (0, 1 or 2) with the largest value.
Definition: Coord.h:241
bool operator>=(const Coord &rhs) const
Lexicographic greater than or equal to.
Definition: Coord.h:196
static CoordBBox createCube(const Coord &min, ValueType dim)
Definition: Coord.h:326
void getCornerPoints(Coord *p) const
Populates an array with the eight corner points of this bounding box.
Definition: Coord.h:464
size_t maxExtent() const
Return the index (0, 1 or 2) of the longest axis.
Definition: Coord.h:398
bool empty() const
Return true if this bounding box is empty (i.e., encloses no coordinates).
Definition: Coord.h:369
Int32 x() const
Definition: Coord.h:154
void expand(const CoordBBox &bbox)
Union this bounding box with the given bounding box.
Definition: Coord.h:439
Coord operator-() const
Definition: Coord.h:143
Coord & reset(Int32 x, Int32 y, Int32 z)
Reset all three coordinates with the specified arguments.
Definition: Coord.h:93
size_t minExtent() const
Return the index (0, 1 or 2) of the shortest axis.
Definition: Coord.h:395
Int32 * asPointer()
Definition: Coord.h:166
Coord operator-(const Coord &rhs) const
Definition: Coord.h:139
static Coord round(const Vec3< T > &xyz)
Return xyz rounded to the closest integer coordinates (cell centered conversion). ...
Definition: Coord.h:74
Definition: Coord.h:39
Vec3I asVec3I() const
Definition: Coord.h:170
bool operator<(const Coord &rhs) const
Lexicographic less than.
Definition: Coord.h:180
void reset(const Coord &min, const Coord &max)
Definition: Coord.h:341
Vec3< typename promote< T, Coord::ValueType >::type > operator-(const Coord &v1, const Vec3< T > &v0)
Allow a Coord to be subtracted from a Vec3.
Definition: Coord.h:556
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:48
bool operator==(const Coord &rhs) const
Definition: Coord.h:173
Vec3s asVec3s() const
Definition: Coord.h:168
float Round(float x)
Return x rounded to the nearest integer.
Definition: Math.h:769
int32_t Int32
Definition: Types.h:59
std::ostream & operator<<(std::ostream &os, const CoordBBox &b)
Definition: Coord.h:567
static Coord minComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise minimum of the two Coords.
Definition: Coord.h:215
Iterator(const CoordBBox &b)
C-tor from a bounding box.
Definition: Coord.h:275
Coord dim() const
Return the dimensions of the coordinates spanned by this bounding box.
Definition: Coord.h:381
ZYXIterator begin() const
Return a ZYX-order iterator that points to the minimum coordinate.
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:452
CoordBBox(const Coord &min, const Coord &max)
Construct a bounding box with the given min and max bounds.
Definition: Coord.h:309
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:71
int32_t Int32
Definition: Coord.h:51
Int32 ValueType
Definition: Coord.h:56
bool operator!=(const CoordBBox &rhs) const
Definition: Coord.h:366
Coord & setY(Int32 y)
Definition: Coord.h:104
void maxComponent(const Coord &other)
Perform a component-wise maximum with the other Coord.
Definition: Coord.h:207
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:87
static bool lessThan(const Coord &a, const Coord &b)
Definition: Coord.h:232
CoordBBox & operator<<=(size_t n)
Bit-wise operations performed on both the min and max members.
Definition: Coord.h:481
const Coord & min() const
Definition: Coord.h:334
int Floor(float x)
Return the floor of x.
Definition: Math.h:798
void reset()
Definition: Coord.h:340
uint32_t Index32
Definition: Coord.h:52
Vec3d asVec3d() const
Definition: Coord.h:167
bool hasOverlap(const CoordBBox &b) const
Return true if the given bounding box overlaps with this bounding box.
Definition: Coord.h:413
const Coord & operator*() const
Return a const reference to the coordinate currently pointed to.
Definition: Coord.h:283
Coord::ValueType ValueType
Definition: Coord.h:265
Coord(Int32 x, Int32 y, Int32 z)
Definition: Coord.h:61
Coord & offset(Int32 n)
Definition: Coord.h:114
uint64_t Index64
Definition: Coord.h:264
size_t MaxIndex(const Vec3T &v)
Return the index [0,1,2] of the largest value in a 3D vector.
Definition: Math.h:907
ZYXIterator endZYX() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:361
Coord(const Vec3i &v)
Definition: Coord.h:62
void write(std::ostream &os) const
Serialize this bounding box to the given stream.
Definition: Coord.h:492