Loading...
Searching...
No Matches
types.h File Reference

Basic Sdf data types. More...

+ 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  SdfUnregisteredValue
 Stores a representation of the value for an unregistered metadata field encountered during text layer parsing. More...
 
class  SdfValueBlock
 A special value type that can be used to explicitly author an opinion for an attribute's default value or time sample value that represents having no value. More...
 

Macros

#define _SDF_LENGTH_UNITS
 
#define _SDF_ANGULAR_UNITS
 
#define _SDF_DIMENSIONLESS_UNITS
 
#define _SDF_UNITS
 
#define _SDF_UNIT_TAG(tup)   TF_PP_TUPLE_ELEM(0, tup)
 
#define _SDF_UNIT_NAME(tup)   TF_PP_TUPLE_ELEM(1, tup)
 
#define _SDF_UNIT_SCALE(tup)   TF_PP_TUPLE_ELEM(2, tup)
 
#define _SDF_UNITSLIST_CATEGORY(tup)   TF_PP_TUPLE_ELEM(0, tup)
 
#define _SDF_UNITSLIST_TUPLES(tup)   TF_PP_TUPLE_ELEM(1, tup)
 
#define _SDF_UNITSLIST_ENUM(elem)
 
#define _SDF_DECLARE_UNIT_ENUMERANT(tag, elem)    TF_PP_CAT(Sdf ## tag ## Unit, _SDF_UNIT_TAG(elem)),
 
#define _SDF_DECLARE_UNIT_ENUM(elem)
 
#define _SDF_FOR_EACH_UNITS_IMPL(macro, ...)    TF_PP_FOR_EACH(macro, __VA_ARGS__)
 
#define _SDF_FOR_EACH_UNITS(macro, args)    _SDF_FOR_EACH_UNITS_IMPL(macro, TF_PP_EAT_PARENS(args))
 
#define _SDF_SCALAR_VALUE_TYPES
 
#define _SDF_DIMENSIONED_VALUE_TYPES
 
#define SDF_VALUE_TYPES   _SDF_SCALAR_VALUE_TYPES _SDF_DIMENSIONED_VALUE_TYPES
 
#define SDF_VALUE_CPP_TYPE(tup)   TF_PP_TUPLE_ELEM(2, tup)
 
#define SDF_VALUE_CPP_ARRAY_TYPE(tup)   VtArray<TF_PP_TUPLE_ELEM(2, tup)>
 
#define SDF_DECLARE_VALUE_TYPE_TRAITS(unused, elem)
 
#define SDF_VALUE_ROLE_NAME_TOKENS
 

Typedefs

typedef std::map< std::string, std::string > SdfVariantSelectionMap
 A map of reference variant set names to variants in those sets.
 
typedef std::map< std::string, std::vector< std::string > > SdfVariantsMap
 A map of variant set names to list of variants in those sets.
 
typedef std::map< SdfPath, SdfPathSdfRelocatesMap
 A map of source SdfPaths to target SdfPaths for relocation.
 
typedef std::pair< SdfPath, SdfPathSdfRelocate
 A single relocate specifying a source SdfPath and a target SdfPath for a relocation.
 
typedef std::vector< SdfRelocateSdfRelocates
 A vector of relocation source path to target path pairs.
 
typedef std::map< double, VtValueSdfTimeSampleMap
 A map from sample times to sample values.
 
typedef std::map< std::string, SdfVariantSetSpecHandle > SdfVariantSetSpecHandleMap
 

Enumerations

enum  SdfSpecType {
  SdfSpecTypeUnknown = 0 , SdfSpecTypeAttribute , SdfSpecTypeConnection , SdfSpecTypeExpression ,
  SdfSpecTypeMapper , SdfSpecTypeMapperArg , SdfSpecTypePrim , SdfSpecTypePseudoRoot ,
  SdfSpecTypeRelationship , SdfSpecTypeRelationshipTarget , SdfSpecTypeVariant , SdfSpecTypeVariantSet ,
  SdfNumSpecTypes
}
 An enum that specifies the type of an object. More...
 
enum  SdfSpecifier { SdfSpecifierDef , SdfSpecifierOver , SdfSpecifierClass , SdfNumSpecifiers }
 An enum that identifies the possible specifiers for an SdfPrimSpec. More...
 
enum  SdfPermission { SdfPermissionPublic , SdfPermissionPrivate , SdfNumPermissions }
 An enum that defines permission levels. More...
 
