OpenVDB  0.104.0
Types.h
Go to the documentation of this file.
1 
2 //
3 // Copyright (c) 2012 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 //Deprecated
166 /*
167 class ValueProbe
168 {
169 public:
170  void setState(bool) {;}//noop
171  bool getState() const {return false;}//dummy
172  void setLevel(int) {;}//noop
173  int getLevel() const {return 0;}//dummy
174 };
175 
176 class StateProbe
177 {
178 private:
179  bool mState;
180 public:
181  void setState(bool state) {mState = state;}
182  bool getState() const {return mState;}
183  void setLevel(int) {;}//noop
184  int getLevel() const {return 0;}//dummy
185 };
186 
187 class LevelProbe
188 {
189 private:
190  int mLevel;
191 public:
192  void setLevel(int level) {mLevel=level;}
193  int getLevel() const {return mLevel;}
194  void setState(bool) {;}//noop
195  bool getState() const {return false;}//dummy
196 };
197 
198 class StateLevelProbe
199 {
200 private:
201  bool mState;
202  int mLevel;
203 public:
204  void setLevel(int level) {mLevel=level;}
205  int getLevel() const {return mLevel;}
206  void setState(bool state) {mState = state;}
207  bool getState() const {return mState;}
208 };
209 */
210 
212 
213 
214 template<typename T> const char* typeNameAsString() { return typeid(T).name(); }
215 template<> inline const char* typeNameAsString<bool>() { return "bool"; }
216 template<> inline const char* typeNameAsString<float>() { return "float"; }
217 template<> inline const char* typeNameAsString<double>() { return "double"; }
218 template<> inline const char* typeNameAsString<int32_t>() { return "int32"; }
219 template<> inline const char* typeNameAsString<uint32_t>() { return "uint32"; }
220 template<> inline const char* typeNameAsString<int64_t>() { return "int64"; }
221 template<> inline const char* typeNameAsString<Hermite>() { return "Hermite"; }
222 template<> inline const char* typeNameAsString<Vec2i>() { return "vec2i"; }
223 template<> inline const char* typeNameAsString<Vec2s>() { return "vec2s"; }
224 template<> inline const char* typeNameAsString<Vec2d>() { return "vec2d"; }
225 template<> inline const char* typeNameAsString<Vec3i>() { return "vec3i"; }
226 template<> inline const char* typeNameAsString<Vec3f>() { return "vec3s"; }
227 template<> inline const char* typeNameAsString<Vec3d>() { return "vec3d"; }
228 template<> inline const char* typeNameAsString<std::string>() { return "string"; }
229 template<> inline const char* typeNameAsString<Mat4s>() { return "mat4s"; }
230 template<> inline const char* typeNameAsString<Mat4d>() { return "mat4d"; }
231 
232 
234 
235 
247 template<typename ValueType>
249 {
250 public:
251  typedef ValueType ValueT;
252 
254  mAValPtr(NULL), mBValPtr(NULL), mResultValPtr(&mResultVal),
255  mAIsActive(false), mBIsActive(false), mResultIsActive(false)
256  {}
257 
259  CombineArgs(const ValueType& a, const ValueType& b, ValueType& result,
260  bool aOn = false, bool bOn = false):
261  mAValPtr(&a), mBValPtr(&b), mResultValPtr(&result),
262  mAIsActive(aOn), mBIsActive(bOn)
263  { updateResultActive(); }
264 
266  CombineArgs(const ValueType& a, const ValueType& b, bool aOn = false, bool bOn = false):
267  mAValPtr(&a), mBValPtr(&b), mResultValPtr(&mResultVal),
268  mAIsActive(aOn), mBIsActive(bOn)
269  { updateResultActive(); }
270 
272  const ValueType& a() const { return *mAValPtr; }
274  const ValueType& b() const { return *mBValPtr; }
276 
277  const ValueType& result() const { return *mResultValPtr; }
278  ValueType& result() { return *mResultValPtr; }
280 
282  CombineArgs& setResult(const ValueType& val) { *mResultValPtr = val; return *this; }
283 
285  CombineArgs& setARef(const ValueType& a) { mAValPtr = &a; return *this; }
287  CombineArgs& setBRef(const ValueType& b) { mBValPtr = &b; return *this; }
289  CombineArgs& setResultRef(ValueType& val) { mResultValPtr = &val; return *this; }
290 
292  bool aIsActive() const { return mAIsActive; }
294  bool bIsActive() const { return mBIsActive; }
296  bool resultIsActive() const { return mResultIsActive; }
297 
299  CombineArgs& setAIsActive(bool b) { mAIsActive = b; updateResultActive(); return *this; }
301  CombineArgs& setBIsActive(bool b) { mBIsActive = b; updateResultActive(); return *this; }
303  CombineArgs& setResultIsActive(bool b) { mResultIsActive = b; return *this; }
304 
305 protected:
308  void updateResultActive() { mResultIsActive = mAIsActive || mBIsActive; }
309 
310  const ValueType* mAValPtr; // pointer to input value from A grid
311  const ValueType* mBValPtr; // pointer to input value from B grid
312  ValueType mResultVal; // computed output value (unused if stored externally)
313  ValueType* mResultValPtr; // pointer to either mResultVal or an external value
314  bool mAIsActive, mBIsActive; // active states of A and B values
315  bool mResultIsActive; // computed active state (default: A active || B active)
316 };
317 
318 
322 template<typename ValueType, typename CombineOp>
324 {
325  SwappedCombineOp(CombineOp& op): op(op) {}
326 
327  void operator()(CombineArgs<ValueType>& args)
328  {
329  CombineArgs<ValueType> swappedArgs(args.b(), args.a(), args.result(),
330  args.bIsActive(), args.aIsActive());
331  op(swappedArgs);
332  }
333 
334  CombineOp& op;
335 };
336 
337 
339 
340 
355 
356 
357 // Dummy class that distinguishes shallow copy constructors from
358 // deep copy constructors
359 class ShallowCopy {};
360 // Dummy class that distinguishes topology copy constructors from
361 // deep copy constructors
362 class TopologyCopy {};
363 
364 } // namespace OPENVDB_VERSION_NAME
365 } // namespace openvdb
366 
367 
368 #if defined(__ICC)
369 
370 // Use these defines to bracket a region of code that has safe static accesses.
371 // Keep the region as small as possible.
372 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
373 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
374 #define OPENVDB_START_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
375 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
376 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
377 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
378 
379 // Use these defines to bracket a region of code that has unsafe static accesses.
380 // Keep the region as small as possible.
381 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(disable:1710))
382 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE __pragma(warning(default:1710))
383 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE __pragma(warning(disable:1711))
384 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE __pragma(warning(default:1711))
385 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(disable:1712))
386 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS __pragma(warning(default:1712))
387 
388 // Simpler version for one-line cases
389 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) \
390  __pragma(warning(disable:1710)); CODE; __pragma(warning(default:1710))
391 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) \
392  __pragma(warning(disable:1711)); CODE; __pragma(warning(default:1711))
393 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) \
394  __pragma(warning(disable:1712)); CODE; __pragma(warning(default:1712))
395 
396 #else // GCC does not support these compiler warnings
397 
398 #define OPENVDB_START_THREADSAFE_STATIC_REFERENCE
399 #define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE
400 #define OPENVDB_START_THREADSAFE_STATIC_WRITE
401 #define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE
402 #define OPENVDB_START_THREADSAFE_STATIC_ADDRESS
403 #define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS
404 
405 #define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE
406 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE
407 #define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE
408 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE
409 #define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS
410 #define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS
411 
412 #define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) CODE
413 #define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) CODE
414 #define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) CODE
415 
416 #endif // defined(__ICC)
417 
418 #endif // OPENVDB_TYPES_HAS_BEEN_INCLUDED
419 
420 // Copyright (c) 2012 DreamWorks Animation LLC
421 // All rights reserved. This software is distributed under the
422 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )