OpenVDB 5.1.0

Coord.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2018 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 <algorithm> // for std::min(), std::max()
35 #include <array> // for std::array
36 #include <iostream>
37 #include <limits>
38 #include <openvdb/Platform.h>
39 #include "Math.h"
40 #include "Vec3.h"
41
42 namespace tbb { class split; } // forward declaration
43
44
45 namespace openvdb {
46 OPENVDB_USE_VERSION_NAMESPACE
47 namespace OPENVDB_VERSION_NAME {
48 namespace math {
49
51 class Coord
52 {
53 public:
54 using Int32 = int32_t;
55 using Index32 = uint32_t;
56 using Vec3i = Vec3<Int32>;
57 using Vec3I = Vec3<Index32>;
58
59 using ValueType = Int32;
60 using Limits = std::numeric_limits<ValueType>;
61
62 Coord(): mVec{{0, 0, 0}} {}
63 explicit Coord(Int32 xyz): mVec{{xyz, xyz, xyz}} {}
64 Coord(Int32 x, Int32 y, Int32 z): mVec{{x, y, z}} {}
65 explicit Coord(const Vec3i& v): mVec{{v[0], v[1], v[2]}} {}
66 explicit Coord(const Vec3I& v): mVec{{Int32(v[0]), Int32(v[1]), Int32(v[2])}} {}
67 explicit Coord(const Int32* v): mVec{{v[0], v[1], v[2]}} {}
68
70 static Coord min() { return Coord(Limits::min()); }
71
73 static Coord max() { return Coord(Limits::max()); }
74
77 template<typename T> static Coord round(const Vec3<T>& xyz)
78 {
79 return Coord(Int32(Round(xyz[0])), Int32(Round(xyz[1])), Int32(Round(xyz[2])));
80 }
83 template<typename T> static Coord floor(const Vec3<T>& xyz)
84 {
85 return Coord(Int32(Floor(xyz[0])), Int32(Floor(xyz[1])), Int32(Floor(xyz[2])));
86 }
87
90 template<typename T> static Coord ceil(const Vec3<T>& xyz)
91 {
92 return Coord(Int32(Ceil(xyz[0])), Int32(Ceil(xyz[1])), Int32(Ceil(xyz[2])));
93 }
94
96 Coord& reset(Int32 x, Int32 y, Int32 z)
97 {
98 mVec[0] = x;
99 mVec[1] = y;
100 mVec[2] = z;
101 return *this;
102 }
104 Coord& reset(Int32 xyz) { return this->reset(xyz, xyz, xyz); }
105
106 Coord& setX(Int32 x) { mVec[0] = x; return *this; }
107 Coord& setY(Int32 y) { mVec[1] = y; return *this; }
108 Coord& setZ(Int32 z) { mVec[2] = z; return *this; }
109
110 Coord& offset(Int32 dx, Int32 dy, Int32 dz)
111 {
112 mVec[0] += dx;
113 mVec[1] += dy;
114 mVec[2] += dz;
115 return *this;
116 }
117 Coord& offset(Int32 n) { return this->offset(n, n, n); }
118 Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
119 {
120 return Coord(mVec[0] + dx, mVec[1] + dy, mVec[2] + dz);
121 }
122 Coord offsetBy(Int32 n) const { return offsetBy(n, n, n); }
123
124 Coord& operator+=(const Coord& rhs)
125 {
126 mVec[0] += rhs[0];
127 mVec[1] += rhs[1];
128 mVec[2] += rhs[2];
129 return *this;
130 }
131 Coord& operator-=(const Coord& rhs)
132 {
133 mVec[0] -= rhs[0];
134 mVec[1] -= rhs[1];
135 mVec[2] -= rhs[2];
136 return *this;
137 }
138 Coord operator+(const Coord& rhs) const
139 {
140 return Coord(mVec[0] + rhs[0], mVec[1] + rhs[1], mVec[2] + rhs[2]);
141 }
142 Coord operator-(const Coord& rhs) const
143 {
144 return Coord(mVec[0] - rhs[0], mVec[1] - rhs[1], mVec[2] - rhs[2]);
145 }
146 Coord operator-() const { return Coord(-mVec[0], -mVec[1], -mVec[2]); }
147
148 Coord operator>> (size_t n) const { return Coord(mVec[0]>>n, mVec[1]>>n, mVec[2]>>n); }
149 Coord operator<< (size_t n) const { return Coord(mVec[0]<<n, mVec[1]<<n, mVec[2]<<n); }
150 Coord& operator<<=(size_t n) { mVec[0]<<=n; mVec[1]<<=n; mVec[2]<<=n; return *this; }
151 Coord& operator>>=(size_t n) { mVec[0]>>=n; mVec[1]>>=n; mVec[2]>>=n; return *this; }
152 Coord operator& (Int32 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) { mVec[0]&=n; mVec[1]&=n; mVec[2]&=n; return *this; }
155 Coord& operator|= (Int32 n) { mVec[0]|=n; mVec[1]|=n; mVec[2]|=n; return *this; }
156
157 Int32 x() const { return mVec[0]; }
158 Int32 y() const { return mVec[1]; }
159 Int32 z() const { return mVec[2]; }
160 Int32 operator[](size_t i) const { assert(i < 3); return mVec[i]; }
161 Int32& x() { return mVec[0]; }
162 Int32& y() { return mVec[1]; }
163 Int32& z() { return mVec[2]; }
164 Int32& operator[](size_t i) { assert(i < 3); return mVec[i]; }
165
166 const Int32* data() const { return mVec.data(); }
167 Int32* data() { return mVec.data(); }
168 const Int32* asPointer() const { return mVec.data(); }
169 Int32* asPointer() { return mVec.data(); }
170 Vec3d asVec3d() const { return Vec3d(double(mVec[0]), double(mVec[1]), double(mVec[2])); }
171 Vec3s asVec3s() const { return Vec3s(float(mVec[0]), float(mVec[1]), float(mVec[2])); }
172 Vec3i asVec3i() const { return Vec3i(mVec.data()); }
173 Vec3I asVec3I() const { return Vec3I(Index32(mVec[0]), Index32(mVec[1]), Index32(mVec[2])); }
174 void asXYZ(Int32& x, Int32& y, Int32& z) const { x = mVec[0]; y = mVec[1]; z = mVec[2]; }
175
176 bool operator==(const Coord& rhs) const
177 {
178 return (mVec[0] == rhs.mVec[0] && mVec[1] == rhs.mVec[1] && mVec[2] == rhs.mVec[2]);
179 }
180 bool operator!=(const Coord& rhs) const { return !(*this == rhs); }
181
183 bool operator<(const Coord& rhs) const
184 {
185 return this->x() < rhs.x() ? true : this->x() > rhs.x() ? false
186 : this->y() < rhs.y() ? true : this->y() > rhs.y() ? false
187 : this->z() < rhs.z() ? true : false;
188 }
190 bool operator<=(const Coord& rhs) const
191 {
192 return this->x() < rhs.x() ? true : this->x() > rhs.x() ? false
193 : this->y() < rhs.y() ? true : this->y() > rhs.y() ? false
194 : this->z() <=rhs.z() ? true : false;
195 }
197 bool operator>(const Coord& rhs) const { return !(*this <= rhs); }
199 bool operator>=(const Coord& rhs) const { return !(*this < rhs); }
200
202 void minComponent(const Coord& other)
203 {
204 mVec[0] = std::min(mVec[0], other.mVec[0]);
205 mVec[1] = std::min(mVec[1], other.mVec[1]);
206 mVec[2] = std::min(mVec[2], other.mVec[2]);
207 }
208
210 void maxComponent(const Coord& other)
211 {
212 mVec[0] = std::max(mVec[0], other.mVec[0]);
213 mVec[1] = std::max(mVec[1], other.mVec[1]);
214 mVec[2] = std::max(mVec[2], other.mVec[2]);
215 }
216
218 static inline Coord minComponent(const Coord& lhs, const Coord& rhs)
219 {
220 return Coord(std::min(lhs.x(), rhs.x()),
221 std::min(lhs.y(), rhs.y()),
222 std::min(lhs.z(), rhs.z()));
223 }
224
226 static inline Coord maxComponent(const Coord& lhs, const Coord& rhs)
227 {
228 return Coord(std::max(lhs.x(), rhs.x()),
229 std::max(lhs.y(), rhs.y()),
230 std::max(lhs.z(), rhs.z()));
231 }
232
235 static inline bool lessThan(const Coord& a, const Coord& b)
236 {
237 return (a[0] < b[0] || a[1] < b[1] || a[2] < b[2]);
238 }
239
241 size_t minIndex() const { return MinIndex(mVec); }
242
244 size_t maxIndex() const { return MaxIndex(mVec); }
245
246 void read(std::istream& is) { is.read(reinterpret_cast<char*>(mVec.data()), sizeof(mVec)); }
247 void write(std::ostream& os) const
248 {
249 os.write(reinterpret_cast<const char*>(mVec.data()), sizeof(mVec));
250 }
251
252 private:
253 std::array<Int32, 3> mVec;
254 }; // class Coord
255
256
258
259
264 class CoordBBox
265 {
266 public:
267 using Index64 = uint64_t;
268 using ValueType = Coord::ValueType;
269
273 template<bool ZYXOrder>
274 class Iterator
275 {
276 public:
278 Iterator(const CoordBBox& b): mPos(b.min()), mMin(b.min()), mMax(b.max()) {}
282 Iterator& operator++() { ZYXOrder ? next<2,1,0>() : next<0,1,2>(); return *this; }
284 operator bool() const { return ZYXOrder ? (mPos[0] <= mMax[0]) : (mPos[2] <= mMax[2]); }
286 const Coord& operator*() const { return mPos; }
288 bool operator==(const Iterator& other) const
289 {
290 return ((mPos == other.mPos) && (mMin == other.mMin) && (mMax == other.mMax));
291 }
293 bool operator!=(const Iterator& other) const { return !(*this == other); }
294 private:
295 template<size_t a, size_t b, size_t c>
296 void next()
297 {
298 if (mPos[a] < mMax[a]) { ++mPos[a]; } // this is the most common case
299 else if (mPos[b] < mMax[b]) { mPos[a] = mMin[a]; ++mPos[b]; }
300 else if (mPos[c] <= mMax[c]) { mPos[a] = mMin[a]; mPos[b] = mMin[b]; ++mPos[c]; }
301 }
302 Coord mPos, mMin, mMax;
303 friend class CoordBBox; // for CoordBBox::end()
304 };// CoordBBox::Iterator
305
306 using ZYXIterator = Iterator</*ZYX=*/true>;
307 using XYZIterator = Iterator</*ZYX=*/false>;
308
310 CoordBBox(): mMin(Coord::max()), mMax(Coord::min()) {}
312 CoordBBox(const Coord& min, const Coord& max): mMin(min), mMax(max) {}
314 CoordBBox(ValueType xMin, ValueType yMin, ValueType zMin,
315 ValueType xMax, ValueType yMax, ValueType zMax)
316 : mMin(xMin, yMin, zMin), mMax(xMax, yMax, zMax)
317 {
318 }
321 CoordBBox(CoordBBox& other, const tbb::split&): mMin(other.mMin), mMax(other.mMax)
322 {
323 assert(this->is_divisible());
324 const size_t n = this->maxExtent();
325 mMax[n] = (mMin[n] + mMax[n]) >> 1;
326 other.mMin[n] = mMax[n] + 1;
327 }
328
329 static CoordBBox createCube(const Coord& min, ValueType dim)
330 {
331 return CoordBBox(min, min.offsetBy(dim - 1));
332 }
333
335 static CoordBBox inf() { return CoordBBox(Coord::min(), Coord::max()); }
336
337 const Coord& min() const { return mMin; }
338 const Coord& max() const { return mMax; }
339
340 Coord& min() { return mMin; }
341 Coord& max() { return mMax; }
342
343 void reset() { mMin = Coord::max(); mMax = Coord::min(); }
344 void reset(const Coord& min, const Coord& max) { mMin = min; mMax = max; }
345 void resetToCube(const Coord& min, ValueType dim) { mMin = min; mMax = min.offsetBy(dim - 1); }
346
349 Coord getStart() const { return mMin; }
352 Coord getEnd() const { return mMax.offsetBy(1); }
353
355 ZYXIterator begin() const { return ZYXIterator{*this}; }
357 ZYXIterator beginZYX() const { return ZYXIterator{*this}; }
359 XYZIterator beginXYZ() const { return XYZIterator{*this}; }
360
362 ZYXIterator end() const { ZYXIterator it{*this}; it.mPos[0] = mMax[0] + 1; return it; }
364 ZYXIterator endZYX() const { return end(); }
366 XYZIterator endXYZ() const { XYZIterator it{*this}; it.mPos[2] = mMax[2] + 1; return it; }
367
368 bool operator==(const CoordBBox& rhs) const { return mMin == rhs.mMin && mMax == rhs.mMax; }
369 bool operator!=(const CoordBBox& rhs) const { return !(*this == rhs); }
370
372 bool empty() const { return (mMin[0] > mMax[0] || mMin[1] > mMax[1] || mMin[2] > mMax[2]); }
374 operator bool() const { return !this->empty(); }
376 bool hasVolume() const { return !this->empty(); }
377
379 Vec3d getCenter() const { return 0.5 * Vec3d((mMin + mMax).asPointer()); }
380
384 Coord dim() const { return mMax.offsetBy(1) - mMin; }
386 Coord extents() const { return this->dim(); }
389 Index64 volume() const
390 {
391 const Coord d = this->dim();
392 return Index64(d[0]) * Index64(d[1]) * Index64(d[2]);
393 }
395 bool is_divisible() const { return mMin[0]<mMax[0] && mMin[1]<mMax[1] && mMin[2]<mMax[2]; }
396
398 size_t minExtent() const { return this->dim().minIndex(); }
399
401 size_t maxExtent() const { return this->dim().maxIndex(); }
402
404 bool isInside(const Coord& xyz) const
405 {
406 return !(Coord::lessThan(xyz,mMin) || Coord::lessThan(mMax,xyz));
407 }
408
410 bool isInside(const CoordBBox& b) const
411 {
412 return !(Coord::lessThan(b.mMin,mMin) || Coord::lessThan(mMax,b.mMax));
413 }
414
416 bool hasOverlap(const CoordBBox& b) const
417 {
418 return !(Coord::lessThan(mMax,b.mMin) || Coord::lessThan(b.mMax,mMin));
419 }
420
422 void expand(ValueType padding)
423 {
424 mMin.offset(-padding);
425 mMax.offset( padding);
426 }
427
429 CoordBBox expandBy(ValueType padding) const
430 {
431 return CoordBBox(mMin.offsetBy(-padding),mMax.offsetBy(padding));
432 }
433
435 void expand(const Coord& xyz)
436 {
437 mMin.minComponent(xyz);
438 mMax.maxComponent(xyz);
439 }
440
442 void expand(const CoordBBox& bbox)
443 {
444 mMin.minComponent(bbox.min());
445 mMax.maxComponent(bbox.max());
446 }
448 void intersect(const CoordBBox& bbox)
449 {
450 mMin.maxComponent(bbox.min());
451 mMax.minComponent(bbox.max());
452 }
455 void expand(const Coord& min, Coord::ValueType dim)
456 {
457 mMin.minComponent(min);
458 mMax.maxComponent(min.offsetBy(dim-1));
459 }
462 void translate(const Coord& t) { mMin += t; mMax += t; }
463
468 void getCornerPoints(Coord *p) const
469 {
470 assert(p != nullptr);
471 p->reset(mMin.x(), mMin.y(), mMin.z()); ++p;
472 p->reset(mMin.x(), mMin.y(), mMax.z()); ++p;
473 p->reset(mMin.x(), mMax.y(), mMin.z()); ++p;
474 p->reset(mMin.x(), mMax.y(), mMax.z()); ++p;
475 p->reset(mMax.x(), mMin.y(), mMin.z()); ++p;
476 p->reset(mMax.x(), mMin.y(), mMax.z()); ++p;
477 p->reset(mMax.x(), mMax.y(), mMin.z()); ++p;
478 p->reset(mMax.x(), mMax.y(), mMax.z());
479 }
480
482 CoordBBox operator>> (size_t n) const { return CoordBBox(mMin>>n, mMax>>n); }
484 CoordBBox operator<< (size_t n) const { return CoordBBox(mMin<<n, mMax<<n); }
485 CoordBBox& operator<<=(size_t n) { mMin <<= n; mMax <<= n; return *this; }
486 CoordBBox& operator>>=(size_t n) { mMin >>= n; mMax >>= n; return *this; }
487 CoordBBox operator& (Coord::Int32 n) const { return CoordBBox(mMin & n, mMax & n); }
488 CoordBBox operator| (Coord::Int32 n) const { return CoordBBox(mMin | n, mMax | n); }
489 CoordBBox& operator&= (Coord::Int32 n) { mMin &= n; mMax &= n; return *this; }
490 CoordBBox& operator|= (Coord::Int32 n) { mMin |= n; mMax |= n; return *this; }
492
494 void read(std::istream& is) { mMin.read(is); mMax.read(is); }
496 void write(std::ostream& os) const { mMin.write(os); mMax.write(os); }
497
498 private:
499 Coord mMin, mMax;
500 }; // class CoordBBox
501
502
504
505
506 inline std::ostream& operator<<(std::ostream& os, const Coord& xyz)
507 {
508 os << xyz.asVec3i(); return os;
509 }
510
511
512 inline Coord
513 Abs(const Coord& xyz)
514 {
515 return Coord(Abs(xyz[0]), Abs(xyz[1]), Abs(xyz[2]));
516 }
517
518
520 template<typename T>
522 inline Vec3<typename promote<T, typename Coord::ValueType>::type>
523 operator+(const Vec3<T>& v0, const Coord& v1)
524 {
525 Vec3<typename promote<T, typename Coord::ValueType>::type> result(v0);
526 result[0] += v1[0];
527 result[1] += v1[1];
528 result[2] += v1[2];
529 return result;
530 }
531
532 template<typename T>
533 inline Vec3<typename promote<T, typename Coord::ValueType>::type>
534 operator+(const Coord& v1, const Vec3<T>& v0)
535 {
536 Vec3<typename promote<T, typename Coord::ValueType>::type> result(v0);
537 result[0] += v1[0];
538 result[1] += v1[1];
539 result[2] += v1[2];
540 return result;
541 }
543
544
546 template <typename T>
548 inline Vec3<typename promote<T, Coord::ValueType>::type>
549 operator-(const Vec3<T>& v0, const Coord& v1)
550 {
551 Vec3<typename promote<T, Coord::ValueType>::type> result(v0);
552 result[0] -= v1[0];
553 result[1] -= v1[1];
554 result[2] -= v1[2];
555 return result;
556 }
557
558 template <typename T>
559 inline Vec3<typename promote<T, Coord::ValueType>::type>
560 operator-(const Coord& v1, const Vec3<T>& v0)
561 {
562 Vec3<typename promote<T, Coord::ValueType>::type> result(v0);
563 result[0] -= v1[0];
564 result[1] -= v1[1];
565 result[2] -= v1[2];
566 return -result;
567 }
569
570 inline std::ostream&
571 operator<<(std::ostream& os, const CoordBBox& b)
572 {
573 os << b.min() << " -> " << b.max();
574 return os;
575 }
576
577 } // namespace math
578 } // namespace OPENVDB_VERSION_NAME
579 } // namespace openvdb
580
581 #endif // OPENVDB_MATH_COORD_HAS_BEEN_INCLUDED
582
583 // Copyright (c) 2012-2018 DreamWorks Animation LLC
584 // All rights reserved. This software is distributed under the
585 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
openvdb::v5_1::Index32
uint32_t Index32
Definition: Types.h:59
openvdb::v5_1::math::Coord::operator-
Coord operator-() const
Definition: Coord.h:146
openvdb::v5_1::math::CoordBBox::operator<<=
CoordBBox & operator<<=(size_t n)
Bit-wise operations performed on both the min and max members.
Definition: Coord.h:485
openvdb::v5_1::math::CoordBBox::isInside
bool isInside(const CoordBBox &b) const
Return true if the given bounding box is inside this bounding box.
Definition: Coord.h:410
openvdb::v5_1::math::CoordBBox::ValueType
Coord::ValueType ValueType
Definition: Coord.h:268
openvdb::v5_1::math::Coord::min
static Coord min()
Return the smallest possible coordinate.
Definition: Coord.h:70
openvdb::v5_1::math::CoordBBox::expand
void expand(const CoordBBox &bbox)
Union this bounding box with the given bounding box.
Definition: Coord.h:442
openvdb::v5_1::math::Coord::z
Int32 & z()
Definition: Coord.h:163
openvdb::v5_1::math::Floor
int Floor(float x)
Return the floor of x.
Definition: Math.h:802
openvdb::v5_1::math::CoordBBox::max
const Coord & max() const
Definition: Coord.h:338
Vec3.h
openvdb::v5_1::math::CoordBBox::endZYX
ZYXIterator endZYX() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:364
openvdb::v5_1::math::Coord::operator!=
bool operator!=(const Coord &rhs) const
Definition: Coord.h:180
openvdb::v5_1::math::CoordBBox::write
void write(std::ostream &os) const
Serialize this bounding box to the given stream.
Definition: Coord.h:496
openvdb::v5_1::math::CoordBBox::Iterator::operator!=
bool operator!=(const Iterator &other) const
Return true if this iterator and the given iterator point to different coordinates.
Definition: Coord.h:293
openvdb::v5_1::math::Coord::data
const Int32 * data() const
Definition: Coord.h:166
openvdb::v5_1::math::Coord::operator+
Coord operator+(const Coord &rhs) const
Definition: Coord.h:138
openvdb::v5_1::math::CoordBBox
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:264
openvdb::v5_1::math::Coord::reset
Coord & reset(Int32 x, Int32 y, Int32 z)
Reset all three coordinates with the specified arguments.
Definition: Coord.h:96
openvdb::v5_1::math::Coord::Limits
std::numeric_limits< ValueType > Limits
Definition: Coord.h:60
openvdb::v5_1::math::Abs
Coord Abs(const Coord &xyz)
Definition: Coord.h:513
Math.h
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
openvdb::v5_1::math::Coord::max
static Coord max()
Return the largest possible coordinate.
Definition: Coord.h:73
openvdb::v5_1::math::Coord::offset
Coord & offset(Int32 dx, Int32 dy, Int32 dz)
Definition: Coord.h:110
openvdb::v5_1::math::Coord::Coord
Coord(Int32 x, Int32 y, Int32 z)
Definition: Coord.h:64
openvdb::v5_1::math::Coord::operator+=
Coord & operator+=(const Coord &rhs)
Definition: Coord.h:124
openvdb::v5_1::math::CoordBBox::beginZYX
ZYXIterator beginZYX() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:357
openvdb::v5_1::math::CoordBBox::resetToCube
void resetToCube(const Coord &min, ValueType dim)
Definition: Coord.h:345
openvdb::v5_1::math::Coord::minComponent
static Coord minComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise minimum of the two Coords.
Definition: Coord.h:218
openvdb::v5_1::math::Coord::operator-=
Coord & operator-=(const Coord &rhs)
Definition: Coord.h:131
openvdb::v5_1::math::CoordBBox::expand
void expand(ValueType padding)
Pad this bounding box with the specified padding.
Definition: Coord.h:422
openvdb::v5_1::math::CoordBBox::beginXYZ
XYZIterator beginXYZ() const
Return an XYZ-order iterator that points to the minimum coordinate.
Definition: Coord.h:359
openvdb::v5_1::math::Coord::y
Int32 & y()
Definition: Coord.h:162
openvdb::v5_1::math::Coord::floor
static Coord floor(const Vec3< T > &xyz)
Return the largest integer coordinates that are not greater than xyz (node centered conversion)...
Definition: Coord.h:83
openvdb::v5_1::math::CoordBBox::hasVolume
bool hasVolume() const
Return true if this bounding box is nonempty (i.e., encloses at least one coordinate).
Definition: Coord.h:376
openvdb::v5_1::math::Coord::asVec3I
Vec3I asVec3I() const
Definition: Coord.h:173
openvdb::v5_1::math::CoordBBox::Index64
uint64_t Index64
Definition: Coord.h:267
openvdb::v5_1::Vec3I
math::Vec3< Index32 > Vec3I
Definition: Types.h:80
openvdb::v5_1::math::CoordBBox::dim
Coord dim() const
Return the dimensions of the coordinates spanned by this bounding box.
Definition: Coord.h:384
openvdb::v5_1::math::Coord::ValueType
Int32 ValueType
Definition: Coord.h:59
openvdb::v5_1::math::Round
float Round(float x)
Return x rounded to the nearest integer.
Definition: Math.h:773
openvdb::v5_1::math::CoordBBox::Iterator
Iterator over the Coord domain covered by a CoordBBox.
Definition: Coord.h:274
openvdb::v5_1::math::Vec3
Definition: Mat.h:197
openvdb::v5_1::math::Vec3i
Vec3< int32_t > Vec3i
Definition: Vec3.h:676
openvdb::v5_1::math::CoordBBox::getCenter
Vec3d getCenter() const
Return the floating-point position of the center of this bounding box.
Definition: Coord.h:379
openvdb::v5_1::math::Coord::operator[]
Int32 operator[](size_t i) const
Definition: Coord.h:160
openvdb::v5_1::math::CoordBBox::Iterator::Iterator
Iterator(const CoordBBox &b)
C-tor from a bounding box.
Definition: Coord.h:278
openvdb::v5_1::math::CoordBBox::Iterator::operator*
const Coord & operator*() const
Return a const reference to the coordinate currently pointed to.
Definition: Coord.h:286
openvdb::v5_1::math::CoordBBox::expandBy
CoordBBox expandBy(ValueType padding) const
Return a new instance that is expanded by the specified padding.
Definition: Coord.h:429
openvdb::v5_1::math::Coord::Coord
Coord()
Definition: Coord.h:62
openvdb::v5_1::math::Coord::minIndex
size_t minIndex() const
Return the index (0, 1 or 2) with the smallest value.
Definition: Coord.h:241
openvdb::v5_1::math::Coord::x
Int32 & x()
Definition: Coord.h:161
openvdb::v5_1::math::Coord::operator[]
Int32 & operator[](size_t i)
Definition: Coord.h:164
openvdb::v5_1::math::Coord::maxComponent
static Coord maxComponent(const Coord &lhs, const Coord &rhs)
Return the component-wise maximum of the two Coords.
Definition: Coord.h:226
openvdb::v5_1::math::Coord::Coord
Coord(const Vec3i &v)
Definition: Coord.h:65
openvdb::v5_1::math::Coord::offset
Coord & offset(Int32 n)
Definition: Coord.h:117
openvdb::v5_1::math::CoordBBox::operator==
bool operator==(const CoordBBox &rhs) const
Definition: Coord.h:368
openvdb::v5_1::math::Coord::operator<
bool operator<(const Coord &rhs) const
Lexicographic less than.
Definition: Coord.h:183
openvdb::v5_1::math::Coord::setY
Coord & setY(Int32 y)
Definition: Coord.h:107
openvdb::v5_1::math::CoordBBox::Iterator::operator++
Iterator & operator++()
Increment the iterator to point to the next coordinate.
Definition: Coord.h:282
openvdb::v5_1::math::Coord::asPointer
const Int32 * asPointer() const
Definition: Coord.h:168
openvdb::v5_1::math::Coord::read
void read(std::istream &is)
Definition: Coord.h:246
openvdb::v5_1::math::CoordBBox::inf
static CoordBBox inf()
Return an "infinite" bounding box, as defined by the Coord value range.
Definition: Coord.h:335
openvdb::v5_1::math::Coord::offsetBy
Coord offsetBy(Int32 n) const
Definition: Coord.h:122
openvdb::v5_1::math::CoordBBox::begin
ZYXIterator begin() const
Return a ZYX-order iterator that points to the minimum coordinate.
Definition: Coord.h:355
openvdb::v5_1::math::CoordBBox::minExtent
size_t minExtent() const
Return the index (0, 1 or 2) of the shortest axis.
Definition: Coord.h:398
openvdb::v5_1::math::CoordBBox::read
void read(std::istream &is)
Unserialize this bounding box from the given stream.
Definition: Coord.h:494
openvdb::v5_1::math::CoordBBox::hasOverlap
bool hasOverlap(const CoordBBox &b) const
Return true if the given bounding box overlaps with this bounding box.
Definition: Coord.h:416
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:136
openvdb::v5_1::math::operator-
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:560
openvdb::v5_1::math::Ceil
int Ceil(float x)
Return the ceiling of x.
Definition: Math.h:810
openvdb::v5_1::math::operator+
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:534
openvdb::v5_1::math::CoordBBox::min
const Coord & min() const
Definition: Coord.h:337
openvdb::v5_1::math::CoordBBox::intersect
void intersect(const CoordBBox &bbox)
Intersect this bounding box with the given bounding box.
Definition: Coord.h:448
openvdb::v5_1::math::Coord::operator-
Coord operator-(const Coord &rhs) const
Definition: Coord.h:142
openvdb::v5_1::math::Coord::Coord
Coord(const Vec3I &v)
Definition: Coord.h:66
openvdb::v5_1::math::Vec3d
Vec3< double > Vec3d
Definition: Vec3.h:679
openvdb::v5_1::math::Coord::data
Int32 * data()
Definition: Coord.h:167
openvdb::v5_1::math::CoordBBox::min
Coord & min()
Definition: Coord.h:340
openvdb::v5_1::math::CoordBBox::isInside
bool isInside(const Coord &xyz) const
Return true if point (x, y, z) is inside this bounding box.
Definition: Coord.h:404
openvdb::v5_1::math::Coord::z
Int32 z() const
Definition: Coord.h:159
openvdb::v5_1::Index64
uint64_t Index64
Definition: Types.h:60
openvdb::v5_1::math::Coord::maxIndex
size_t maxIndex() const
Return the index (0, 1 or 2) with the largest value.
Definition: Coord.h:244
openvdb::v5_1::math::CoordBBox::CoordBBox
CoordBBox(CoordBBox &other, const tbb::split &)
Splitting constructor for use in TBB ranges.
Definition: Coord.h:321
openvdb::v5_1::Int32
int32_t Int32
Definition: Types.h:63
openvdb::v5_1::math::Coord::reset
Coord & reset(Int32 xyz)
Reset all three coordinates with the same specified argument.
Definition: Coord.h:104
openvdb::v5_1::math::Coord::minComponent
void minComponent(const Coord &other)
Perform a component-wise minimum with the other Coord.
Definition: Coord.h:202
openvdb::v5_1::math::CoordBBox::expand
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:455
openvdb
Definition: Exceptions.h:40
openvdb::v5_1::math::Coord::lessThan
static bool lessThan(const Coord &a, const Coord &b)
Definition: Coord.h:235
openvdb::v5_1::math::Coord::write
void write(std::ostream &os) const
Definition: Coord.h:247
openvdb::v5_1::math::CoordBBox::extents
Coord extents() const
Definition: Coord.h:386
openvdb::v5_1::math::Coord::round
static Coord round(const Vec3< T > &xyz)
Return xyz rounded to the closest integer coordinates (cell centered conversion). ...
Definition: Coord.h:77
openvdb::v5_1::math::Coord::operator>>=
Coord & operator>>=(size_t n)
Definition: Coord.h:151
openvdb::v5_1::math::CoordBBox::translate
void translate(const Coord &t)
Definition: Coord.h:462
openvdb::v5_1::math::Coord::offsetBy
Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
Definition: Coord.h:118
openvdb::v5_1::math::Coord::asPointer
Int32 * asPointer()
Definition: Coord.h:169
openvdb::v5_1::math::Coord::y
Int32 y() const
Definition: Coord.h:158
openvdb::v5_1::math::Coord::Coord
Coord(Int32 xyz)
Definition: Coord.h:63
openvdb::v5_1::math::Coord::operator==
bool operator==(const Coord &rhs) const
Definition: Coord.h:176
openvdb::v5_1::math::CoordBBox::operator>>=
CoordBBox & operator>>=(size_t n)
Bit-wise operations performed on both the min and max members.
Definition: Coord.h:486
openvdb::v5_1::math::Coord::maxComponent
void maxComponent(const Coord &other)
Perform a component-wise maximum with the other Coord.
Definition: Coord.h:210
openvdb::v5_1::math::CoordBBox::getEnd
Coord getEnd() const
Return the maximum coordinate plus one.
Definition: Coord.h:352
openvdb::v5_1::math::CoordBBox::reset
void reset()
Definition: Coord.h:343
openvdb::v5_1::math::Vec3s
Vec3< float > Vec3s
Definition: Vec3.h:678
openvdb::v5_1::math::Coord::setZ
Coord & setZ(Int32 z)
Definition: Coord.h:108
openvdb::v5_1::math::CoordBBox::reset
void reset(const Coord &min, const Coord &max)
Definition: Coord.h:344
openvdb::v5_1::math::Coord::operator>=
bool operator>=(const Coord &rhs) const
Lexicographic greater than or equal to.
Definition: Coord.h:199
openvdb::v5_1::math::CoordBBox::max
Coord & max()
Definition: Coord.h:341
openvdb::v5_1::math::Coord::asVec3s
Vec3s asVec3s() const
Definition: Coord.h:171
openvdb::v5_1::math::CoordBBox::createCube
static CoordBBox createCube(const Coord &min, ValueType dim)
Definition: Coord.h:329
openvdb::v5_1::math::operator<<
std::ostream & operator<<(std::ostream &os, const CoordBBox &b)
Definition: Coord.h:571
openvdb::v5_1::math::CoordBBox::expand
void expand(const Coord &xyz)
Expand this bounding box to enclose point (x, y, z).
Definition: Coord.h:435
openvdb::v5_1::tools::composite::min
const std::enable_if<!VecTraits< T >::IsVec, T >::type & min(const T &a, const T &b)
Definition: Composite.h:129
openvdb::v5_1::math::CoordBBox::empty
bool empty() const
Return true if this bounding box is empty (i.e., encloses no coordinates).
Definition: Coord.h:372
openvdb::v5_1::math::Coord::setX
Coord & setX(Int32 x)
Definition: Coord.h:106
openvdb::v5_1::math::CoordBBox::getStart
Coord getStart() const
Return the minimum coordinate.
Definition: Coord.h:349
openvdb::v5_1::math::Coord
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:51
openvdb::v5_1::math::MinIndex
size_t MinIndex(const Vec3T &v)
Return the index [0,1,2] of the smallest value in a 3D vector.
Definition: Math.h:890
tbb
Definition: Coord.h:42
openvdb::v5_1::math::CoordBBox::operator!=
bool operator!=(const CoordBBox &rhs) const
Definition: Coord.h:369
openvdb::v5_1::math::CoordBBox::getCornerPoints
void getCornerPoints(Coord *p) const
Populates an array with the eight corner points of this bounding box.
Definition: Coord.h:468
openvdb::v5_1::math::CoordBBox::CoordBBox
CoordBBox()
The default constructor produces an empty bounding box.
Definition: Coord.h:310
openvdb::v5_1::math::CoordBBox::CoordBBox
CoordBBox(const Coord &min, const Coord &max)
Construct a bounding box with the given min and max bounds.
Definition: Coord.h:312
openvdb::v5_1::math::Coord::asVec3i
Vec3i asVec3i() const
Definition: Coord.h:172
openvdb::v5_1::math::Coord::operator<=
bool operator<=(const Coord &rhs) const
Lexicographic less than or equal to.
Definition: Coord.h:190
openvdb::v5_1::math::Coord::asXYZ
void asXYZ(Int32 &x, Int32 &y, Int32 &z) const
Definition: Coord.h:174
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:188
openvdb::v5_1::math::MaxIndex
size_t MaxIndex(const Vec3T &v)
Return the index [0,1,2] of the largest value in a 3D vector.
Definition: Math.h:911
openvdb::v5_1::math::Coord::Coord
Coord(const Int32 *v)
Definition: Coord.h:67
openvdb::v5_1::math::Coord::asVec3d
Vec3d asVec3d() const
Definition: Coord.h:170
openvdb::v5_1::math::CoordBBox::volume
Index64 volume() const
Return the integer volume of coordinates spanned by this bounding box.
Definition: Coord.h:389
openvdb::v5_1::math::CoordBBox::Iterator::operator==
bool operator==(const Iterator &other) const
Return true if this iterator and the given iterator point to the same coordinate. ...
Definition: Coord.h:288
openvdb::v5_1::tools::composite::max
const std::enable_if<!VecTraits< T >::IsVec, T >::type & max(const T &a, const T &b)
Definition: Composite.h:133
openvdb::v5_1::math::CoordBBox::endXYZ
XYZIterator endXYZ() const
Return an XYZ-order iterator that points past the maximum coordinate.
Definition: Coord.h:366
openvdb::v5_1::math::Coord::operator>
bool operator>(const Coord &rhs) const
Lexicographic greater than.
Definition: Coord.h:197
openvdb::v5_1::math::Coord::operator<<=
Coord & operator<<=(size_t n)
Definition: Coord.h:150
openvdb::v5_1::math::CoordBBox::is_divisible
bool is_divisible() const
Return true if this bounding box can be subdivided [mainly for use by TBB].
Definition: Coord.h:395
openvdb::v5_1::math::CoordBBox::maxExtent
size_t maxExtent() const
Return the index (0, 1 or 2) of the longest axis.
Definition: Coord.h:401
openvdb::v5_1::math::Coord::ceil
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:90
openvdb::v5_1::math::CoordBBox::CoordBBox
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:314
openvdb::v5_1::math::Coord::Int32
int32_t Int32
Definition: Coord.h:54
openvdb::v5_1::math::CoordBBox::end
ZYXIterator end() const
Return a ZYX-order iterator that points past the maximum coordinate.
Definition: Coord.h:362
openvdb::v5_1::math::Coord::Index32
uint32_t Index32
Definition: Coord.h:55
Platform.h
openvdb::v5_1::math::Coord::x
Int32 x() const
Definition: Coord.h:157