OpenVDB  1.1.0
Types.h
Go to the documentation of this file.
1 
2 //
3 // Copyright (c) 2012-2013 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 <openvdb/math/Hermite.h>
47 
48 
49 namespace openvdb {
51 namespace OPENVDB_VERSION_NAME {
52 
53 // One-dimensional scalar types
54 typedef uint32_t Uint;
55 typedef uint32_t Index32;
56 typedef uint64_t Index64;
57 typedef Index32 Index;
58 typedef int16_t Int16;
59 typedef int32_t Int32;
60 typedef int64_t Int64;
61 typedef Int32 Int;
62 typedef unsigned char Byte;
63 typedef double Real;
64 
65 // Two-dimensional vector types
72 
73 // Three-dimensional vector types
81 
85 
86 // Four-dimensional vector types
94 
95 // Three-dimensional matrix types
97 
98 // Four-dimensional matrix types
102 
103 // Compressed Hermite data
105 
106 // Quaternions
108 
109 
111 
112 
113 template<typename T> struct VecTraits { static const bool IsVec = false; };
114 template<typename T> struct VecTraits<math::Vec2<T> > { static const bool IsVec = true; };
115 template<typename T> struct VecTraits<math::Vec3<T> > { static const bool IsVec = true; };
116 template<typename T> struct VecTraits<math::Vec4<T> > { static const bool IsVec = true; };
117 
118 
120 
121 
122 // Add new items to the *end* of this list, and update NUM_GRID_CLASSES.
123 enum GridClass {
128 };
130 
131 static const Real LEVEL_SET_HALF_WIDTH = 3;
132 
153 enum VecType {
159 };
161 
162 
164 
165 
166 template<typename T> const char* typeNameAsString() { return typeid(T).name(); }
167 template<> inline const char* typeNameAsString<bool>() { return "bool"; }
168 template<> inline const char* typeNameAsString<float>() { return "float"; }
169 template<> inline const char* typeNameAsString<double>() { return "double"; }
170 template<> inline const char* typeNameAsString<int32_t>() { return "int32"; }
171 template<> inline const char* typeNameAsString<uint32_t>() { return "uint32"; }
172 template<> inline const char* typeNameAsString<int64_t>() { return "int64"; }
173 template<> inline const char* typeNameAsString<Hermite>() { return "Hermite"; }
174 template<> inline const char* typeNameAsString<Vec2i>() { return "vec2i"; }
175 template<> inline const char* typeNameAsString<Vec2s>() { return "vec2s"; }
176 template<> inline const char* typeNameAsString<Vec2d>() { return "vec2d"; }
177 template<> inline const char* typeNameAsString<Vec3i>() { return "vec3i"; }
178 template<> inline const char* typeNameAsString<Vec3f>() { return "vec3s"; }
179 template<> inline const char* typeNameAsString<Vec3d>() { return "vec3d"; }
180 template<> inline const char* typeNameAsString<std::string>() { return "string"; }
181 template<> inline const char* typeNameAsString<Mat4s>() { return "mat4s"; }
182 template<> inline const char* typeNameAsString<Mat4d>() { return "mat4d"; }
183 
184 
186 
187 
199 template<typename ValueType>
201 {
202 public:
203  typedef ValueType ValueT;
204 
206  mAValPtr(NULL), mBValPtr(NULL), mResultValPtr(&mResultVal),
207  mAIsActive(false), mBIsActive(false), mResultIsActive(false)
208  {}
209 
211  CombineArgs(const ValueType& a, const ValueType& b, ValueType& result,
212  bool aOn = false, bool bOn = false):
213  mAValPtr(&a), mBValPtr(&b), mResultValPtr(&result),
214  mAIsActive(aOn), mBIsActive(bOn)
215  { updateResultActive(); }
216 
218  CombineArgs(const ValueType& a, const ValueType& b, bool aOn = false, bool bOn = false):
219  mAValPtr(&a), mBValPtr(&b), mResultValPtr(&mResultVal),
220  mAIsActive(aOn), mBIsActive(bOn)
221  { updateResultActive(); }
222 
224  const ValueType& a() const { return *mAValPtr; }
226  const ValueType& b() const { return *mBValPtr; }
228 
229  const ValueType& result() const { return *mResultValPtr; }
230  ValueType& result() { return *mResultValPtr; }
232 
234  CombineArgs& setResult(const ValueType& val) { *mResultValPtr = val; return *this; }
235 
237  CombineArgs& setARef(const ValueType& a) { mAValPtr = &a; return *this; }
239  CombineArgs& setBRef(const ValueType& b) { mBValPtr = &b; return *this; }
241  CombineArgs& setResultRef(ValueType& val) { mResultValPtr = &val; return *this; }
242 
244  bool aIsActive() const { return mAIsActive; }
246  bool bIsActive() const { return mBIsActive; }
248  bool resultIsActive() const { return mResultIsActive; }
249 
251  CombineArgs& setAIsActive(bool b) { mAIsActive = b; updateResultActive(); return *this; }
253  CombineArgs& setBIsActive(bool b) { mBIsActive = b; updateResultActive(); return *this; }
255  CombineArgs& setResultIsActive(bool b) { mResultIsActive = b; return *this; }
256 
257 protected:
260  void updateResultActive() { mResultIsActive = mAIsActive || mBIsActive; }
261 
262  const ValueType* mAValPtr; // pointer to input value from A grid
263  const ValueType* mBValPtr; // pointer to input value from B grid
264  ValueType mResultVal; // computed output value (unused if stored externally)
265  ValueType* mResultValPtr; // pointer to either mResultVal or an external value
266  bool mAIsActive, mBIsActive; // active states of A and B values
267  bool mResultIsActive; // computed active state (default: A active || B active)
268 };
269 
270 
274 template<typename ValueType, typename CombineOp>
276 {
277  SwappedCombineOp(CombineOp& op): op(op) {}
278 
279  void operator()(CombineArgs<ValueType>& args)
280  {
281  CombineArgs<ValueType> swappedArgs(args.b(), args.a(), args.result(),
282  args.bIsActive(), args.aIsActive());
283  op(swappedArgs);
284  }
285 
286  CombineOp& op;
287 };
288 
289 
291 
292 
307 
308 
309 // Dummy class that distinguishes shallow copy constructors from
310 // deep copy constructors
311 class ShallowCopy {};
312 // Dummy class that distinguishes topology copy constructors from
313 // deep copy constructors
314 class TopologyCopy {};
315 
316 } // namespace OPENVDB_VERSION_NAME
317 } // namespace openvdb
318 
319 
320 #if defined(__ICC)
321 
322 // Use these defines to bracket a region of code that has safe static accesses.
323 // Keep the region as small as possible.
324 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
325 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
326 #define OPENVDB_START_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
327 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
328 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
329 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
330 
331 // Use these defines to bracket a region of code that has unsafe static accesses.
332 // Keep the region as small as possible.
333 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
334 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
335 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
336 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
337 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
338 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
339 
340 // Simpler version for one-line cases
341 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) \
342  __pragma(warning(disable:1710)); CODE; __pragma(warning(default:1710))
343 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) \
344  __pragma(warning(disable:1711)); CODE; __pragma(warning(default:1711))
345 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) \
346  __pragma(warning(disable:1712)); CODE; __pragma(warning(default:1712))
347 
348 #else // GCC does not support these compiler warnings
349 
350 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE
351 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE
352 #define OPENVDB_START_THREADSAFE_STATIC_WRITE
353 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE
354 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS
355 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS
356 
357 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE
358 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE
359 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE
360 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE
361 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS
362 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS
363 
364 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) CODE
365 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) CODE
366 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) CODE
367 
368 #endif // defined(__ICC)
369 
370 #endif // OPENVDB_TYPES_HAS_BEEN_INCLUDED
371 
372 // Copyright (c) 2012-2013 DreamWorks Animation LLC
373 // All rights reserved. This software is distributed under the
374 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )