All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nodeGraphNodeAPI.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_NODEGRAPHNODEAPI_H
25 #define USDUI_GENERATED_NODEGRAPHNODEAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdUI/api.h"
31 #include "pxr/usd/usd/apiSchemaBase.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 // NODEGRAPHNODEAPI //
51 // -------------------------------------------------------------------------- //
52 
65 {
66 public:
71 
76  explicit UsdUINodeGraphNodeAPI(const UsdPrim& prim=UsdPrim())
77  : UsdAPISchemaBase(prim)
78  {
79  }
80 
84  explicit UsdUINodeGraphNodeAPI(const UsdSchemaBase& schemaObj)
85  : UsdAPISchemaBase(schemaObj)
86  {
87  }
88 
90  USDUI_API
91  virtual ~UsdUINodeGraphNodeAPI();
92 
96  USDUI_API
97  static const TfTokenVector &
98  GetSchemaAttributeNames(bool includeInherited=true);
99 
109  USDUI_API
110  static UsdUINodeGraphNodeAPI
111  Get(const UsdStagePtr &stage, const SdfPath &path);
112 
113 
126  USDUI_API
127  static UsdUINodeGraphNodeAPI
128  Apply(const UsdPrim &prim);
129 
130 protected:
134  USDUI_API
135  UsdSchemaType _GetSchemaType() const override;
136 
137 private:
138  // needs to invoke _GetStaticTfType.
139  friend class UsdSchemaRegistry;
140  USDUI_API
141  static const TfType &_GetStaticTfType();
142 
143  static bool _IsTypedSchema();
144 
145  // override SchemaBase virtuals.
146  USDUI_API
147  const TfType &_GetTfType() const override;
148 
149 public:
150  // --------------------------------------------------------------------- //
151  // POS
152  // --------------------------------------------------------------------- //
172  USDUI_API
173  UsdAttribute GetPosAttr() const;
174 
180  USDUI_API
181  UsdAttribute CreatePosAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182 
183 public:
184  // --------------------------------------------------------------------- //
185  // STACKINGORDER
186  // --------------------------------------------------------------------- //
203  USDUI_API
205 
211  USDUI_API
212  UsdAttribute CreateStackingOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // --------------------------------------------------------------------- //
216  // DISPLAYCOLOR
217  // --------------------------------------------------------------------- //
226  USDUI_API
228 
234  USDUI_API
235  UsdAttribute CreateDisplayColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // --------------------------------------------------------------------- //
239  // ICON
240  // --------------------------------------------------------------------- //
249  USDUI_API
250  UsdAttribute GetIconAttr() const;
251 
257  USDUI_API
258  UsdAttribute CreateIconAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
259 
260 public:
261  // --------------------------------------------------------------------- //
262  // EXPANSIONSTATE
263  // --------------------------------------------------------------------- //
276  USDUI_API
278 
284  USDUI_API
285  UsdAttribute CreateExpansionStateAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
286 
287 public:
288  // --------------------------------------------------------------------- //
289  // SIZE
290  // --------------------------------------------------------------------- //
304  USDUI_API
305  UsdAttribute GetSizeAttr() const;
306 
312  USDUI_API
313  UsdAttribute CreateSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
314 
315 public:
316  // ===================================================================== //
317  // Feel free to add custom code below this line, it will be preserved by
318  // the code generator.
319  //
320  // Just remember to:
321  // - Close the class declaration with };
322  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
323  // - Close the include guard with #endif
324  // ===================================================================== //
325  // --(BEGIN CUSTOM CODE)--
326 };
327 
328 PXR_NAMESPACE_CLOSE_SCOPE
329 
330 #endif
This api helps storing information about nodes in node graphs.
USDUI_API UsdAttribute GetIconAttr() const
This points to an image that should be displayed on the node.
USDUI_API UsdAttribute CreateExpansionStateAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetExpansionStateAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDUI_API UsdAttribute GetPosAttr() const
Declared relative position to the parent in a node graph.
USDUI_API UsdAttribute GetSizeAttr() const
Optional size hint for a node in a node graph.
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 UsdUINodeGraphNodeAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdUINodeGraphNodeAPI holding the prim adhering to this schema at path on stage...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
static USDUI_API UsdUINodeGraphNodeAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
UsdUINodeGraphNodeAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdUINodeGraphNodeAPI on UsdPrim prim .
USDUI_API UsdAttribute CreateIconAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetIconAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDUI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDUI_API UsdAttribute CreatePosAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPosAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
USDUI_API UsdAttribute GetDisplayColorAttr() const
This hint defines what tint the node should have in the node graph.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
Single Apply API schema.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDUI_API UsdAttribute GetExpansionStateAttr() const
The current expansionState of the node in the ui.
USDUI_API UsdAttribute CreateStackingOrderAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetStackingOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDUI_API UsdAttribute CreateDisplayColorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisplayColorAttr(), 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
USDUI_API UsdAttribute GetStackingOrderAttr() const
This optional value is a useful hint when an application cares about the visibility of a node and whe...
UsdUINodeGraphNodeAPI(const UsdSchemaBase &schemaObj)
Construct a UsdUINodeGraphNodeAPI on the prim held by schemaObj .
virtual USDUI_API ~UsdUINodeGraphNodeAPI()
Destructor.
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
USDUI_API UsdAttribute CreateSizeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSizeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182