HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
interpolation.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_USD_USD_INTERPOLATION_H
25 #define PXR_USD_USD_INTERPOLATION_H
26 
27 /// \file usd/interpolation.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usd/api.h"
31 #include "pxr/usd/sdf/timeCode.h"
32 #include "pxr/base/vt/array.h"
33 #include "pxr/base/gf/declare.h"
34 
35 #include <hboost/preprocessor/seq/for_each.hpp>
36 
38 
39 
40 /// \enum UsdInterpolationType
41 ///
42 /// Attribute value interpolation options.
43 ///
44 /// See \ref Usd_AttributeInterpolation for more details.
45 ///
47 {
48  UsdInterpolationTypeHeld, ///< Held interpolation
49  UsdInterpolationTypeLinear ///< Linear interpolation
50 };
51 
52 /// \anchor USD_LINEAR_INTERPOLATION_TYPES
53 /// Sequence of value types that support linear interpolation.
54 /// These types and VtArrays of these types are supported:
55 /// \li <b>GfHalf</b>
56 /// \li <b>float</b>
57 /// \li <b>double</b>
58 /// \li <b>SdfTimeCode</b>
59 /// \li <b>GfMatrix2d</b>
60 /// \li <b>GfMatrix3d</b>
61 /// \li <b>GfMatrix4d</b>
62 /// \li <b>GfVec2d</b>
63 /// \li <b>GfVec2f</b>
64 /// \li <b>GfVec2h</b>
65 /// \li <b>GfVec3d</b>
66 /// \li <b>GfVec3f</b>
67 /// \li <b>GfVec3h</b>
68 /// \li <b>GfVec4d</b>
69 /// \li <b>GfVec4f</b>
70 /// \li <b>GfVec4h</b>
71 /// \li <b>GfQuatd</b> (via quaternion slerp)
72 /// \li <b>GfQuatf</b> (via quaternion slerp)
73 /// \li <b>GfQuath</b> (via quaternion slerp)
74 /// \hideinitializer
75 #define USD_LINEAR_INTERPOLATION_TYPES \
76  (GfHalf) (VtArray<GfHalf>) \
77  (float) (VtArray<float>) \
78  (double) (VtArray<double>) \
79  (SdfTimeCode) (VtArray<SdfTimeCode>) \
80  (GfMatrix2d) (VtArray<GfMatrix2d>) \
81  (GfMatrix3d) (VtArray<GfMatrix3d>) \
82  (GfMatrix4d) (VtArray<GfMatrix4d>) \
83  (GfVec2d) (VtArray<GfVec2d>) \
84  (GfVec2f) (VtArray<GfVec2f>) \
85  (GfVec2h) (VtArray<GfVec2h>) \
86  (GfVec3d) (VtArray<GfVec3d>) \
87  (GfVec3f) (VtArray<GfVec3f>) \
88  (GfVec3h) (VtArray<GfVec3h>) \
89  (GfVec4d) (VtArray<GfVec4d>) \
90  (GfVec4f) (VtArray<GfVec4f>) \
91  (GfVec4h) (VtArray<GfVec4h>) \
92  (GfQuatd) (VtArray<GfQuatd>) \
93  (GfQuatf) (VtArray<GfQuatf>) \
94  (GfQuath) (VtArray<GfQuath>)
95 
96 /// \struct UsdLinearInterpolationTraits
97 ///
98 /// Traits class describing whether a particular C++ value type
99 /// supports linear interpolation.
100 ///
101 /// UsdLinearInterpolationTraits<T>::isSupported will be true for all
102 /// types listed in the USD_LINEAR_INTERPOLATION_TYPES sequence.
103 template <class T>
105 {
106  static const bool isSupported = false;
107 };
108 
109 /// \cond INTERNAL
110 #define _USD_DECLARE_INTERPOLATION_TRAITS(r, unused, type) \
111 template <> \
112 struct UsdLinearInterpolationTraits<type> \
113 { \
114  static const bool isSupported = true; \
115 };
116 
117 HBOOST_PP_SEQ_FOR_EACH(_USD_DECLARE_INTERPOLATION_TRAITS, ~,
119 
120 #undef _USD_DECLARE_INTERPOLATION_TRAITS
121 /// \endcond
122 
123 
125 
126 #endif // PXR_USD_USD_INTERPOLATION_H
HBOOST_PP_SEQ_FOR_EACH(SDF_DECLARE_VALUE_TYPE_TRAITS,~, SDF_VALUE_TYPES)
Linear interpolation.
Definition: interpolation.h:49
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
static const bool isSupported
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Held interpolation.
Definition: interpolation.h:48
UsdInterpolationType
Definition: interpolation.h:46
#define USD_LINEAR_INTERPOLATION_TYPES
Definition: interpolation.h:75