enum  SdfVariability { SdfVariabilityVarying , SdfVariabilityUniform , SdfNumVariabilities }
 An enum that identifies variability types for attributes. More...
 
enum  SdfAuthoringError { SdfAuthoringErrorUnrecognizedFields , SdfAuthoringErrorUnrecognizedSpecType }
 An enum for TfError codes related to authoring operations. More...
 

Functions

bool SdfIsDefiningSpecifier (SdfSpecifier spec)
 Returns true if the specifier defines a prim.
 
SDF_API TfEnum SdfDefaultUnit (TfToken const &typeName)
 Gets the show default unit for the given /a typeName.
 
SDF_API const TfEnumSdfDefaultUnit (const TfEnum &unit)
 Gets the show default unit for the given /a unit.
 
SDF_API const std::string & SdfUnitCategory (const TfEnum &unit)
 Gets the unit category for a given /a unit.
 
SDF_API double SdfConvertUnit (const TfEnum &fromUnit, const TfEnum &toUnit)
 Converts from one unit of measure to another.
 
SDF_API const std::string & SdfGetNameForUnit (const TfEnum &unit)
 Gets the name for a given /a unit.
 
SDF_API const TfEnumSdfGetUnitFromName (const std::string &name)
 Gets a unit for the given /a name.
 
SDF_API bool SdfValueHasValidType (VtValue const &value)
 Given a value, returns if there is a valid corresponding valueType.
 
SDF_API TfType SdfGetTypeForValueTypeName (TfToken const &name)
 Given an sdf valueType name, produce TfType if the type name specifies a valid sdf value type.
 
SDF_API SdfValueTypeName SdfGetValueTypeNameForValue (VtValue const &value)
 Given a value, produce the sdf valueType name.
 
SDF_API TfToken SdfGetRoleNameForValueTypeName (TfToken const &typeName)
 Return role name for typeName.
 
 TF_PP_SEQ_FOR_EACH (SDF_DECLARE_VALUE_TYPE_TRAITS, ~, SDF_VALUE_TYPES)
 
SDF_API bool SdfConvertToValidMetadataDictionary (VtDictionary *dict, std::string *errMsg)
 Convert dict to a valid metadata dictionary for scene description.
 
 TF_DECLARE_PUBLIC_TOKENS (SdfValueRoleNames, SDF_API, SDF_VALUE_ROLE_NAME_TOKENS)
 
 SDF_DECLARE_HANDLES (SdfLayer)
 
 SDF_DECLARE_HANDLES (SdfAttributeSpec)
 
 SDF_DECLARE_HANDLES (SdfPrimSpec)
 
 SDF_DECLARE_HANDLES (SdfPropertySpec)
 
 SDF_DECLARE_HANDLES (SdfSpec)
 
 SDF_DECLARE_HANDLES (SdfRelationshipSpec)
 
 SDF_DECLARE_HANDLES (SdfVariantSetSpec)
 
 SDF_DECLARE_HANDLES (SdfVariantSpec)
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfSpecifier &spec)
 Writes the string representation of SdfSpecifier to out.
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfRelocatesMap &reloMap)
 Writes the string representation of SdfRelocatesMap to out.
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfRelocates &relocates)
 Writes the string representation of SdfRelocates to out.
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfTimeSampleMap &sampleMap)
 Writes the string representation of SdfTimeSampleMap to out.
 
SDF_API std::ostream & VtStreamOut (const SdfVariantSelectionMap &, std::ostream &)
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfUnregisteredValue &value)
 Writes the string representation of SdfUnregisteredValue to out.
 
SDF_API std::ostream & operator<< (std::ostream &, SdfValueBlock const &)
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfHumanReadableValue &hrval)
 
SDF_API size_t hash_value (const SdfHumanReadableValue &hrval)
 

Variables

ARCH_PRAGMA_PUSH ARCH_PRAGMA_MACRO_TOO_FEW_ARGUMENTS ARCH_PRAGMA_POP typedef std::map< std::string, VtValueSdfMapperParametersMap
 A map of mapper parameter names to parameter values.
 
SDF_API TfStaticData< const Sdf_ValueTypeNamesType, Sdf_ValueTypeNamesType::_Init > SdfValueTypeNames
 

Detailed Description

Basic Sdf data types.

Definition in file types.h.

Macro Definition Documentation

◆ _SDF_ANGULAR_UNITS

