OpenVDB  3.1.0
Types.h
Go to the documentation of this file.
1 //
3 // Copyright (c) 2012-2015 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 
110 
111 
115 template<typename IntType_, Index Kind>
117 {
118  BOOST_STATIC_ASSERT(boost::is_integral<IntType_>::value);
119 
120  typedef IntType_ IntType;
121 
122  PointIndex(IntType i = IntType(0)): mIndex(i) {}
123 
124  operator IntType() const { return mIndex; }
125 
127  template<typename T>
128  PointIndex operator+(T x) { return PointIndex(mIndex + IntType(x)); }
129 
130 private:
131  IntType mIndex;
132 };
133 
134 
137 
140 
141 
143 
144 
145 template<typename T> struct VecTraits {
146  static const bool IsVec = false;
147  static const int Size = 1;
148  typedef T ElementType;
149 };
150 template<typename T> struct VecTraits<math::Vec2<T> > {
151  static const bool IsVec = true;
152  static const int Size = 2;
153  typedef T ElementType;
154 };
155 template<typename T> struct VecTraits<math::Vec3<T> > {
156  static const bool IsVec = true;
157  static const int Size = 3;
158  typedef T ElementType;
159 };
160 template<typename T> struct VecTraits<math::Vec4<T> > {
161  static const bool IsVec = true;
162  static const int Size = 4;
163  typedef T ElementType;
164 };
165 
166 
168 
169 
179 template<typename FromType, typename ToType>
180 struct CanConvertType { enum { value = boost::is_convertible<FromType, ToType>::value }; };
181 
182 // Specializations for vector types, which can be constructed from values
183 // of their own ValueTypes (or values that can be converted to their ValueTypes),
184 // but only explicitly
185 template<typename T> struct CanConvertType<T, math::Vec2<T> > { enum { value = true }; };
186 template<typename T> struct CanConvertType<T, math::Vec3<T> > { enum { value = true }; };
187 template<typename T> struct CanConvertType<T, math::Vec4<T> > { enum { value = true }; };
188 template<typename T> struct CanConvertType<math::Vec2<T>, math::Vec2<T> > { enum {value = true}; };
189 template<typename T> struct CanConvertType<math::Vec3<T>, math::Vec3<T> > { enum {value = true}; };
190 template<typename T> struct CanConvertType<math::Vec4<T>, math::Vec4<T> > { enum {value = true}; };
191 template<typename T0, typename T1>
192 struct CanConvertType<T0, math::Vec2<T1> > { enum { value = CanConvertType<T0, T1>::value }; };
193 template<typename T0, typename T1>
194 struct CanConvertType<T0, math::Vec3<T1> > { enum { value = CanConvertType<T0, T1>::value }; };
195 template<typename T0, typename T1>
196 struct CanConvertType<T0, math::Vec4<T1> > { enum { value = CanConvertType<T0, T1>::value }; };
197 template<> struct CanConvertType<PointIndex32, PointDataIndex32> { enum {value = true}; };
198 template<> struct CanConvertType<PointDataIndex32, PointIndex32> { enum {value = true}; };
199 
201 
202 
203 // Add new items to the *end* of this list, and update NUM_GRID_CLASSES.
204 enum GridClass {
209 };
211 
212 static const Real LEVEL_SET_HALF_WIDTH = 3;
213 
234 enum VecType {
240 };
242 
243 
261 };
262 
263 
265 
266 
267 template<typename T> const char* typeNameAsString() { return typeid(T).name(); }
268 template<> inline const char* typeNameAsString<bool>() { return "bool"; }
269 template<> inline const char* typeNameAsString<float>() { return "float"; }
270 template<> inline const char* typeNameAsString<double>() { return "double"; }
271 template<> inline const char* typeNameAsString<int32_t>() { return "int32"; }
272 template<> inline const char* typeNameAsString<uint32_t>() { return "uint32"; }
273 template<> inline const char* typeNameAsString<int64_t>() { return "int64"; }
274 template<> inline const char* typeNameAsString<Vec2i>() { return "vec2i"; }
275 template<> inline const char* typeNameAsString<Vec2s>() { return "vec2s"; }
276 template<> inline const char* typeNameAsString<Vec2d>() { return "vec2d"; }
277 template<> inline const char* typeNameAsString<Vec3i>() { return "vec3i"; }
278 template<> inline const char* typeNameAsString<Vec3f>() { return "vec3s"; }
279 template<> inline const char* typeNameAsString<Vec3d>() { return "vec3d"; }
280 template<> inline const char* typeNameAsString<std::string>() { return "string"; }
281 template<> inline const char* typeNameAsString<Mat4s>() { return "mat4s"; }
282 template<> inline const char* typeNameAsString<Mat4d>() { return "mat4d"; }
283 template<> inline const char* typeNameAsString<PointIndex32>() { return "ptidx32"; }
284 template<> inline const char* typeNameAsString<PointIndex64>() { return "ptidx64"; }
285 template<> inline const char* typeNameAsString<PointDataIndex32>() { return "ptdataidx32"; }
286 template<> inline const char* typeNameAsString<PointDataIndex64>() { return "ptdataidx64"; }
287 
288 
290 
291 
303 template<typename AValueType, typename BValueType = AValueType>
305 {
306 public:
307  typedef AValueType AValueT;
308  typedef BValueType BValueT;
309 
311  mAValPtr(NULL), mBValPtr(NULL), mResultValPtr(&mResultVal),
312  mAIsActive(false), mBIsActive(false), mResultIsActive(false)
313  {}
314 
316  CombineArgs(const AValueType& a, const BValueType& b, AValueType& result,
317  bool aOn = false, bool bOn = false):
318  mAValPtr(&a), mBValPtr(&b), mResultValPtr(&result),
319  mAIsActive(aOn), mBIsActive(bOn)
320  { updateResultActive(); }
321 
323  CombineArgs(const AValueType& a, const BValueType& b, bool aOn = false, bool bOn = false):
324  mAValPtr(&a), mBValPtr(&b), mResultValPtr(&mResultVal),
325  mAIsActive(aOn), mBIsActive(bOn)
326  { updateResultActive(); }
327 
329  const AValueType& a() const { return *mAValPtr; }
331  const BValueType& b() const { return *mBValPtr; }
333  const AValueType& result() const { return *mResultValPtr; }
335  AValueType& result() { return *mResultValPtr; }
337 
339  CombineArgs& setResult(const AValueType& val) { *mResultValPtr = val; return *this; }
340 
342  CombineArgs& setARef(const AValueType& a) { mAValPtr = &a; return *this; }
344  CombineArgs& setBRef(const BValueType& b) { mBValPtr = &b; return *this; }
346  CombineArgs& setResultRef(AValueType& val) { mResultValPtr = &val; return *this; }
347 
349  bool aIsActive() const { return mAIsActive; }
351  bool bIsActive() const { return mBIsActive; }
353  bool resultIsActive() const { return mResultIsActive; }
354 
356  CombineArgs& setAIsActive(bool b) { mAIsActive = b; updateResultActive(); return *this; }
358  CombineArgs& setBIsActive(bool b) { mBIsActive = b; updateResultActive(); return *this; }
360  CombineArgs& setResultIsActive(bool b) { mResultIsActive = b; return *this; }
361 
362 protected:
365  void updateResultActive() { mResultIsActive = mAIsActive || mBIsActive; }
366 
367  const AValueType* mAValPtr; // pointer to input value from A grid
368  const BValueType* mBValPtr; // pointer to input value from B grid
369  AValueType mResultVal; // computed output value (unused if stored externally)
370  AValueType* mResultValPtr; // pointer to either mResultVal or an external value
371  bool mAIsActive, mBIsActive; // active states of A and B values
372  bool mResultIsActive; // computed active state (default: A active || B active)
373 };
374 
375 
379 template<typename ValueType, typename CombineOp>
381 {
382  SwappedCombineOp(CombineOp& _op): op(_op) {}
383 
385  {
386  CombineArgs<ValueType> swappedArgs(args.b(), args.a(), args.result(),
387  args.bIsActive(), args.aIsActive());
388  op(swappedArgs);
389  }
390 
391  CombineOp& op;
392 };
393 
394 
396 
397 
412 
413 
414 // Dummy class that distinguishes shallow copy constructors from
415 // deep copy constructors
416 class ShallowCopy {};
417 // Dummy class that distinguishes topology copy constructors from
418 // deep copy constructors
419 class TopologyCopy {};
420 // Dummy class that distinguishes constructors during file input
421 class PartialCreate {};
422 
423 } // namespace OPENVDB_VERSION_NAME
424 } // namespace openvdb
425 
426 
427 #if defined(__ICC)
428 
429 // Use these defines to bracket a region of code that has safe static accesses.
430 // Keep the region as small as possible.
431 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
432 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
433 #define OPENVDB_START_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
434 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
435 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
436 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
437 
438 // Use these defines to bracket a region of code that has unsafe static accesses.
439 // Keep the region as small as possible.
440 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
441 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
442 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
443 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
444 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
445 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
446 
447 // Simpler version for one-line cases
448 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) \
449  __pragma(warning(disable:1710)); CODE; __pragma(warning(default:1710))
450 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) \
451  __pragma(warning(disable:1711)); CODE; __pragma(warning(default:1711))
452 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) \
453  __pragma(warning(disable:1712)); CODE; __pragma(warning(default:1712))
454 
455 #else // GCC does not support these compiler warnings
456 
457 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE
458 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE
459 #define OPENVDB_START_THREADSAFE_STATIC_WRITE
460 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE
461 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS
462 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS
463 
464 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE
465 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE
466 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE
467 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE
468 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS
469 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS
470 
471 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) CODE
472 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) CODE
473 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) CODE
474 
475 #endif // defined(__ICC)
476 
477 #endif // OPENVDB_TYPES_HAS_BEEN_INCLUDED
478 
479 // Copyright (c) 2012-2015 DreamWorks Animation LLC
480 // All rights reserved. This software is distributed under the
481 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
AValueType & result()
Get the output value.
Definition: Types.h:335
Definition: Vec2.h:48
3x3 matrix class.
Definition: Mat3.h:54
Index32 Index
Definition: Types.h:58
const char * typeNameAsString< Mat4d >()
Definition: Types.h:282
const BValueType & b() const
Get the B input value.
Definition: Types.h:331
math::Vec4< float > Vec4f
Definition: Types.h:91
Definition: Types.h:411
PointIndex< Index64, 0 > PointIndex64
Definition: Types.h:136
CombineArgs & setBRef(const BValueType &b)
Redirect the B value to a new external source.
Definition: Types.h:344
unsigned char Byte
Definition: Types.h:63
PointIndex(IntType i=IntType(0))
Definition: Types.h:122
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
const char * typeNameAsString< Vec3i >()
Definition: Types.h:277
T ElementType
Definition: Types.h:148
PointIndex operator+(T x)
Needed to support the (zeroVal() + val) idiom.
Definition: Types.h:128
Vec4< double > Vec4d
Definition: Vec4.h:576
const char * typeNameAsString< Vec2i >()
Definition: Types.h:274
bool resultIsActive() const
Definition: Types.h:353
math::Vec3< Real > Vec3R
Definition: Types.h:76
const char * typeNameAsString< uint32_t >()
Definition: Types.h:272
math::Vec3< float > Vec3f
Definition: Types.h:78
MergePolicy
Definition: Types.h:257
math::Vec2< half > Vec2H
Definition: Types.h:70
Vec4< int32_t > Vec4i
Definition: Vec4.h:573
const char * typeNameAsString< float >()
Definition: Types.h:269
uint32_t Index32
Definition: Types.h:56
Definition: Types.h:145
Definition: Types.h:205
math::Vec2< float > Vec2f
Definition: Types.h:69
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:47
math::Vec2< Real > Vec2R
Definition: Types.h:67
Vec2< int32_t > Vec2i
Definition: Vec2.h:532
math::Vec4< half > Vec4H
Definition: Types.h:92
math::Mat4< Real > Mat4R
Definition: Types.h:101
Definition: Types.h:207
CombineArgs()
Definition: Types.h:310
bool bIsActive() const
Definition: Types.h:351
Definition: Mat4.h:51
Definition: Types.h:210
Vec3< int32_t > Vec3i
Definition: Vec3.h:640
const char * typeNameAsString< PointDataIndex32 >()
Definition: Types.h:285
AValueType AValueT
Definition: Types.h:307
AValueType * mResultValPtr
Definition: Types.h:370
Integer wrapper, required to distinguish PointIndexGrid and PointDataGrid from Int32Grid and Int64Gri...
Definition: Types.h:116
int64_t Int64
Definition: Types.h:61
const AValueType & a() const
Get the A input value.
Definition: Types.h:329
GridClass
Definition: Types.h:204
math::Mat4< double > Mat4d
Definition: Types.h:102
Definition: Types.h:235
void operator()(CombineArgs< ValueType > &args)
Definition: Types.h:384
math::BBox< Vec3d > BBoxd
Definition: Types.h:86
const char * typeNameAsString< PointIndex32 >()
Definition: Types.h:283
#define OPENVDB_VERSION_NAME
Definition: version.h:43
math::Vec2< Index32 > Vec2I
Definition: Types.h:68
CombineArgs & setResultRef(AValueType &val)
Redirect the result value to a new external destination.
Definition: Types.h:346
math::Quat< Real > QuatR
Definition: Types.h:106
const char * typeNameAsString< Vec3d >()
Definition: Types.h:279
const char * typeNameAsString< int32_t >()
Definition: Types.h:271
math::Mat4< float > Mat4s
Definition: Types.h:103
const char * typeNameAsString< PointIndex64 >()
Definition: Types.h:284
CombineArgs & setARef(const AValueType &a)
Redirect the A value to a new external source.
Definition: Types.h:342
VecType
Definition: Types.h:234
const BValueType * mBValPtr
Definition: Types.h:368
SwappedCombineOp(CombineOp &_op)
Definition: Types.h:382
Vec4< float > Vec4s
Definition: Vec4.h:575
Definition: Types.h:241
Definition: Exceptions.h:39
const AValueType * mAValPtr
Definition: Types.h:367
Definition: Types.h:419
Definition: Types.h:411
const char * typeNameAsString< Vec2d >()
Definition: Types.h:276
CombineArgs & setResult(const AValueType &val)
Set the output value.
Definition: Types.h:339
CombineArgs & setResultIsActive(bool b)
Set the active state of the output value.
Definition: Types.h:360
const char * typeNameAsString< Mat4s >()
Definition: Types.h:281
Definition: Types.h:380
Vec3< double > Vec3d
Definition: Vec3.h:643
Definition: Types.h:206
bool mResultIsActive
Definition: Types.h:372
Int32 Int
Definition: Types.h:62
const AValueType & result() const
Get the output value.
Definition: Types.h:334
Definition: Types.h:259
BValueType BValueT
Definition: Types.h:308
bool mBIsActive
Definition: Types.h:371
CombineArgs & setBIsActive(bool b)
Set the active state of the B value.
Definition: Types.h:358
const char * typeNameAsString< bool >()
Definition: Types.h:268
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:316
Definition: Mat.h:145
double Real
Definition: Types.h:64
math::Vec3< half > Vec3H
Definition: Types.h:79
This struct collects both input and output arguments to "grid combiner" functors used with the tree::...
Definition: Types.h:304
CombineArgs & setAIsActive(bool b)
Set the active state of the A value.
Definition: Types.h:356
int32_t Int32
Definition: Types.h:60
uint64_t Index64
Definition: Types.h:57
const char * typeNameAsString< Vec2s >()
Definition: Types.h:275
math::Vec3< Index32 > Vec3I
Definition: Types.h:77
CopyPolicy
Definition: Types.h:411
Definition: Types.h:416
int16_t Int16
Definition: Types.h:59
void updateResultActive()
Definition: Types.h:365
math::Vec4< Index32 > Vec4I
Definition: Types.h:90
const char * typeNameAsString< PointDataIndex64 >()
Definition: Types.h:286
Definition: Types.h:236
const char * typeNameAsString< int64_t >()
Definition: Types.h:273
const char * typeNameAsString()
Definition: Types.h:267
bool aIsActive() const
Definition: Types.h:349
CanConvertType::value is true if a value of type ToType can be constructed from a v...
Definition: Types.h:180
Vec2< float > Vec2s
Definition: Vec2.h:534
PointIndex< Index64, 1 > PointDataIndex64
Definition: Types.h:139
Definition: Types.h:421
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:71
AValueType mResultVal
Definition: Types.h:369
const char * typeNameAsString< Vec3f >()
Definition: Types.h:278
const char * typeNameAsString< double >()
Definition: Types.h:270
Vec3< float > Vec3s
Definition: Vec3.h:642
PointIndex< Index32, 0 > PointIndex32
Definition: Types.h:135
math::Vec4< Real > Vec4R
Definition: Types.h:89
IntType_ IntType
Definition: Types.h:120
Definition: Types.h:208
static const Real LEVEL_SET_HALF_WIDTH
Definition: Types.h:212
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:252
Vec2< double > Vec2d
Definition: Vec2.h:535
CombineOp & op
Definition: Types.h:391
Definition: Types.h:411
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:323
math::Mat3< Real > Mat3R
Definition: Types.h:98
PointIndex< Index32, 1 > PointDataIndex32
Definition: Types.h:138