HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
types.h File Reference
#include "pxr/pxr.h"
#include "pxr/base/vt/api.h"
#include "pxr/base/vt/traits.h"
#include "pxr/base/arch/inttypes.h"
#include "pxr/base/gf/declare.h"
#include "pxr/base/gf/half.h"
#include "pxr/base/tf/token.h"
#include <hboost/preprocessor/cat.hpp>
#include <hboost/preprocessor/seq/for_each.hpp>
#include <hboost/preprocessor/seq/for_each_i.hpp>
#include <hboost/preprocessor/tuple/elem.hpp>
#include <cstddef>
#include <cstring>
#include <string>
+ Include dependency graph for types.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  VtArray< T >
 
struct  VtIsKnownValueType_Workaround< T >
 
struct  Vt_ShapeData
 

Namespaces

 Vt_KnownValueTypeDetail
 

Macros

#define VT_FLOATING_POINT_BUILTIN_VALUE_TYPES
 
#define VT_INTEGRAL_BUILTIN_VALUE_TYPES
 
#define VT_VEC_INT_VALUE_TYPES
 
#define VT_VEC_HALF_VALUE_TYPES
 
#define VT_VEC_FLOAT_VALUE_TYPES
 
#define VT_VEC_DOUBLE_VALUE_TYPES
 
#define VT_VEC_VALUE_TYPES
 
#define VT_MATRIX_FLOAT_VALUE_TYPES
 
#define VT_MATRIX_DOUBLE_VALUE_TYPES
 
#define VT_MATRIX_VALUE_TYPES
 
#define VT_GFRANGE_VALUE_TYPES
 
#define VT_RANGE_VALUE_TYPES
 
#define VT_STRING_VALUE_TYPES
 
#define VT_QUATERNION_VALUE_TYPES
 
#define VT_DUALQUATERNION_VALUE_TYPES
 
#define VT_NONARRAY_VALUE_TYPES
 
#define VT_TYPE(elem)   HBOOST_PP_TUPLE_ELEM(2, 0, elem)
 
#define VT_TYPE_NAME(elem)   HBOOST_PP_TUPLE_ELEM(2, 1, elem)
 
#define VT_BUILTIN_NUMERIC_VALUE_TYPES   VT_INTEGRAL_BUILTIN_VALUE_TYPES VT_FLOATING_POINT_BUILTIN_VALUE_TYPES
 
#define VT_BUILTIN_VALUE_TYPES   VT_BUILTIN_NUMERIC_VALUE_TYPES VT_STRING_VALUE_TYPES
 
#define VT_SCALAR_CLASS_VALUE_TYPES
 
#define VT_SCALAR_VALUE_TYPES   VT_SCALAR_CLASS_VALUE_TYPES VT_BUILTIN_VALUE_TYPES
 
#define VT_ARRAY_TYPEDEF(r, unused, elem)
 
#define VT_ARRAY_TYPE_TUPLE(r, unused, elem)
 
#define VT_ARRAY_VALUE_TYPES   HBOOST_PP_SEQ_FOR_EACH(VT_ARRAY_TYPE_TUPLE, ~, VT_SCALAR_VALUE_TYPES)
 
#define VT_CLASS_VALUE_TYPES   VT_ARRAY_VALUE_TYPES VT_SCALAR_CLASS_VALUE_TYPES VT_NONARRAY_VALUE_TYPES
 
#define VT_VALUE_TYPES   VT_BUILTIN_VALUE_TYPES VT_CLASS_VALUE_TYPES
 
#define VT_SET_VALUE_TYPE_INDEX(r, unused, i, elem)
 
#define VT_SPECIALIZE_IS_VALUE_PROXY(r, unused, elem)
 

Functions

PXR_NAMESPACE_OPEN_SCOPE VT_TYPE_IS_CHEAP_TO_COPY (TfToken)
 
template<class T >
constexpr int Vt_KnownValueTypeDetail::GetIndex ()
 
constexpr int VtGetNumKnownValueTypes ()
 
template<class T >
constexpr int VtGetKnownValueTypeIndex ()
 
template<class T >
constexpr bool VtIsKnownValueType ()
 Returns true if T is a type that appears in VT_VALUE_TYPES. More...
 
template<typename T >
VtZero ()
 

Detailed Description

Defines all the types "TYPED" for which Vt creates a VtTYPEDArray typedef.

Definition in file types.h.

Macro Definition Documentation

