All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
settings.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_SETTINGS_H
25 #define USDRENDER_GENERATED_SETTINGS_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRender/api.h"
31 #include "pxr/usd/usdRender/settingsBase.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdRender/tokens.h"
35 
36 #include "pxr/base/gf/frustum.h"
37 
38 
39 #include "pxr/base/vt/value.h"
40 
41 #include "pxr/base/gf/vec3d.h"
42 #include "pxr/base/gf/vec3f.h"
43 #include "pxr/base/gf/matrix4d.h"
44 
45 #include "pxr/base/tf/token.h"
46 #include "pxr/base/tf/type.h"
47 
48 PXR_NAMESPACE_OPEN_SCOPE
49 
50 class SdfAssetPath;
51 
52 // -------------------------------------------------------------------------- //
53 // RENDERSETTINGS //
54 // -------------------------------------------------------------------------- //
55 
64 {
65 public:
70 
75  explicit UsdRenderSettings(const UsdPrim& prim=UsdPrim())
76  : UsdRenderSettingsBase(prim)
77  {
78  }
79 
83  explicit UsdRenderSettings(const UsdSchemaBase& schemaObj)
84  : UsdRenderSettingsBase(schemaObj)
85  {
86  }
87 
89  USDRENDER_API
90  virtual ~UsdRenderSettings();
91 
95  USDRENDER_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  USDRENDER_API
109  static UsdRenderSettings
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
134  USDRENDER_API
135  static UsdRenderSettings
136  Define(const UsdStagePtr &stage, const SdfPath &path);
137 
138 protected:
142  USDRENDER_API
143  UsdSchemaType _GetSchemaType() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
148  USDRENDER_API
149  static const TfType &_GetStaticTfType();
150 
151  static bool _IsTypedSchema();
152 
153  // override SchemaBase virtuals.
154  USDRENDER_API
155  const TfType &_GetTfType() const override;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // INCLUDEDPURPOSES
160  // --------------------------------------------------------------------- //
170  USDRENDER_API
172 
178  USDRENDER_API
179  UsdAttribute CreateIncludedPurposesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180 
181 public:
182  // --------------------------------------------------------------------- //
183  // MATERIALBINDINGPURPOSES
184  // --------------------------------------------------------------------- //
194  USDRENDER_API
196 
202  USDRENDER_API
203  UsdAttribute CreateMaterialBindingPurposesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
204 
205 public:
206  // --------------------------------------------------------------------- //
207  // PRODUCTS
208  // --------------------------------------------------------------------- //
215  USDRENDER_API
217 
220  USDRENDER_API
222 
223 public:
224  // ===================================================================== //
225  // Feel free to add custom code below this line, it will be preserved by
226  // the code generator.
227  //
228  // Just remember to:
229  // - Close the class declaration with };
230  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
231  // - Close the include guard with #endif
232  // ===================================================================== //
233  // --(BEGIN CUSTOM CODE)--
234 
239  USDRENDER_API
240  static UsdRenderSettings
241  GetStageRenderSettings(const UsdStageWeakPtr &stage);
242 };
243 
244 PXR_NAMESPACE_CLOSE_SCOPE
245 
246 #endif
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...
USDRENDER_API UsdAttribute GetMaterialBindingPurposesAttr() const
Ordered list of material purposes to consider when resolving material bindings in the scene...
static USDRENDER_API UsdRenderSettings Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRenderSettings holding the prim adhering to this schema at path on stage.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
Abstract base class that defines render settings that can be specified on either a RenderSettings pri...
Definition: settingsBase.h:64
USDRENDER_API UsdRelationship GetProductsRel() const
The set of RenderProducts the render should produce.
USDRENDER_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
virtual USDRENDER_API ~UsdRenderSettings()
Destructor.
USDRENDER_API UsdAttribute CreateMaterialBindingPurposesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaterialBindingPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs ...
static USDRENDER_API UsdRenderSettings GetStageRenderSettings(const UsdStageWeakPtr &stage)
Fetch and return stage 's render settings, as indicated by root layer metadata.
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
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
USDRENDER_API UsdAttribute GetIncludedPurposesAttr() const
The list of UsdGeomImageable purpose values that should be included in the render.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRENDER_API UsdAttribute CreateIncludedPurposesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetIncludedPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of ...
Definition: settings.h:63
UsdRenderSettings(const UsdSchemaBase &schemaObj)
Construct a UsdRenderSettings on the prim held by schemaObj .
Definition: settings.h:83
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: settings.h:69
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
UsdRenderSettings(const UsdPrim &prim=UsdPrim())
Construct a UsdRenderSettings on UsdPrim prim .
Definition: settings.h:75
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
static USDRENDER_API UsdRenderSettings Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDRENDER_API UsdRelationship CreateProductsRel() const
See GetProductsRel(), and also Create vs Get Property Methods for when to use Get vs Create...