#define _SDF_ANGULAR_UNITS
Value:
((Degrees, "deg", 1.0)) \
((Radians, "rad", 57.2957795130823208768))

Definition at line 226 of file types.h.

◆ _SDF_DECLARE_UNIT_ENUM

#define _SDF_DECLARE_UNIT_ENUM (   elem)
Value:
enum _SDF_UNITSLIST_ENUM(elem) { \
TF_PP_SEQ_FOR_EACH(_SDF_DECLARE_UNIT_ENUMERANT, \
_SDF_UNITSLIST_CATEGORY(elem), \
_SDF_UNITSLIST_TUPLES(elem)) \
};

Definition at line 251 of file types.h.

◆ _SDF_DECLARE_UNIT_ENUMERANT

#define _SDF_DECLARE_UNIT_ENUMERANT (   tag,
  elem 
)     TF_PP_CAT(Sdf ## tag ## Unit, _SDF_UNIT_TAG(elem)),

Definition at line 248 of file types.h.

◆ _SDF_DIMENSIONED_VALUE_TYPES

#define _SDF_DIMENSIONED_VALUE_TYPES
Value:
((Matrix2d, matrix2d, GfMatrix2d, (2,2) )) \
((Matrix3d, matrix3d, GfMatrix3d, (3,3) )) \
((Matrix4d, matrix4d, GfMatrix4d, (4,4) )) \
((Quath, quath, GfQuath, (4) )) \
((Quatf, quatf, GfQuatf, (4) )) \
((Quatd, quatd, GfQuatd, (4) )) \
((Int2, int2, GfVec2i, (2) )) \
((Half2, half2, GfVec2h, (2) )) \
((Float2, float2, GfVec2f, (2) )) \
((Double2, double2, GfVec2d, (2) )) \
((Int3, int3, GfVec3i, (3) )) \
((Half3, half3, GfVec3h, (3) )) \
((Float3, float3, GfVec3f, (3) )) \
((Double3, double3, GfVec3d, (3) )) \
((Int4, int4, GfVec4i, (4) )) \
((Half4, half4, GfVec4h, (4) )) \
((Float4, float4, GfVec4f, (4) )) \
((Double4, double4, GfVec4d, (4) ))
Stores a 2x2 matrix of double elements.
Definition: matrix2d.h:62
Stores a 3x3 matrix of double elements.
Definition: matrix3d.h:82
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
Basic type: a quaternion, a complex number with a real coefficient and three imaginary coefficients,...
Definition: quatd.h:60
Basic type: a quaternion, a complex number with a real coefficient and three imaginary coefficients,...
Definition: quatf.h:60
Basic type: a quaternion, a complex number with a real coefficient and three imaginary coefficients,...
Definition: quath.h:61
Basic type for a vector of 2 double components.
Definition: vec2d.h:63
Basic type for a vector of 2 float components.
Definition: vec2f.h:63
Basic type for a vector of 2 GfHalf components.
Definition: vec2h.h:64
Basic type for a vector of 2 int components.
Definition: vec2i.h:61
Basic type for a vector of 3 double components.
Definition: vec3d.h:63
Basic type for a vector of 3 float components.
Definition: vec3f.h:63
Basic type for a vector of 3 GfHalf components.
Definition: vec3h.h:64
Basic type for a vector of 3 int components.
Definition: vec3i.h:61
Basic type for a vector of 4 double components.
Definition: vec4d.h:63
Basic type for a vector of 4 float components.
Definition: vec4f.h:63
Basic type for a vector of 4 GfHalf components.
Definition: vec4h.h:64
Basic type for a vector of 4 int components.
Definition: vec4i.h:61

Definition at line 359 of file types.h.

◆ _SDF_DIMENSIONLESS_UNITS

#define _SDF_DIMENSIONLESS_UNITS
Value:
((Percent, "%", 0.01)) \
((Default, "default", 1.0))

Definition at line 230 of file types.h.

◆ _SDF_FOR_EACH_UNITS

#define _SDF_FOR_EACH_UNITS (   macro,
  args 
)     _SDF_FOR_EACH_UNITS_IMPL(macro, TF_PP_EAT_PARENS(args))

Definition at line 260 of file types.h.

◆ _SDF_FOR_EACH_UNITS_IMPL

#define _SDF_FOR_EACH_UNITS_IMPL (   macro,
  ... 
)     TF_PP_FOR_EACH(macro, __VA_ARGS__)

Definition at line 258 of file types.h.

