All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
backdrop.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 USDUI_GENERATED_BACKDROP_H
25 #define USDUI_GENERATED_BACKDROP_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdUI/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdUI/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // BACKDROP //
51 // -------------------------------------------------------------------------- //
52 
81 class UsdUIBackdrop : public UsdTyped
82 {
83 public:
88 
93  explicit UsdUIBackdrop(const UsdPrim& prim=UsdPrim())
94  : UsdTyped(prim)
95  {
96  }
97 
101  explicit UsdUIBackdrop(const UsdSchemaBase& schemaObj)
102  : UsdTyped(schemaObj)
103  {
104  }
105 
107  USDUI_API
108  virtual ~UsdUIBackdrop();
109 
113  USDUI_API
114  static const TfTokenVector &
115  GetSchemaAttributeNames(bool includeInherited=true);
116 
126  USDUI_API
127  static UsdUIBackdrop
128  Get(const UsdStagePtr &stage, const SdfPath &path);
129 
152  USDUI_API
153  static UsdUIBackdrop
154  Define(const UsdStagePtr &stage, const SdfPath &path);
155 
156 protected:
160  USDUI_API
161  UsdSchemaType _GetSchemaType() const override;
162 
163 private:
164  // needs to invoke _GetStaticTfType.
165  friend class UsdSchemaRegistry;
166  USDUI_API
167  static const TfType &_GetStaticTfType();
168 
169  static bool _IsTypedSchema();
170 
171  // override SchemaBase virtuals.
172  USDUI_API
173  const TfType &_GetTfType() const override;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // DESCRIPTION
178  // --------------------------------------------------------------------- //
187  USDUI_API
189 
195  USDUI_API
196  UsdAttribute CreateDescriptionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197 
198 public:
199  // ===================================================================== //
200  // Feel free to add custom code below this line, it will be preserved by
201  // the code generator.
202  //
203  // Just remember to:
204  // - Close the class declaration with };
205  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
206  // - Close the include guard with #endif
207  // ===================================================================== //
208  // --(BEGIN CUSTOM CODE)--
209 };
210 
211 PXR_NAMESPACE_CLOSE_SCOPE
212 
213 #endif
Provides a 'group-box' for the purpose of node graph organization.
Definition: backdrop.h:81
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: backdrop.h:87
static USDUI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
static USDUI_API UsdUIBackdrop Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdUIBackdrop holding the prim adhering to this schema at path on stage. ...
virtual USDUI_API ~UsdUIBackdrop()
Destructor.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDUI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static USDUI_API UsdUIBackdrop Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
The base class for all typed schemas (those that can impart a typeName to a UsdPrim), and therefore the base class for all instantiable and "IsA" schemas.
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
UsdUIBackdrop(const UsdPrim &prim=UsdPrim())
Construct a UsdUIBackdrop on UsdPrim prim .
Definition: backdrop.h:93
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDUI_API UsdAttribute CreateDescriptionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDescriptionAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
UsdUIBackdrop(const UsdSchemaBase &schemaObj)
Construct a UsdUIBackdrop on the prim held by schemaObj .
Definition: backdrop.h:101
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDUI_API UsdAttribute GetDescriptionAttr() const
The text label that is displayed on the backdrop in the node graph.