#define VT_ARRAY_TYPE_TUPLE (   r,
  unused,
  elem 
)
Value:
Definition: ImfArray.h:47
#define VT_TYPE_NAME(elem)
Definition: types.h:146
ARCH_EXPORT void HBOOST_PP_CAT(init_module_, MFB_PACKAGE_NAME)()
Definition: pyModule.h:62

Definition at line 181 of file types.h.

#define VT_ARRAY_TYPEDEF (   r,
  unused,
  elem 
)
Value:
Definition: ImfArray.h:47
Definition: types.h:173
#define VT_TYPE_NAME(elem)
Definition: types.h:146
ARCH_EXPORT void HBOOST_PP_CAT(init_module_, MFB_PACKAGE_NAME)()
Definition: pyModule.h:62

Definition at line 174 of file types.h.

#define VT_ARRAY_VALUE_TYPES   HBOOST_PP_SEQ_FOR_EACH(VT_ARRAY_TYPE_TUPLE, ~, VT_SCALAR_VALUE_TYPES)

Definition at line 184 of file types.h.

#define VT_BUILTIN_NUMERIC_VALUE_TYPES   VT_INTEGRAL_BUILTIN_VALUE_TYPES VT_FLOATING_POINT_BUILTIN_VALUE_TYPES

Definition at line 151 of file types.h.

#define VT_BUILTIN_VALUE_TYPES   VT_BUILTIN_NUMERIC_VALUE_TYPES VT_STRING_VALUE_TYPES

Definition at line 154 of file types.h.

Definition at line 187 of file types.h.

#define VT_DUALQUATERNION_VALUE_TYPES
Value:
(( GfDualQuath, DualQuath )) \
(( GfDualQuatf, DualQuatf )) \
(( GfDualQuatd, DualQuatd ))

Definition at line 134 of file types.h.

#define VT_FLOATING_POINT_BUILTIN_VALUE_TYPES
Value:
(( double, Double )) \
(( float, Float )) \
(( GfHalf, Half ))
pxr_half::half GfHalf
A 16-bit floating point data type.
Definition: half.h:41
Definition: Types.h:101

Definition at line 55 of file types.h.

#define VT_GFRANGE_VALUE_TYPES
Value:
(( GfRange3f, Range3f )) \
(( GfRange3d, Range3d )) \
(( GfRange2f, Range2f )) \
(( GfRange2d, Range2d )) \
(( GfRange1f, Range1f )) \
(( GfRange1d, Range1d ))

Definition at line 111 of file types.h.

#define VT_INTEGRAL_BUILTIN_VALUE_TYPES
Value:
(( bool, Bool )) \
(( char, Char )) \
(( unsigned char, UChar )) \
(( short, Short )) \
(( unsigned short, UShort )) \
(( int, Int )) \
(( unsigned int, UInt )) \
(( int64_t, Int64 )) \
(( uint64_t, UInt64 ))
typedef int(APIENTRYP RE_PFNGLXSWAPINTERVALSGIPROC)(int)
IMATH_INTERNAL_NAMESPACE_HEADER_ENTER typedef long long unsigned int Int64
Int64 - unsigned 64-bit integer.
Definition: ImathInt64.h:37

Definition at line 60 of file types.h.

#define VT_MATRIX_DOUBLE_VALUE_TYPES
Value:
(( GfMatrix4d, Matrix4d )) \
(( GfMatrix3d, Matrix3d )) \
(( GfMatrix2d, Matrix2d ))

Definition at line 102 of file types.h.

#define VT_MATRIX_FLOAT_VALUE_TYPES
Value:
(( GfMatrix4f, Matrix4f )) \
(( GfMatrix3f, Matrix3f )) \
(( GfMatrix2f, Matrix2f )) \

Definition at line 97 of file types.h.

#define VT_MATRIX_VALUE_TYPES
Value:

Definition at line 107 of file types.h.

#define VT_NONARRAY_VALUE_TYPES
Value:

Definition at line 139 of file types.h.

#define VT_QUATERNION_VALUE_TYPES
Value:
(( GfQuath, Quath )) \
(( GfQuatf, Quatf )) \
(( GfQuatd, Quatd )) \
Definition: quath.h:60
Definition: quatf.h:59
Quat< double > Quatd
Quaternion of type double.
Definition: ImathQuat.h:265
Quat< float > Quatf
Quaternion of type float.
Definition: ImathQuat.h:262
Definition: quatd.h:59

Definition at line 128 of file types.h.