◆ _SDF_LENGTH_UNITS

#define _SDF_LENGTH_UNITS
Value:
((Millimeter, "mm", 0.001)) \
((Centimeter, "cm", 0.01)) \
((Decimeter, "dm", 0.1)) \
((Meter, "m", 1.0)) \
((Kilometer, "km", 1000.0)) \
((Inch, "in", 0.0254)) \
((Foot, "ft", 0.3048)) \
((Yard, "yd", 0.9144)) \
((Mile, "mi", 1609.344))

Definition at line 215 of file types.h.

◆ _SDF_SCALAR_VALUE_TYPES

#define _SDF_SCALAR_VALUE_TYPES
Value:
((Bool, bool, bool, () )) \
((UChar, uchar, unsigned char, () )) \
((Int, int, int, () )) \
((UInt, uint, unsigned int, () )) \
((Int64, int64, int64_t, () )) \
((UInt64, uint64, uint64_t, () )) \
((Half, half, GfHalf, () )) \
((Float, float, float, () )) \
((Double, double, double, () )) \
((TimeCode, timecode, SdfTimeCode, () )) \
((String, string, std::string, () )) \
((Token, token, TfToken, () )) \
((Asset, asset, SdfAssetPath, () )) \
((Opaque, opaque, SdfOpaqueValue, () )) \
((PathExpression, pathExpression, SdfPathExpression, () ))
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
In-memory representation of the value of an opaque attribute.
Definition: opaqueValue.h:48
Objects of this class represent a logical expression syntax tree consisting of SdfPath matching patte...
Value type that represents a time code.
Definition: timeCode.h:45
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
pxr_half::half GfHalf
A 16-bit floating point data type.
Definition: half.h:41

Definition at line 342 of file types.h.

◆ _SDF_UNIT_NAME

#define _SDF_UNIT_NAME (   tup)    TF_PP_TUPLE_ELEM(1, tup)

Definition at line 240 of file types.h.

◆ _SDF_UNIT_SCALE

#define _SDF_UNIT_SCALE (   tup)    TF_PP_TUPLE_ELEM(2, tup)

Definition at line 241 of file types.h.

◆ _SDF_UNIT_TAG

#define _SDF_UNIT_TAG (   tup)    TF_PP_TUPLE_ELEM(0, tup)

Definition at line 239 of file types.h.

◆ _SDF_UNITS

#define _SDF_UNITS
Value:
((Length, _SDF_LENGTH_UNITS), \
(Angular, _SDF_ANGULAR_UNITS), \
(Dimensionless, _SDF_DIMENSIONLESS_UNITS))

Definition at line 234 of file types.h.

◆ _SDF_UNITSLIST_CATEGORY

#define _SDF_UNITSLIST_CATEGORY (   tup)    TF_PP_TUPLE_ELEM(0, tup)

Definition at line 243 of file types.h.

◆ _SDF_UNITSLIST_ENUM

#define _SDF_UNITSLIST_ENUM (   elem)
Value:
TF_PP_CAT(TF_PP_CAT(Sdf, \
_SDF_UNITSLIST_CATEGORY(elem)), Unit)

Definition at line 245 of file types.h.

◆ _SDF_UNITSLIST_TUPLES

#define _SDF_UNITSLIST_TUPLES (   tup)    TF_PP_TUPLE_ELEM(1, tup)

Definition at line 244 of file types.h.

◆ SDF_DECLARE_VALUE_TYPE_TRAITS

#define SDF_DECLARE_VALUE_TYPE_TRAITS (   unused,
  elem 
)
Value:
template <> \
struct SdfValueTypeTraits<SDF_VALUE_CPP_TYPE(elem)> { \
static const bool IsValueType = true; \
}; \
template <> \
struct SdfValueTypeTraits<SDF_VALUE_CPP_ARRAY_TYPE(elem)> { \
static const bool IsValueType = true; \
};

Definition at line 397 of file types.h.

◆ SDF_VALUE_CPP_ARRAY_TYPE

#define SDF_VALUE_CPP_ARRAY_TYPE (   tup)    VtArray<TF_PP_TUPLE_ELEM(2, tup)>

Definition at line 383 of file types.h.

◆ SDF_VALUE_CPP_TYPE

#define SDF_VALUE_CPP_TYPE (   tup)    TF_PP_TUPLE_ELEM(2, tup)

Definition at line 382 of file types.h.

◆ SDF_VALUE_ROLE_NAME_TOKENS

