All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
connectionListEditor.h
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 SDF_CONNECTION_LIST_EDITOR_H
25 #define SDF_CONNECTION_LIST_EDITOR_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/sdf/listOpListEditor.h"
29 #include "pxr/usd/sdf/childrenPolicies.h"
30 #include "pxr/usd/sdf/declareHandles.h"
31 #include "pxr/usd/sdf/proxyPolicies.h"
32 #include "pxr/usd/sdf/types.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 SDF_DECLARE_HANDLES(SdfSpec);
37 class TfToken;
38 
45 template <class ConnectionChildPolicy>
46 class Sdf_ConnectionListEditor
47  : public Sdf_ListOpListEditor<SdfPathKeyPolicy>
48 {
49 protected:
50  virtual ~Sdf_ConnectionListEditor();
51 
52  Sdf_ConnectionListEditor(
53  const SdfSpecHandle& connectionOwner,
54  const TfToken& connectionListField,
55  const SdfPathKeyPolicy& typePolicy = SdfPathKeyPolicy());
56 
57  void _OnEditShared(SdfListOpType op,
58  SdfSpecType specType,
59  const std::vector<SdfPath>& oldItems,
60  const std::vector<SdfPath>& newItems) const;
61 
62 private:
63  typedef Sdf_ListOpListEditor<SdfPathKeyPolicy> Parent;
64 };
65 
70 class Sdf_AttributeConnectionListEditor
71  : public Sdf_ConnectionListEditor<Sdf_AttributeConnectionChildPolicy>
72 {
73 public:
74  virtual ~Sdf_AttributeConnectionListEditor();
75 
76  Sdf_AttributeConnectionListEditor(
77  const SdfSpecHandle& owner,
78  const SdfPathKeyPolicy& typePolicy = SdfPathKeyPolicy());
79 
80  virtual void _OnEdit(SdfListOpType op,
81  const std::vector<SdfPath>& oldItems,
82  const std::vector<SdfPath>& newItems) const;
83 private:
84  typedef Sdf_ConnectionListEditor<Sdf_AttributeConnectionChildPolicy> Parent;
85 };
86 
91 class Sdf_RelationshipTargetListEditor
92  : public Sdf_ConnectionListEditor<Sdf_RelationshipTargetChildPolicy>
93 {
94 public:
95  virtual ~Sdf_RelationshipTargetListEditor();
96 
97  Sdf_RelationshipTargetListEditor(
98  const SdfSpecHandle& owner,
99  const SdfPathKeyPolicy& typePolicy = SdfPathKeyPolicy());
100 
101  virtual void _OnEdit(SdfListOpType op,
102  const std::vector<SdfPath>& oldItems,
103  const std::vector<SdfPath>& newItems) const;
104 private:
105  typedef Sdf_ConnectionListEditor<Sdf_RelationshipTargetChildPolicy> Parent;
106 };
107 
108 PXR_NAMESPACE_CLOSE_SCOPE
109 
110 #endif // SDF_CONNECTION_LIST_EDITOR_H
Base class for all Sdf spec classes.
Definition: spec.h:51
SdfSpecType
An enum that specifies the type of an object.
Definition: types.h:91
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Key policy for SdfPath; converts all SdfPaths to absolute.
Definition: proxyPolicies.h:83