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 #include "pxr/usd/usdUI/backdrop.h"
25 #include "pxr/usd/usd/schemaRegistry.h"
26 #include "pxr/usd/usd/typed.h"
27
28 #include "pxr/usd/sdf/types.h"
29 #include "pxr/usd/sdf/assetPath.h"
30
31 PXR_NAMESPACE_OPEN_SCOPE
32
33 // Register the schema with the TfType system.
TF_REGISTRY_FUNCTION(TfType)34 TF_REGISTRY_FUNCTION(TfType)
35 {
36 TfType::Define<UsdUIBackdrop,
37 TfType::Bases< UsdTyped > >();
38
39 // Register the usd prim typename as an alias under UsdSchemaBase. This
40 // enables one to call
41 // TfType::Find<UsdSchemaBase>().FindDerivedByName("Backdrop")
42 // to find TfType<UsdUIBackdrop>, which is how IsA queries are
43 // answered.
44 TfType::AddAlias<UsdSchemaBase, UsdUIBackdrop>("Backdrop");
45 }
46
47 /* virtual */
~UsdUIBackdrop()48 UsdUIBackdrop::~UsdUIBackdrop()
49 {
50 }
51
52 /* static */
53 UsdUIBackdrop
Get(const UsdStagePtr & stage,const SdfPath & path)54 UsdUIBackdrop::Get(const UsdStagePtr &stage, const SdfPath &path)
55 {
56 if (!stage) {
57 TF_CODING_ERROR("Invalid stage");
58 return UsdUIBackdrop();
59 }
60 return UsdUIBackdrop(stage->GetPrimAtPath(path));
61 }
62
63 /* static */
64 UsdUIBackdrop
Define(const UsdStagePtr & stage,const SdfPath & path)65 UsdUIBackdrop::Define(
66 const UsdStagePtr &stage, const SdfPath &path)
67 {
68 static TfToken usdPrimTypeName("Backdrop");
69 if (!stage) {
70 TF_CODING_ERROR("Invalid stage");
71 return UsdUIBackdrop();
72 }
73 return UsdUIBackdrop(
74 stage->DefinePrim(path, usdPrimTypeName));
75 }
76
77 /* virtual */
_GetSchemaKind() const78 UsdSchemaKind UsdUIBackdrop::_GetSchemaKind() const
79 {
80 return UsdUIBackdrop::schemaKind;
81 }
82
83 /* static */
84 const TfType &
_GetStaticTfType()85 UsdUIBackdrop::_GetStaticTfType()
86 {
87 static TfType tfType = TfType::Find<UsdUIBackdrop>();
88 return tfType;
89 }
90
91 /* static */
92 bool
_IsTypedSchema()93 UsdUIBackdrop::_IsTypedSchema()
94 {
95 static bool isTyped = _GetStaticTfType().IsA<UsdTyped>();
96 return isTyped;
97 }
98
99 /* virtual */
100 const TfType &
_GetTfType() const101 UsdUIBackdrop::_GetTfType() const
102 {
103 return _GetStaticTfType();
104 }
105
106 UsdAttribute
GetDescriptionAttr() const107 UsdUIBackdrop::GetDescriptionAttr() const
108 {
109 return GetPrim().GetAttribute(UsdUITokens->uiDescription);
110 }
111
112 UsdAttribute
CreateDescriptionAttr(VtValue const & defaultValue,bool writeSparsely) const113 UsdUIBackdrop::CreateDescriptionAttr(VtValue const &defaultValue, bool writeSparsely) const
114 {
115 return UsdSchemaBase::_CreateAttr(UsdUITokens->uiDescription,
116 SdfValueTypeNames->Token,
117 /* custom = */ false,
118 SdfVariabilityUniform,
119 defaultValue,
120 writeSparsely);
121 }
122
123 namespace {
124 static inline TfTokenVector
_ConcatenateAttributeNames(const TfTokenVector & left,const TfTokenVector & right)125 _ConcatenateAttributeNames(const TfTokenVector& left,const TfTokenVector& right)
126 {
127 TfTokenVector result;
128 result.reserve(left.size() + right.size());
129 result.insert(result.end(), left.begin(), left.end());
130 result.insert(result.end(), right.begin(), right.end());
131 return result;
132 }
133 }
134
135 /*static*/
136 const TfTokenVector&
GetSchemaAttributeNames(bool includeInherited)137 UsdUIBackdrop::GetSchemaAttributeNames(bool includeInherited)
138 {
139 static TfTokenVector localNames = {
140 UsdUITokens->uiDescription,
141 };
142 static TfTokenVector allNames =
143 _ConcatenateAttributeNames(
144 UsdTyped::GetSchemaAttributeNames(true),
145 localNames);
146
147 if (includeInherited)
148 return allNames;
149 else
150 return localNames;
151 }
152
153 PXR_NAMESPACE_CLOSE_SCOPE
154
155 // ===================================================================== //
156 // Feel free to add custom code below this line. It will be preserved by
157 // the code generator.
158 //
159 // Just remember to wrap code in the appropriate delimiters:
160 // 'PXR_NAMESPACE_OPEN_SCOPE', 'PXR_NAMESPACE_CLOSE_SCOPE'.
161 // ===================================================================== //
162 // --(BEGIN CUSTOM CODE)--
163