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/meta.h"
#include "pxr/base/tf/preprocessorUtilsLite.h"
#include "pxr/base/tf/token.h"
#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 >
class	VtArrayEdit< T >
class	VtArrayEditBuilder< 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)   TF_PP_TUPLE_ELEM(0, elem)
#define	VT_TYPE_NAME(elem)   TF_PP_TUPLE_ELEM(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_BUILTIN_VALUE_TYPES VT_SCALAR_CLASS_VALUE_TYPES
#define	VT_ARRAY_ALIAS(unused, elem)
#define	VT_ARRAY_EDIT_ALIAS(unused, elem)
#define	VT_ARRAY_EDIT_BUILDER_ALIAS(unused, elem)
#define	VT_ARRAY_TYPE_TUPLE(unused, elem)
#define	VT_ARRAY_VALUE_TYPES   TF_PP_SEQ_FOR_EACH(VT_ARRAY_TYPE_TUPLE, ~, VT_SCALAR_VALUE_TYPES)
#define	VT_ARRAY_EDIT_TYPE_TUPLE(unused, elem)
#define	VT_ARRAY_EDIT_VALUE_TYPES   TF_PP_SEQ_FOR_EACH(VT_ARRAY_EDIT_TYPE_TUPLE, ~, VT_SCALAR_VALUE_TYPES)
#define	VT_VALUE_TYPES_1   VT_BUILTIN_VALUE_TYPES VT_SCALAR_CLASS_VALUE_TYPES
#define	VT_VALUE_TYPES_2   VT_ARRAY_VALUE_TYPES VT_ARRAY_EDIT_VALUE_TYPES VT_NONARRAY_VALUE_TYPES
#define	VT_FOR_EACH_VALUE_TYPE(_macro)
#define	VT_COMMA_TYPE(unused, elem)   , VT_TYPE(elem)
#define	VT_SPECIALIZE_IS_VALUE_PROXY(unused, elem)

Typedefs
using	Vt_ValueTypeList = TfMetaApply< TfMetaTail, TfMetaList< void VT_FOR_EACH_VALUE_TYPE(VT_COMMA_TYPE)>>

Functions
PXR_NAMESPACE_OPEN_SCOPE	VT_TYPE_IS_CHEAP_TO_COPY (TfToken)
template<typename T >
constexpr int	Vt_KnownValueTypeDetail::GetIndexImpl (TfMetaList<>)
template<typename T , typename Typelist >
constexpr int	Vt_KnownValueTypeDetail::GetIndexImpl (Typelist)
template<typename 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 >
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_ALIAS	(		unused,
			elem
	)

Value:

using TF_PP_CAT( \
   Vt, TF_PP_CAT(VT_TYPE_NAME(elem), Array)) = VtArray< VT_TYPE(elem) >;

Definition at line 153 of file types.h.

#define VT_ARRAY_EDIT_ALIAS	(		unused,
			elem
	)

Value:

using TF_PP_CAT(Vt, TF_PP_CAT(VT_TYPE_NAME(elem), ArrayEdit)) \
    = VtArrayEdit< VT_TYPE(elem) >;

Definition at line 164 of file types.h.

#define VT_ARRAY_EDIT_BUILDER_ALIAS	(		unused,
			elem
	)

Value:

using TF_PP_CAT(Vt, TF_PP_CAT(VT_TYPE_NAME(elem), ArrayEditBuilder)) \
    = VtArrayEditBuilder< VT_TYPE(elem) >;

Definition at line 175 of file types.h.

#define VT_ARRAY_EDIT_TYPE_TUPLE	(		unused,
			elem
	)

Value:

(( TF_PP_CAT(Vt, TF_PP_CAT(VT_TYPE_NAME(elem), ArrayEdit)) , \
   TF_PP_CAT(VT_TYPE_NAME(elem), ArrayEdit) ))

Definition at line 190 of file types.h.

#define VT_ARRAY_EDIT_VALUE_TYPES   TF_PP_SEQ_FOR_EACH(VT_ARRAY_EDIT_TYPE_TUPLE, ~, VT_SCALAR_VALUE_TYPES)

Definition at line 193 of file types.h.

#define VT_ARRAY_TYPE_TUPLE	(		unused,
			elem
	)

Value:

(( TF_PP_CAT(Vt, TF_PP_CAT(VT_TYPE_NAME(elem), Array)) , \
   TF_PP_CAT(VT_TYPE_NAME(elem), Array) ))

Definition at line 182 of file types.h.

#define VT_ARRAY_VALUE_TYPES   TF_PP_SEQ_FOR_EACH(VT_ARRAY_TYPE_TUPLE, ~, VT_SCALAR_VALUE_TYPES)

Definition at line 185 of file types.h.

#define VT_BUILTIN_NUMERIC_VALUE_TYPES   VT_INTEGRAL_BUILTIN_VALUE_TYPES VT_FLOATING_POINT_BUILTIN_VALUE_TYPES

Definition at line 131 of file types.h.

#define VT_BUILTIN_VALUE_TYPES   VT_BUILTIN_NUMERIC_VALUE_TYPES VT_STRING_VALUE_TYPES

Definition at line 134 of file types.h.

#define VT_COMMA_TYPE	(		unused,
			elem
	)		, VT_TYPE(elem)

Definition at line 214 of file types.h.

#define VT_DUALQUATERNION_VALUE_TYPES

Value:

((      GfDualQuath,         DualQuath ))   \
((      GfDualQuatf,         DualQuatf ))   \
((      GfDualQuatd,         DualQuatd ))

Definition at line 114 of file types.h.

#define VT_FLOATING_POINT_BUILTIN_VALUE_TYPES

