All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
settingsAPI.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 USDRENDER_GENERATED_SETTINGSAPI_H
25 #define USDRENDER_GENERATED_SETTINGSAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRender/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 
35 #include "pxr/base/vt/value.h"
36 
37 #include "pxr/base/gf/vec3d.h"
38 #include "pxr/base/gf/vec3f.h"
39 #include "pxr/base/gf/matrix4d.h"
40 
41 #include "pxr/base/tf/token.h"
42 #include "pxr/base/tf/type.h"
43 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // RENDERSETTINGSAPI //
50 // -------------------------------------------------------------------------- //
51 
58 {
59 public:
64 
69  explicit UsdRenderSettingsAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit UsdRenderSettingsAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(schemaObj)
79  {
80  }
81 
83  USDRENDER_API
84  virtual ~UsdRenderSettingsAPI();
85 
89  USDRENDER_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDRENDER_API
103  static UsdRenderSettingsAPI
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
123  USDRENDER_API
124  static bool
125  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
126 
142  USDRENDER_API
143  static UsdRenderSettingsAPI
144  Apply(const UsdPrim &prim);
145 
146 protected:
150  USDRENDER_API
151  UsdSchemaKind _GetSchemaKind() const override;
152 
153 private:
154  // needs to invoke _GetStaticTfType.
155  friend class UsdSchemaRegistry;
156  USDRENDER_API
157  static const TfType &_GetStaticTfType();
158 
159  static bool _IsTypedSchema();
160 
161  // override SchemaBase virtuals.
162  USDRENDER_API
163  const TfType &_GetTfType() const override;
164 
165 public:
166  // ===================================================================== //
167  // Feel free to add custom code below this line, it will be preserved by
168  // the code generator.
169  //
170  // Just remember to:
171  // - Close the class declaration with };
172  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
173  // - Close the include guard with #endif
174  // ===================================================================== //
175  // --(BEGIN CUSTOM CODE)--
176 };
177 
178 PXR_NAMESPACE_CLOSE_SCOPE
179 
180 #endif
UsdRenderSettingsAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdRenderSettingsAPI on UsdPrim prim .
Definition: settingsAPI.h:69
static USDRENDER_API UsdRenderSettingsAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRenderSettingsAPI holding the prim adhering to this schema at path on stage...
UsdRenderSettingsAPI is a base class for API schemas to encode renderer-specific settings.
Definition: settingsAPI.h:57
The base class for all API schemas.
static USDRENDER_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
virtual USDRENDER_API ~UsdRenderSettingsAPI()
Destructor.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Single Apply API schema.
USDRENDER_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdRenderSettingsAPI(const UsdSchemaBase &schemaObj)
Construct a UsdRenderSettingsAPI on the prim held by schemaObj .
Definition: settingsAPI.h:77
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
static USDRENDER_API UsdRenderSettingsAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: settingsAPI.h:63
TfType represents a dynamic runtime type.
Definition: type.h:64
static USDRENDER_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...
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...