#define SDF_VALUE_ROLE_NAME_TOKENS
Value:
(Point) \
(Normal) \
(Vector) \
(Color) \
(Frame) \
(Transform) \
(PointIndex) \
(EdgeIndex) \
(FaceIndex) \
(Group) \
(TextureCoordinate)

Definition at line 434 of file types.h.

◆ SDF_VALUE_TYPES

#define SDF_VALUE_TYPES   _SDF_SCALAR_VALUE_TYPES _SDF_DIMENSIONED_VALUE_TYPES

Definition at line 379 of file types.h.

Typedef Documentation

◆ SdfRelocate

typedef std::pair<SdfPath, SdfPath> SdfRelocate

A single relocate specifying a source SdfPath and a target SdfPath for a relocation.

Definition at line 288 of file types.h.

◆ SdfRelocates

typedef std::vector<SdfRelocate> SdfRelocates

A vector of relocation source path to target path pairs.

Definition at line 291 of file types.h.

◆ SdfRelocatesMap

typedef std::map<SdfPath, SdfPath> SdfRelocatesMap

A map of source SdfPaths to target SdfPaths for relocation.

Definition at line 284 of file types.h.

◆ SdfTimeSampleMap

typedef std::map<double, VtValue> SdfTimeSampleMap

A map from sample times to sample values.

Definition at line 294 of file types.h.

◆ SdfVariantSelectionMap

typedef std::map<std::string, std::string> SdfVariantSelectionMap

A map of reference variant set names to variants in those sets.

Definition at line 275 of file types.h.

◆ SdfVariantSetSpecHandleMap

typedef std::map<std::string, SdfVariantSetSpecHandle> SdfVariantSetSpecHandleMap

Definition at line 460 of file types.h.

◆ SdfVariantsMap

typedef std::map<std::string, std::vector<std::string> > SdfVariantsMap

A map of variant set names to list of variants in those sets.

Definition at line 278 of file types.h.

Enumeration Type Documentation

◆ SdfAuthoringError

An enum for TfError codes related to authoring operations.

SdfAuthoringError:

  • SdfAuthoringErrorUnrecognizedFields. This error is raised if SdfLayer::TransferContent, or SdfLayer::SetField API is called for layers of differing schema, and fields from the source layer are not recognized by the target layer's schema.
  • SdfAuthoringErrorUnrecognizedSpecType. This error is raised in attempts to create specs on layers with spec types that are not recognized by the layer's schema.

Definition at line 194 of file types.h.

◆ SdfPermission

An enum that defines permission levels.

Permissions control which layers may refer to or express opinions about a prim. Opinions expressed about a prim, or relationships to that prim, by layers that are not allowed permission to access the prim will be ignored.

SdfPermission:

  • SdfPermissionPublic. Public prims can be referred to by anything. (Available to any client.)
  • SdfPermissionPrivate. Private prims can be referred to only within the local layer stack, and not across references or inherits. (Not available to clients.)
  • SdfNumPermission. Internal sentinel value.

Definition at line 149 of file types.h.

◆ SdfSpecifier

An enum that identifies the possible specifiers for an SdfPrimSpec.

The SdfSpecifier enum is registered as a TfEnum for converting to and from std::string.

SdfSpecifier:

  • SdfSpecifierDef. Defines a concrete prim.
  • SdfSpecifierOver. Overrides an existing prim.
  • SdfSpecifierClass. Defines an abstract prim.
  • SdfNumSpecifiers. The number of specifiers.

Definition at line 117 of file types.h.

◆ SdfSpecType

An enum that specifies the type of an object.

Objects are entities that have fields and are addressable by path.

Definition at line 85 of file types.h.

◆ SdfVariability

An enum that identifies variability types for attributes.

Variability indicates whether the attribute may vary over time and value coordinates, and if its value comes through authoring or or from its owner.

SdfVariability:

  • SdfVariabilityVarying. Varying attributes may be directly authored, animated and affected on by Actions. They are the most flexible.
  • SdfVariabilityUniform. Uniform attributes may be authored only with non-animated values (default values). They cannot be affected by Actions, but they can be connected to other Uniform attributes.
  • SdNumVariabilities. Internal sentinel value.

Definition at line 173 of file types.h.

Function Documentation

◆ operator<<() [1/5]

SDF_API std::ostream & operator<< ( std::ostream &  out,
const SdfRelocates relocates 
)