Value:

((      double,                Double )) \
((      float,                 Float  )) \
((      GfHalf,                Half   ))

Definition at line 35 of file types.h.

#define VT_FOR_EACH_VALUE_TYPE

(

_macro

)

Value:

TF_PP_SEQ_FOR_EACH(_macro, ~, VT_VALUE_TYPES_1) \
    TF_PP_SEQ_FOR_EACH(_macro, ~, VT_VALUE_TYPES_2)

Definition at line 207 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 91 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 ))

Definition at line 40 of file types.h.

#define VT_MATRIX_DOUBLE_VALUE_TYPES

Value:

((      GfMatrix4d,          Matrix4d )) \
((      GfMatrix3d,          Matrix3d )) \
((      GfMatrix2d,          Matrix2d ))

Definition at line 82 of file types.h.

#define VT_MATRIX_FLOAT_VALUE_TYPES

Value:

((      GfMatrix4f,          Matrix4f )) \
((      GfMatrix3f,          Matrix3f )) \
((      GfMatrix2f,          Matrix2f )) \

Definition at line 77 of file types.h.

#define VT_MATRIX_VALUE_TYPES

Value:

VT_MATRIX_FLOAT_VALUE_TYPES          \
    VT_MATRIX_DOUBLE_VALUE_TYPES         \

Definition at line 87 of file types.h.

#define VT_NONARRAY_VALUE_TYPES

Value:

((      GfFrustum,           Frustum))          \
((      GfMultiInterval,     MultiInterval))

Definition at line 119 of file types.h.

#define VT_QUATERNION_VALUE_TYPES

Value:

((      GfQuath,             Quath ))       \
((      GfQuatf,             Quatf ))       \
((      GfQuatd,             Quatd ))       \
((      GfQuaternion,        Quaternion ))

Definition at line 108 of file types.h.

#define VT_RANGE_VALUE_TYPES

Value:

VT_GFRANGE_VALUE_TYPES                     \
((      GfInterval,          Interval       )) \
((      GfRect2i,            Rect2i         ))

Definition at line 99 of file types.h.

#define VT_SCALAR_CLASS_VALUE_TYPES

Value:

VT_VEC_VALUE_TYPES \
VT_MATRIX_VALUE_TYPES \
VT_RANGE_VALUE_TYPES \
VT_QUATERNION_VALUE_TYPES \
VT_DUALQUATERNION_VALUE_TYPES

Definition at line 137 of file types.h.

#define VT_SCALAR_VALUE_TYPES   VT_BUILTIN_VALUE_TYPES VT_SCALAR_CLASS_VALUE_TYPES

Definition at line 144 of file types.h.

#define VT_SPECIALIZE_IS_VALUE_PROXY	(		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 303 of file types.h.

#define VT_STRING_VALUE_TYPES

Value:

((      std::string,           String )) \
((      TfToken,               Token  ))

Definition at line 104 of file types.h.

#define VT_TYPE

(

elem

)

TF_PP_TUPLE_ELEM(0, elem)

Definition at line 124 of file types.h.

#define VT_TYPE_NAME

(

elem

)

TF_PP_TUPLE_ELEM(1, elem)

Definition at line 126 of file types.h.

#define VT_VALUE_TYPES_1   VT_BUILTIN_VALUE_TYPES VT_SCALAR_CLASS_VALUE_TYPES

Definition at line 198 of file types.h.

#define VT_VALUE_TYPES_2   VT_ARRAY_VALUE_TYPES VT_ARRAY_EDIT_VALUE_TYPES VT_NONARRAY_VALUE_TYPES

Definition at line 200 of file types.h.

#define VT_VEC_DOUBLE_VALUE_TYPES

Value:

((      GfVec4d,             Vec4d  )) \
((      GfVec3d,             Vec3d  )) \
((      GfVec2d,             Vec2d  ))

Definition at line 66 of file types.h.

#define VT_VEC_FLOAT_VALUE_TYPES

Value:

((      GfVec4f,             Vec4f  )) \
((      GfVec3f,             Vec3f  )) \
((      GfVec2f,             Vec2f  ))

Definition at line 61 of file types.h.

#define VT_VEC_HALF_VALUE_TYPES

Value:

((      GfVec4h,             Vec4h  )) \
((      GfVec3h,             Vec3h  )) \
((      GfVec2h,             Vec2h  ))

Definition at line 56 of file types.h.

#define VT_VEC_INT_VALUE_TYPES

Value:

((      GfVec4i,             Vec4i  )) \
((      GfVec3i,             Vec3i  )) \
((      GfVec2i,             Vec2i  ))

Definition at line 51 of file types.h.

#define VT_VEC_VALUE_TYPES

Value:

VT_VEC_INT_VALUE_TYPES   \
    VT_VEC_HALF_VALUE_TYPES  \
    VT_VEC_FLOAT_VALUE_TYPES \
    VT_VEC_DOUBLE_VALUE_TYPES

Definition at line 71 of file types.h.

Typedef Documentation

using Vt_ValueTypeList = TfMetaApply<TfMetaTail, TfMetaList< void VT_FOR_EACH_VALUE_TYPE(VT_COMMA_TYPE)>>

Definition at line 217 of file types.h.

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_{1,2} and are visited by VT_FOR_EACH_VALUE_TYPE(). Note that VtArray and VtValue can work with other types that are not these "known" types.

VtGetKnownValueTypeIndex can only be used with these 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 276 of file types.h.

constexpr int VtGetNumKnownValueTypes

(

)

Definition at line 257 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 286 of file types.h.

template<typename T >

T VtZero

(

)