OpenVDB  3.2.0
Types.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2016 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_TYPES_HAS_BEEN_INCLUDED
32 #define OPENVDB_TYPES_HAS_BEEN_INCLUDED
33 
34 #include "version.h"
35 #include "Platform.h"
36 #include <OpenEXR/half.h>
37 #include <openvdb/math/Math.h>
38 #include <openvdb/math/BBox.h>
39 #include <openvdb/math/Quat.h>
40 #include <openvdb/math/Vec2.h>
41 #include <openvdb/math/Vec3.h>
42 #include <openvdb/math/Vec4.h>
43 #include <openvdb/math/Mat3.h>
44 #include <openvdb/math/Mat4.h>
45 #include <openvdb/math/Coord.h>
46 #include <boost/type_traits/is_convertible.hpp>
47 #include <boost/type_traits/is_integral.hpp>
48 #include <boost/static_assert.hpp>
49 
50 
51 namespace openvdb {
53 namespace OPENVDB_VERSION_NAME {
54 
55 // One-dimensional scalar types
56 typedef uint32_t Index32;
57 typedef uint64_t Index64;
58 typedef Index32 Index;
59 typedef int16_t Int16;
60 typedef int32_t Int32;
61 typedef int64_t Int64;
62 typedef Int32 Int;
63 typedef unsigned char Byte;
64 typedef double Real;
65 
66 // Two-dimensional vector types
71 using math::Vec2i;
72 using math::Vec2s;
73 using math::Vec2d;
74 
75 // Three-dimensional vector types
80 using math::Vec3i;
81 using math::Vec3s;
82 using math::Vec3d;
83 
84 using math::Coord;
85 using math::CoordBBox;
87 
88 // Four-dimensional vector types
93 using math::Vec4i;
94 using math::Vec4s;
95 using math::Vec4d;
96 
97 // Three-dimensional matrix types
99 
100 // Four-dimensional matrix types
104 
105 // Quaternions
107 
108 // Dummy type for a voxel with a binary mask value, e.g. the active state
109 class ValueMask {};
110 
111 
113 
114 
118 template<typename IntType_, Index Kind>
120 {
121  BOOST_STATIC_ASSERT(boost::is_integral<IntType_>::value);
122 
123  typedef IntType_ IntType;
124 
125  PointIndex(IntType i = IntType(0)): mIndex(i) {}
126 
127  operator IntType() const { return mIndex; }
128 
130  template<typename T>
131  PointIndex operator+(T x) { return PointIndex(mIndex + IntType(x)); }
132 
133 private:
134  IntType mIndex;
135 };
136 
137 
140 
143 
144 
146 
147 
148 template<typename T> struct VecTraits {
149  static const bool IsVec = false;
150  static const int Size = 1;
151  typedef T ElementType;
152 };
153 template<typename T> struct VecTraits<math::Vec2<T> > {
154  static const bool IsVec = true;
155  static const int Size = 2;
156  typedef T ElementType;
157 };
158 template<typename T> struct VecTraits<math::Vec3<T> > {
159  static const bool IsVec = true;
160  static const int Size = 3;
161  typedef T ElementType;
162 };
163 template<typename T> struct VecTraits<math::Vec4<T> > {
164  static const bool IsVec = true;
165  static const int Size = 4;
166  typedef T ElementType;
167 };
168 
169 
171 
172 
182 template<typename FromType, typename ToType>
183 struct CanConvertType { enum { value = boost::is_convertible<FromType, ToType>::value }; };
184 
185 // Specializations for vector types, which can be constructed from values
186 // of their own ValueTypes (or values that can be converted to their ValueTypes),
187 // but only explicitly
188 template<typename T> struct CanConvertType<T, math::Vec2<T> > { enum { value = true }; };
189 template<typename T> struct CanConvertType<T, math::Vec3<T> > { enum { value = true }; };
190 template<typename T> struct CanConvertType<T, math::Vec4<T> > { enum { value = true }; };
191 template<typename T> struct CanConvertType<math::Vec2<T>, math::Vec2<T> > { enum {value = true}; };
192 template<typename T> struct CanConvertType<math::Vec3<T>, math::Vec3<T> > { enum {value = true}; };
193 template<typename T> struct CanConvertType<math::Vec4<T>, math::Vec4<T> > { enum {value = true}; };
194 template<typename T0, typename T1>
195 struct CanConvertType<T0, math::Vec2<T1> > { enum { value = CanConvertType<T0, T1>::value }; };
196 template<typename T0, typename T1>
197 struct CanConvertType<T0, math::Vec3<T1> > { enum { value = CanConvertType<T0, T1>::value }; };
198 template<typename T0, typename T1>
199 struct CanConvertType<T0, math::Vec4<T1> > { enum { value = CanConvertType<T0, T1>::value }; };
200 template<> struct CanConvertType<PointIndex32, PointDataIndex32> { enum {value = true}; };
201 template<> struct CanConvertType<PointDataIndex32, PointIndex32> { enum {value = true}; };
202 template<typename T>
204 template<typename T>
206 
208 
209 
210 // Add new items to the *end* of this list, and update NUM_GRID_CLASSES.
211 enum GridClass {
216 };
218 
219 static const Real LEVEL_SET_HALF_WIDTH = 3;
220 
241 enum VecType {
247 };
249 
250 
268 };
269 
270 
272 
273 
274 template<typename T> const char* typeNameAsString() { return typeid(T).name(); }
275 template<> inline const char* typeNameAsString<bool>() { return "bool"; }
276 template<> inline const char* typeNameAsString<ValueMask>() { return "mask"; }
277 template<> inline const char* typeNameAsString<float>() { return "float"; }
278 template<> inline const char* typeNameAsString<double>() { return "double"; }
279 template<> inline const char* typeNameAsString<int32_t>() { return "int32"; }
280 template<> inline const char* typeNameAsString<uint32_t>() { return "uint32"; }
281 template<> inline const char* typeNameAsString<int64_t>() { return "int64"; }
282 template<> inline const char* typeNameAsString<Vec2i>() { return "vec2i"; }
283 template<> inline const char* typeNameAsString<Vec2s>() { return "vec2s"; }
284 template<> inline const char* typeNameAsString<Vec2d>() { return "vec2d"; }
285 template<> inline const char* typeNameAsString<Vec3i>() { return "vec3i"; }
286 template<> inline const char* typeNameAsString<Vec3f>() { return "vec3s"; }
287 template<> inline const char* typeNameAsString<Vec3d>() { return "vec3d"; }
288 template<> inline const char* typeNameAsString<std::string>() { return "string"; }
289 template<> inline const char* typeNameAsString<Mat4s>() { return "mat4s"; }
290 template<> inline const char* typeNameAsString<Mat4d>() { return "mat4d"; }
291 template<> inline const char* typeNameAsString<PointIndex32>() { return "ptidx32"; }
292 template<> inline const char* typeNameAsString<PointIndex64>() { return "ptidx64"; }
293 template<> inline const char* typeNameAsString<PointDataIndex32>() { return "ptdataidx32"; }
294 template<> inline const char* typeNameAsString<PointDataIndex64>() { return "ptdataidx64"; }
295 
296 
298 
299 
311 template<typename AValueType, typename BValueType = AValueType>
313 {
314 public:
315  typedef AValueType AValueT;
316  typedef BValueType BValueT;
317 
319  : mAValPtr(NULL)
320  , mBValPtr(NULL)
321  , mResultValPtr(&mResultVal)
322  , mAIsActive(false)
323  , mBIsActive(false)
324  , mResultIsActive(false)
325  {
326  }
327 
329  CombineArgs(const AValueType& a, const BValueType& b, AValueType& result,
330  bool aOn = false, bool bOn = false)
331  : mAValPtr(&a)
332  , mBValPtr(&b)
333  , mResultValPtr(&result)
334  , mAIsActive(aOn)
335  , mBIsActive(bOn)
336  {
337  this->updateResultActive();
338  }
339 
341  CombineArgs(const AValueType& a, const BValueType& b, bool aOn = false, bool bOn = false)
342  : mAValPtr(&a)
343  , mBValPtr(&b)
344  , mResultValPtr(&mResultVal)
345  , mAIsActive(aOn)
346  , mBIsActive(bOn)
347  {
348  this->updateResultActive();
349  }
350 
352  const AValueType& a() const { return *mAValPtr; }
354  const BValueType& b() const { return *mBValPtr; }
356  const AValueType& result() const { return *mResultValPtr; }
358  AValueType& result() { return *mResultValPtr; }
360 
362  CombineArgs& setResult(const AValueType& val) { *mResultValPtr = val; return *this; }
363 
365  CombineArgs& setARef(const AValueType& a) { mAValPtr = &a; return *this; }
367  CombineArgs& setBRef(const BValueType& b) { mBValPtr = &b; return *this; }
369  CombineArgs& setResultRef(AValueType& val) { mResultValPtr = &val; return *this; }
370 
372  bool aIsActive() const { return mAIsActive; }
374  bool bIsActive() const { return mBIsActive; }
376  bool resultIsActive() const { return mResultIsActive; }
377 
379  CombineArgs& setAIsActive(bool b) { mAIsActive = b; updateResultActive(); return *this; }
381  CombineArgs& setBIsActive(bool b) { mBIsActive = b; updateResultActive(); return *this; }
383  CombineArgs& setResultIsActive(bool b) { mResultIsActive = b; return *this; }
384 
385 protected:
388  void updateResultActive() { mResultIsActive = mAIsActive || mBIsActive; }
389 
390  const AValueType* mAValPtr; // pointer to input value from A grid
391  const BValueType* mBValPtr; // pointer to input value from B grid
392  AValueType mResultVal; // computed output value (unused if stored externally)
393  AValueType* mResultValPtr; // pointer to either mResultVal or an external value
394  bool mAIsActive, mBIsActive; // active states of A and B values
395  bool mResultIsActive; // computed active state (default: A active || B active)
396 };
397 
398 
402 template<typename ValueType, typename CombineOp>
404 {
405  SwappedCombineOp(CombineOp& _op): op(_op) {}
406 
408  {
409  CombineArgs<ValueType> swappedArgs(args.b(), args.a(), args.result(),
410  args.bIsActive(), args.aIsActive());
411  op(swappedArgs);
412  }
413 
414  CombineOp& op;
415 };
416 
417 
419 
420 
435 
436 
437 // Dummy class that distinguishes shallow copy constructors from
438 // deep copy constructors
439 class ShallowCopy {};
440 // Dummy class that distinguishes topology copy constructors from
441 // deep copy constructors
442 class TopologyCopy {};
443 // Dummy class that distinguishes constructors during file input
444 class PartialCreate {};
445 
446 } // namespace OPENVDB_VERSION_NAME
447 } // namespace openvdb
448 
449 
450 #if defined(__ICC)
451 
452 // Use these defines to bracket a region of code that has safe static accesses.
453 // Keep the region as small as possible.
454 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
455 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
456 #define OPENVDB_START_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
457 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
458 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
459 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
460 
461 // Use these defines to bracket a region of code that has unsafe static accesses.
462 // Keep the region as small as possible.
463 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
464 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
465 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
466 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
467 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
468 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
469 
470 // Simpler version for one-line cases
471 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) \
472  __pragma(warning(disable:1710)); CODE; __pragma(warning(default:1710))
473 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) \
474  __pragma(warning(disable:1711)); CODE; __pragma(warning(default:1711))
475 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) \
476  __pragma(warning(disable:1712)); CODE; __pragma(warning(default:1712))
477 
478 #else // GCC does not support these compiler warnings
479 
480 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE
481 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE
482 #define OPENVDB_START_THREADSAFE_STATIC_WRITE
483 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE
484 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS
485 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS
486 
487 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE
488 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE
489 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE
490 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE
491 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS
492 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS
493 
494 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) CODE
495 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) CODE
496 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) CODE
497 
498 #endif // defined(__ICC)
499 
500 #endif // OPENVDB_TYPES_HAS_BEEN_INCLUDED
501 
502 // Copyright (c) 2012-2016 DreamWorks Animation LLC
503 // All rights reserved. This software is distributed under the
504 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
Definition: Types.h:434
Definition: Types.h:439
math::Mat4< Real > Mat4R
Definition: Types.h:101
AValueType AValueT
Definition: Types.h:315
Vec3< float > Vec3s
Definition: Vec3.h:650
const char * typeNameAsString< ValueMask >()
Definition: Types.h:276
GridClass
Definition: Types.h:211
math::Mat4< double > Mat4d
Definition: Types.h:102
const char * typeNameAsString< Vec2i >()
Definition: Types.h:282
Definition: Types.h:214
CombineArgs & setAIsActive(bool b)
Set the active state of the A value.
Definition: Types.h:379
math::Vec4< Index32 > Vec4I
Definition: Types.h:90
const char * typeNameAsString< Mat4d >()
Definition: Types.h:290
Vec2< int32_t > Vec2i
Definition: Vec2.h:540
Definition: Types.h:217
Vec2< double > Vec2d
Definition: Vec2.h:543
int64_t Int64
Definition: Types.h:61
CombineArgs & setResult(const AValueType &val)
Set the output value.
Definition: Types.h:362
Vec4< int32_t > Vec4i
Definition: Vec4.h:581
Definition: Types.h:442
const char * typeNameAsString< int32_t >()
Definition: Types.h:279
const char * typeNameAsString< double >()
Definition: Types.h:278
T ElementType
Definition: Types.h:151
AValueType & result()
Get the output value.
Definition: Types.h:358
bool aIsActive() const
Definition: Types.h:372
bool bIsActive() const
Definition: Types.h:374
const AValueType * mAValPtr
Definition: Types.h:390
VecType
Definition: Types.h:241
Definition: Mat.h:145
math::BBox< Vec3d > BBoxd
Definition: Types.h:86
Definition: Types.h:148
Definition: Types.h:212
static const Real LEVEL_SET_HALF_WIDTH
Definition: Types.h:219
CombineArgs & setARef(const AValueType &a)
Redirect the A value to a new external source.
Definition: Types.h:365
PointIndex< Index64, 1 > PointDataIndex64
Definition: Types.h:142
math::Quat< Real > QuatR
Definition: Types.h:106
PointIndex operator+(T x)
Needed to support the (zeroVal<PointIndex>() + val) idiom.
Definition: Types.h:131
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:47
PointIndex(IntType i=IntType(0))
Definition: Types.h:125
PointIndex< Index32, 0 > PointIndex32
Definition: Types.h:138
Definition: Types.h:403
math::Vec4< Real > Vec4R
Definition: Types.h:89
Vec4< double > Vec4d
Definition: Vec4.h:584
bool mBIsActive
Definition: Types.h:394
const char * typeNameAsString()
Definition: Types.h:274
const BValueType * mBValPtr
Definition: Types.h:391
const char * typeNameAsString< PointIndex32 >()
Definition: Types.h:291
CombineArgs & setResultRef(AValueType &val)
Redirect the result value to a new external destination.
Definition: Types.h:369
const char * typeNameAsString< int64_t >()
Definition: Types.h:281
Vec3< int32_t > Vec3i
Definition: Vec3.h:648
void operator()(CombineArgs< ValueType > &args)
Definition: Types.h:407
double Real
Definition: Types.h:64
const char * typeNameAsString< Vec3i >()
Definition: Types.h:285
Index32 Index
Definition: Types.h:58
math::Vec4< float > Vec4f
Definition: Types.h:91
int32_t Int32
Definition: Types.h:60
uint64_t Index64
Definition: Types.h:57
const char * typeNameAsString< PointIndex64 >()
Definition: Types.h:292
int16_t Int16
Definition: Types.h:59
#define OPENVDB_VERSION_NAME
Definition: version.h:43
Vec3< double > Vec3d
Definition: Vec3.h:651
const AValueType & result() const
Get the output value.
Definition: Types.h:357
math::Vec3< half > Vec3H
Definition: Types.h:79
CombineArgs(const AValueType &a, const BValueType &b, bool aOn=false, bool bOn=false)
Use this constructor when the result value should be stored in this struct.
Definition: Types.h:341
Definition: Types.h:242
const char * typeNameAsString< bool >()
Definition: Types.h:275
math::Vec3< Index32 > Vec3I
Definition: Types.h:77
Vec4< float > Vec4s
Definition: Vec4.h:583
CopyPolicy
Definition: Types.h:434
MergePolicy
Definition: Types.h:264
const char * typeNameAsString< Vec2s >()
Definition: Types.h:283
Definition: Types.h:434
const char * typeNameAsString< Vec3d >()
Definition: Types.h:287
CanConvertType<FromType, ToType>::value is true if a value of type ToType can be constructed from a v...
Definition: Types.h:183
Definition: Exceptions.h:39
const char * typeNameAsString< PointDataIndex32 >()
Definition: Types.h:293
uint32_t Index32
Definition: Types.h:56
SwappedCombineOp(CombineOp &_op)
Definition: Types.h:405
3x3 matrix class.
Definition: Mat3.h:54
CombineArgs & setBIsActive(bool b)
Set the active state of the B value.
Definition: Types.h:381
Definition: Types.h:243
const char * typeNameAsString< uint32_t >()
Definition: Types.h:280
CombineArgs()
Definition: Types.h:318
math::Vec2< float > Vec2f
Definition: Types.h:69
math::Vec4< half > Vec4H
Definition: Types.h:92
math::Mat3< Real > Mat3R
Definition: Types.h:98
PointIndex< Index32, 1 > PointDataIndex32
Definition: Types.h:141
Definition: Vec2.h:48
const char * typeNameAsString< PointDataIndex64 >()
Definition: Types.h:294
CombineArgs(const AValueType &a, const BValueType &b, AValueType &result, bool aOn=false, bool bOn=false)
Use this constructor when the result value is stored externally.
Definition: Types.h:329
const AValueType & a() const
Get the A input value.
Definition: Types.h:352
Definition: Types.h:215
const char * typeNameAsString< Mat4s >()
Definition: Types.h:289
const BValueType & b() const
Get the B input value.
Definition: Types.h:354
AValueType mResultVal
Definition: Types.h:392
CombineArgs & setBRef(const BValueType &b)
Redirect the B value to a new external source.
Definition: Types.h:367
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:259
const char * typeNameAsString< Vec2d >()
Definition: Types.h:284
Definition: Types.h:248
bool mResultIsActive
Definition: Types.h:395
const char * typeNameAsString< float >()
Definition: Types.h:277
Integer wrapper, required to distinguish PointIndexGrid and PointDataGrid from Int32Grid and Int64Gri...
Definition: Types.h:119
PointIndex< Index64, 0 > PointIndex64
Definition: Types.h:139
unsigned char Byte
Definition: Types.h:63
math::Vec3< Real > Vec3R
Definition: Types.h:76
math::Vec2< Index32 > Vec2I
Definition: Types.h:68
math::Vec3< float > Vec3f
Definition: Types.h:78
BValueType BValueT
Definition: Types.h:316
AValueType * mResultValPtr
Definition: Types.h:393
CombineOp & op
Definition: Types.h:414
void updateResultActive()
Definition: Types.h:388
Definition: Types.h:213
math::Mat4< float > Mat4s
Definition: Types.h:103
Definition: Types.h:444
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:71
Vec2< float > Vec2s
Definition: Vec2.h:542
const char * typeNameAsString< Vec3f >()
Definition: Types.h:286
math::Vec2< Real > Vec2R
Definition: Types.h:67
Definition: Types.h:109
Definition: Types.h:266
CombineArgs & setResultIsActive(bool b)
Set the active state of the output value.
Definition: Types.h:383
Definition: Types.h:434
math::Vec2< half > Vec2H
Definition: Types.h:70
Int32 Int
Definition: Types.h:62
This struct collects both input and output arguments to "grid combiner" functors used with the tree::...
Definition: Types.h:312
bool resultIsActive() const
Definition: Types.h:376
Definition: Mat4.h:51
IntType_ IntType
Definition: Types.h:123