Writes the string representation of SdfRelocates to out.

◆ operator<<() [2/5]

SDF_API std::ostream & operator<< ( std::ostream &  out,
const SdfRelocatesMap reloMap 
)

Writes the string representation of SdfRelocatesMap to out.

◆ operator<<() [3/5]

SDF_API std::ostream & operator<< ( std::ostream &  out,
const SdfSpecifier spec 
)

Writes the string representation of SdfSpecifier to out.

◆ operator<<() [4/5]

SDF_API std::ostream & operator<< ( std::ostream &  out,
const SdfTimeSampleMap sampleMap 
)

Writes the string representation of SdfTimeSampleMap to out.

◆ operator<<() [5/5]

SDF_API std::ostream & operator<< ( std::ostream &  out,
const SdfUnregisteredValue value 
)

Writes the string representation of SdfUnregisteredValue to out.

◆ SdfConvertToValidMetadataDictionary()

SDF_API bool SdfConvertToValidMetadataDictionary ( VtDictionary dict,
std::string *  errMsg 
)

Convert dict to a valid metadata dictionary for scene description.

Valid metadata dictionaries have values that are any of SDF_VALUE_TYPES (or VtArrays of those), plus VtDictionary with values of those types (or similarly nested VtDictionaries).

Certain conversions are performed in an attempt to produce a valid metadata dictionary. For example:

Convert std::vector<VtValue> to VtArray<T> where T is the type of the first element in the vector. Fail conversion for empty vectors where a concrete type cannot be inferred.

Convert python sequences to VtArray<T> where T is the type of the first element in the python sequence, when converted to VtValue, if that T is an SDF_VALUE_TYPE). Fail conversion for empty sequences where a concrete type cannot be inferred.

If any values cannot be converted to valid SDF_VALUE_TYPES, omit those elements and add a message to errMsg indicating which values were omitted.

◆ SdfConvertUnit()

SDF_API double SdfConvertUnit ( const TfEnum fromUnit,
const TfEnum toUnit 
)

Converts from one unit of measure to another.

The fromUnit and toUnit units must be of the same type (for example, both of type SdfLengthUnit).

◆ SdfDefaultUnit() [1/2]

SDF_API const TfEnum & SdfDefaultUnit ( const TfEnum unit)

Gets the show default unit for the given /a unit.

◆ SdfDefaultUnit() [2/2]

SDF_API TfEnum SdfDefaultUnit ( TfToken const &  typeName)

Gets the show default unit for the given /a typeName.

◆ SdfGetNameForUnit()

SDF_API const std::string & SdfGetNameForUnit ( const TfEnum unit)

Gets the name for a given /a unit.

◆ SdfGetRoleNameForValueTypeName()

SDF_API TfToken SdfGetRoleNameForValueTypeName ( TfToken const &  typeName)

Return role name for typeName.

Return empty token if typeName has no associated role name.

◆ SdfGetTypeForValueTypeName()

SDF_API TfType SdfGetTypeForValueTypeName ( TfToken const &  name)

Given an sdf valueType name, produce TfType if the type name specifies a valid sdf value type.

◆ SdfGetUnitFromName()

SDF_API const TfEnum & SdfGetUnitFromName ( const std::string &  name)

Gets a unit for the given /a name.

◆ SdfGetValueTypeNameForValue()

SDF_API SdfValueTypeName SdfGetValueTypeNameForValue ( VtValue const &  value)

Given a value, produce the sdf valueType name.

If you provide a value that does not return true for SdfValueHasValidType, the return value is unspecified.

◆ SdfIsDefiningSpecifier()

bool SdfIsDefiningSpecifier ( SdfSpecifier  spec)
inline

Returns true if the specifier defines a prim.

Definition at line 127 of file types.h.

◆ SdfUnitCategory()

SDF_API const std::string & SdfUnitCategory ( const TfEnum unit)

Gets the unit category for a given /a unit.

◆ SdfValueHasValidType()

SDF_API bool SdfValueHasValidType ( VtValue const &  value)

Given a value, returns if there is a valid corresponding valueType.

Variable Documentation

◆ SdfMapperParametersMap

ARCH_PRAGMA_PUSH ARCH_PRAGMA_MACRO_TOO_FEW_ARGUMENTS ARCH_PRAGMA_POP typedef std::map<std::string, VtValue> SdfMapperParametersMap

A map of mapper parameter names to parameter values.

Definition at line 272 of file types.h.