HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
proxyTypes.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_SDF_PROXY_TYPES_H
25 #define PXR_USD_SDF_PROXY_TYPES_H
26 
27 #include "pxr/pxr.h"
33 #include "pxr/usd/sdf/listProxy.h"
36 
38 
40 
47 
58 
68 
73 
74 /// Returns a path list editor proxy for the path list op in the given
75 /// \p pathField on \p spec. If the value doesn't exist or \p spec is
76 /// invalid then this returns an invalid list editor.
79  const SdfSpecHandle& spec, const TfToken& pathField);
80 
81 /// Returns a reference list editor proxy for the references list op in the
82 /// given \p referenceField on \p spec. If the value doesn't exist or the object
83 /// is invalid then this returns an invalid list editor.
86  const SdfSpecHandle& spec, const TfToken& referenceField);
87 
88 /// Returns a payload list editor proxy for the payloads list op in the given
89 /// \p payloadField on \p spec. If the value doesn't exist or the object is
90 /// invalid then this returns an invalid list editor.
93  const SdfSpecHandle& spec, const TfToken& payloadField);
94 
95 /// Returns a name order list proxy for the ordering specified in the given
96 /// \p orderField on \p spec. If the value doesn't exist or the object is
97 /// invalid then this returns an invalid list editor.
100  const SdfSpecHandle& spec, const TfToken& orderField);
101 
103 
104 #endif // PXR_USD_SDF_PROXY_TYPES_H
SdfNameOrderProxy SdfPropertyOrderProxy
Definition: proxyTypes.h:60
SdfNameEditorProxy SdfVariantSetNamesProxy
Definition: proxyTypes.h:67
SdfReferenceEditorProxy SdfGetReferenceEditorProxy(const SdfSpecHandle &spec, const TfToken &referenceField)
PXR_NAMESPACE_OPEN_SCOPE SDF_DECLARE_HANDLES(SdfSpec)
std::map< SdfPath, SdfPath > SdfRelocatesMap
A map of source SdfPaths to target SdfPaths for relocation.
Definition: types.h:293
SdfChildrenView< Sdf_RelationshipChildPolicy, SdfRelationshipViewPredicate > SdfRelationshipSpecView
Definition: proxyTypes.h:54
SdfMapEditProxy< VtDictionary > SdfDictionaryProxy
Definition: proxyTypes.h:69
Definition: spec.h:51
SdfReferenceEditorProxy SdfReferencesProxy
Definition: proxyTypes.h:66
SdfPathEditorProxy SdfConnectionsProxy
Definition: proxyTypes.h:61
SdfPayloadEditorProxy SdfGetPayloadEditorProxy(const SdfSpecHandle &spec, const TfToken &payloadField)
SdfListProxy< SdfSubLayerTypePolicy > SdfSubLayerProxy
Definition: proxyTypes.h:42
SdfChildrenView< Sdf_PropertyChildPolicy > SdfPropertySpecView
Definition: proxyTypes.h:51
Definition: token.h:87
SdfListEditorProxy< SdfPayloadTypePolicy > SdfPayloadEditorProxy
Definition: proxyTypes.h:45
SdfChildrenProxy< SdfVariantSetView > SdfVariantSetsProxy
Definition: proxyTypes.h:57
SdfListProxy< SdfNameTokenKeyPolicy > SdfNameOrderProxy
Definition: proxyTypes.h:41
SdfListEditorProxy< SdfPathKeyPolicy > SdfPathEditorProxy
Definition: proxyTypes.h:44
SdfMapEditProxy< SdfVariantSelectionMap > SdfVariantSelectionProxy
Definition: proxyTypes.h:70
SdfNameOrderProxy SdfNameChildrenOrderProxy
Definition: proxyTypes.h:59
SdfMapEditProxy< SdfRelocatesMap, SdfRelocatesMapProxyValuePolicy > SdfRelocatesMapProxy
Definition: proxyTypes.h:72
SdfChildrenView< Sdf_VariantChildPolicy > SdfVariantView
Definition: proxyTypes.h:55
SdfPayloadEditorProxy SdfPayloadsProxy
Definition: proxyTypes.h:65
SdfNameOrderProxy SdfGetNameOrderProxy(const SdfSpecHandle &spec, const TfToken &orderField)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
SdfListEditorProxy< SdfNameKeyPolicy > SdfNameEditorProxy
Definition: proxyTypes.h:43
SdfChildrenView< Sdf_AttributeChildPolicy, SdfAttributeViewPredicate > SdfAttributeSpecView
Definition: proxyTypes.h:49
SdfListEditorProxy< SdfReferenceTypePolicy > SdfReferenceEditorProxy
Definition: proxyTypes.h:46
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
SdfChildrenView< Sdf_VariantSetChildPolicy > SdfVariantSetView
Definition: proxyTypes.h:56
SdfPathEditorProxy SdfTargetsProxy
Definition: proxyTypes.h:64
SdfChildrenView< Sdf_PrimChildPolicy > SdfPrimSpecView
Definition: proxyTypes.h:50
SdfPathEditorProxy SdfInheritsProxy
Definition: proxyTypes.h:62
SdfChildrenView< Sdf_AttributeChildPolicy > SdfRelationalAttributeSpecView
Definition: proxyTypes.h:52
SdfPathEditorProxy SdfGetPathEditorProxy(const SdfSpecHandle &spec, const TfToken &pathField)
SdfPathEditorProxy SdfSpecializesProxy
Definition: proxyTypes.h:63