Loading...
Searching...
No Matches
schemaTypeRegistration.h
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_USD_SDF_SCHEMA_TYPE_REGISTRATION_H
8#define PXR_USD_SDF_SCHEMA_TYPE_REGISTRATION_H
9
10#include "pxr/pxr.h"
11#include "pxr/usd/sdf/layerOffset.h"
12#include "pxr/usd/sdf/listOp.h"
13#include "pxr/usd/sdf/path.h"
14#include "pxr/usd/sdf/schema.h"
15#include "pxr/usd/sdf/types.h"
16#include "pxr/base/vt/dictionary.h"
17#include "pxr/base/vt/value.h"
18#include "pxr/base/ts/spline.h"
19
20#include "pxr/base/tf/enum.h"
21#include "pxr/base/tf/token.h"
22
23#include <string>
24#include <vector>
25
26PXR_NAMESPACE_OPEN_SCOPE
27
28// Defines the built-in scene description fields supplied by Sdf as
29// well as their C++ value types. SdfSchema supplies additional information
30// about these fields, such as their default value and validation functions.
31//
32// XXX: bug 123508
33// StartFrame and EndFrame should be migrated to Sd.
34//
35#define _SDF_FIELDS \
36((SdfFieldKeys->Active, bool)) \
37((SdfFieldKeys->AllowedTokens, VtTokenArray)) \
38((SdfFieldKeys->ArraySizeConstraint, int64_t)) \
39((SdfFieldKeys->AssetInfo, VtDictionary)) \
40((SdfFieldKeys->Clips, VtDictionary)) \
41((SdfFieldKeys->ClipSets, SdfStringListOp)) \
42((SdfFieldKeys->ColorConfiguration, SdfAssetPath)) \
43((SdfFieldKeys->ColorManagementSystem, TfToken)) \
44((SdfFieldKeys->ColorSpace, TfToken)) \
45((SdfFieldKeys->Comment, std::string)) \
46((SdfFieldKeys->ConnectionPaths, SdfPathListOp)) \
47((SdfFieldKeys->Custom, bool)) \
48((SdfFieldKeys->CustomData, VtDictionary)) \
49((SdfFieldKeys->CustomLayerData, VtDictionary)) \
50((SdfFieldKeys->Default, VtValue)) \
51((SdfFieldKeys->DefaultPrim, TfToken)) \
52((SdfFieldKeys->DisplayGroup, std::string)) \
53((SdfFieldKeys->DisplayGroupOrder, VtStringArray)) \
54((SdfFieldKeys->DisplayName, std::string)) \
55((SdfFieldKeys->DisplayUnit, TfEnum)) \
56((SdfFieldKeys->Documentation, std::string)) \
57((SdfFieldKeys->EndFrame, double)) \
58((SdfFieldKeys->EndTimeCode, double)) \
59((SdfFieldKeys->ExpressionVariables, VtDictionary)) \
60((SdfFieldKeys->FramePrecision, int)) \
61((SdfFieldKeys->FramesPerSecond, double)) \
62((SdfFieldKeys->Hidden, bool)) \
63((SdfFieldKeys->HasOwnedSubLayers, bool)) \
64((SdfFieldKeys->InheritPaths, SdfPathListOp)) \
65((SdfFieldKeys->Instanceable, bool)) \
66((SdfFieldKeys->Kind, TfToken)) \
67((SdfFieldKeys->LayerRelocates, SdfRelocates)) \
68((SdfFieldKeys->Limits, VtDictionary)) \
69((SdfFieldKeys->Owner, std::string)) \
70((SdfFieldKeys->PrimOrder, std::vector<TfToken>)) \
71((SdfFieldKeys->NoLoadHint, bool)) \
72((SdfFieldKeys->Payload, SdfPayloadListOp)) \
73((SdfFieldKeys->Permission, SdfPermission)) \
74((SdfFieldKeys->Prefix, std::string)) \
75((SdfFieldKeys->PrefixSubstitutions, VtDictionary)) \
76((SdfFieldKeys->PropertyOrder, std::vector<TfToken>)) \
77((SdfFieldKeys->References, SdfReferenceListOp)) \
78((SdfFieldKeys->SessionOwner, std::string)) \
79((SdfFieldKeys->TargetPaths, SdfPathListOp)) \
80((SdfFieldKeys->TimeSamples, SdfTimeSampleMap)) \
81((SdfFieldKeys->Specializes, SdfPathListOp)) \
82((SdfFieldKeys->Specifier, SdfSpecifier)) \
83((SdfFieldKeys->Spline, TsSpline)) \
84((SdfFieldKeys->StartFrame, double)) \
85((SdfFieldKeys->StartTimeCode, double)) \
86((SdfFieldKeys->SubLayers, std::vector<std::string>)) \
87((SdfFieldKeys->SubLayerOffsets, std::vector<SdfLayerOffset>)) \
88((SdfFieldKeys->Suffix, std::string)) \
89((SdfFieldKeys->SuffixSubstitutions, VtDictionary)) \
90((SdfFieldKeys->SymmetricPeer, std::string)) \
91((SdfFieldKeys->SymmetryArgs, VtDictionary)) \
92((SdfFieldKeys->SymmetryArguments, VtDictionary)) \
93((SdfFieldKeys->SymmetryFunction, TfToken)) \
94((SdfFieldKeys->TimeCodesPerSecond, double)) \
95((SdfFieldKeys->TypeName, TfToken)) \
96((SdfFieldKeys->VariantSetNames, SdfStringListOp)) \
97((SdfFieldKeys->VariantSelection, SdfVariantSelectionMap)) \
98((SdfFieldKeys->Variability, SdfVariability)) \
99((SdfChildrenKeys->ConnectionChildren, std::vector<SdfPath>)) \
100((SdfChildrenKeys->ExpressionChildren, std::vector<TfToken>)) \
101((SdfChildrenKeys->MapperArgChildren, std::vector<TfToken>)) \
102((SdfChildrenKeys->MapperChildren, std::vector<SdfPath>)) \
103((SdfChildrenKeys->PrimChildren, std::vector<TfToken>)) \
104((SdfChildrenKeys->PropertyChildren, std::vector<TfToken>)) \
105((SdfChildrenKeys->RelationshipTargetChildren, std::vector<SdfPath>)) \
106((SdfChildrenKeys->VariantChildren, std::vector<TfToken>)) \
107((SdfChildrenKeys->VariantSetChildren, std::vector<TfToken>))
108
109#define _SDF_FIELDS_NAME(tup) TF_PP_TUPLE_ELEM(0, tup)
110#define _SDF_FIELDS_TYPE(tup) TF_PP_TUPLE_ELEM(1, tup)
111
118template <class Registrar>
119inline void
120SdfRegisterFields(Registrar* reg)
121{
122#define _SDF_REGISTER_FIELDS(unused, elem) \
123 reg->template RegisterField< _SDF_FIELDS_TYPE(elem) >(_SDF_FIELDS_NAME(elem));
124
125 TF_PP_SEQ_FOR_EACH(_SDF_REGISTER_FIELDS, ~, _SDF_FIELDS)
126#undef _SDF_REGISTER_FIELDS
127}
128
138template <class Registrar>
139inline void
140SdfRegisterTypes(Registrar* reg)
141{
142 // Register all of the C++ value types from the field list above.
143#define _SDF_REGISTER_TYPES(unused, elem) \
144 reg->template RegisterType< _SDF_FIELDS_TYPE(elem) >();
145
146 TF_PP_SEQ_FOR_EACH(_SDF_REGISTER_TYPES, ~, _SDF_FIELDS)
147#undef _SDF_REGISTER_TYPES
148
149 // Also register all of the C++ value types for value types.
150#define _SDF_REGISTER_VALUE_TYPES(unused, elem) \
151 { \
152 reg->template RegisterType<SDF_VALUE_CPP_TYPE(elem)>(); \
153 reg->template RegisterType<SDF_VALUE_CPP_ARRAY_TYPE(elem)>(); \
154 }
155 TF_PP_SEQ_FOR_EACH(_SDF_REGISTER_VALUE_TYPES, ~, SDF_VALUE_TYPES)
156#undef _SDF_REGISTER_VALUE_TYPES
157
158 // Also register all of the C++ list op types supported for
159 // generic plugin metadata.
160 reg->template RegisterType<SdfIntListOp>();
161 reg->template RegisterType<SdfInt64ListOp>();
162 reg->template RegisterType<SdfUIntListOp>();
163 reg->template RegisterType<SdfUInt64ListOp>();
164 reg->template RegisterType<SdfStringListOp>();
165 reg->template RegisterType<SdfTokenListOp>();
166 reg->template RegisterType<SdfValueBlock>();
167 reg->template RegisterType<SdfAnimationBlock>();
168}
169
170PXR_NAMESPACE_CLOSE_SCOPE
171
172#endif // PXR_USD_SDF_SCHEMA_TYPE_REGISTRATION_H
token.h
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
types.h
Basic Sdf data types.