#define VT_RANGE_VALUE_TYPES
Value:
(( GfRect2i, Rect2i ))
#define VT_GFRANGE_VALUE_TYPES
Definition: types.h:111

Definition at line 119 of file types.h.

#define VT_SCALAR_CLASS_VALUE_TYPES
#define VT_SCALAR_VALUE_TYPES   VT_SCALAR_CLASS_VALUE_TYPES VT_BUILTIN_VALUE_TYPES

Definition at line 164 of file types.h.

#define VT_SET_VALUE_TYPE_INDEX (   r,
  unused,
  i,
  elem 
)
Value:
template <> constexpr int \
GetIndex< VT_TYPE(elem) >() { \
return i; \
}

Definition at line 206 of file types.h.

#define VT_SPECIALIZE_IS_VALUE_PROXY (   r,
  unused,
  elem 
)
Value:
template <> struct \
VtIsValueProxy< VT_TYPE(elem) > : std::false_type {}; \
template <> struct \
VtIsTypedValueProxy< VT_TYPE(elem) > : std::false_type {}; \
template <> struct \
VtIsErasedValueProxy< VT_TYPE(elem) > : std::false_type {};

Definition at line 263 of file types.h.

#define VT_STRING_VALUE_TYPES
Value:
(( std::string, String )) \
(( TfToken, Token ))
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
Definition: token.h:87

Definition at line 124 of file types.h.

#define VT_TYPE (   elem)    HBOOST_PP_TUPLE_ELEM(2, 0, elem)

Definition at line 144 of file types.h.

#define VT_TYPE_NAME (   elem)    HBOOST_PP_TUPLE_ELEM(2, 1, elem)

Definition at line 146 of file types.h.

#define VT_VALUE_TYPES   VT_BUILTIN_VALUE_TYPES VT_CLASS_VALUE_TYPES

Definition at line 190 of file types.h.

#define VT_VEC_DOUBLE_VALUE_TYPES
Value:
(( GfVec4d, Vec4d )) \
(( GfVec3d, Vec3d )) \
(( GfVec2d, Vec2d ))
Definition: vec4d.h:62
Definition: vec2d.h:62
Definition: vec3d.h:62

Definition at line 86 of file types.h.

#define VT_VEC_FLOAT_VALUE_TYPES
Value:
(( GfVec4f, Vec4f )) \
(( GfVec3f, Vec3f )) \
(( GfVec2f, Vec2f ))
math::Vec4< float > Vec4f
Definition: Types.h:89
Definition: vec3f.h:62
Definition: vec4f.h:62
Definition: vec2f.h:62
math::Vec2< float > Vec2f
Definition: Types.h:65
math::Vec3< float > Vec3f
Definition: Types.h:74

Definition at line 81 of file types.h.

#define VT_VEC_HALF_VALUE_TYPES
Value:
(( GfVec4h, Vec4h )) \
(( GfVec3h, Vec3h )) \
(( GfVec2h, Vec2h ))
Definition: vec4h.h:63
Definition: vec2h.h:63
Definition: vec3h.h:63

Definition at line 76 of file types.h.

#define VT_VEC_INT_VALUE_TYPES
Value:
(( GfVec4i, Vec4i )) \
(( GfVec3i, Vec3i )) \
(( GfVec2i, Vec2i ))
Definition: vec4i.h:60
Definition: vec2i.h:60
Definition: vec3i.h:60

Definition at line 71 of file types.h.

#define VT_VEC_VALUE_TYPES

Function Documentation

PXR_NAMESPACE_OPEN_SCOPE VT_TYPE_IS_CHEAP_TO_COPY ( TfToken  )
template<class T >
constexpr int VtGetKnownValueTypeIndex ( )

Provide compile-time value type indexes for types that are "known" to Vt – specifically, those types that appear in VT_VALUE_TYPES. Note that VtArray and VtValue can work with other types that are not these "known" types.

VtGetKnownValueTypeIndex can only be used with known types. Querying a type that is not known to Vt results in a compilation error. The set of known types and their indexes are not guaranteed to be stable across releases of the library.

Most clients should prefer VtVisitValue over direct use of the type index as VtVisitValue provides convenient and efficient access to the held value.

Definition at line 236 of file types.h.

constexpr int VtGetNumKnownValueTypes ( )

Definition at line 218 of file types.h.

template<class T >
constexpr bool VtIsKnownValueType ( )

Returns true if T is a type that appears in VT_VALUE_TYPES.

Definition at line 246 of file types.h.

template<typename T >
T VtZero ( )