HDK
 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 
27 /// \file usdRender/settings.h
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"
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 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RENDERSETTINGS //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRenderSettings
54 ///
55 /// A UsdRenderSettings prim specifies global settings for
56 /// a render process, including an enumeration of the RenderProducts
57 /// that should result, and the UsdGeomImageable purposes that should
58 /// be rendered. \ref UsdRenderHowSettingsAffectRendering
59 ///
61 {
62 public:
63  /// Compile time constant representing what kind of schema this class is.
64  ///
65  /// \sa UsdSchemaKind
67 
68  /// Construct a UsdRenderSettings on UsdPrim \p prim .
69  /// Equivalent to UsdRenderSettings::Get(prim.GetStage(), prim.GetPath())
70  /// for a \em valid \p prim, but will not immediately throw an error for
71  /// an invalid \p prim
72  explicit UsdRenderSettings(const UsdPrim& prim=UsdPrim())
73  : UsdRenderSettingsBase(prim)
74  {
75  }
76 
77  /// Construct a UsdRenderSettings on the prim held by \p schemaObj .
78  /// Should be preferred over UsdRenderSettings(schemaObj.GetPrim()),
79  /// as it preserves SchemaBase state.
80  explicit UsdRenderSettings(const UsdSchemaBase& schemaObj)
81  : UsdRenderSettingsBase(schemaObj)
82  {
83  }
84 
85  /// Destructor.
87  virtual ~UsdRenderSettings();
88 
89  /// Return a vector of names of all pre-declared attributes for this schema
90  /// class and all its ancestor classes. Does not include attributes that
91  /// may be authored by custom/extended methods of the schemas involved.
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
96  /// Return a UsdRenderSettings holding the prim adhering to this
97  /// schema at \p path on \p stage. If no prim exists at \p path on
98  /// \p stage, or if the prim at that path does not adhere to this schema,
99  /// return an invalid schema object. This is shorthand for the following:
100  ///
101  /// \code
102  /// UsdRenderSettings(stage->GetPrimAtPath(path));
103  /// \endcode
104  ///
106  static UsdRenderSettings
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
110  /// is defined (according to UsdPrim::IsDefined()) on this stage.
111  ///
112  /// If a prim adhering to this schema at \p path is already defined on this
113  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
114  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
115  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
116  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
117  /// current EditTarget for any nonexistent, or existing but not \a Defined
118  /// ancestors.
119  ///
120  /// The given \a path must be an absolute prim path that does not contain
121  /// any variant selections.
122  ///
123  /// If it is impossible to author any of the necessary PrimSpecs, (for
124  /// example, in case \a path cannot map to the current UsdEditTarget's
125  /// namespace) issue an error and return an invalid \a UsdPrim.
126  ///
127  /// Note that this method may return a defined prim whose typeName does not
128  /// specify this schema class, in case a stronger typeName opinion overrides
129  /// the opinion at the current EditTarget.
130  ///
132  static UsdRenderSettings
133  Define(const UsdStagePtr &stage, const SdfPath &path);
134 
135 protected:
136  /// Returns the kind of schema this class belongs to.
137  ///
138  /// \sa UsdSchemaKind
140  UsdSchemaKind _GetSchemaKind() const override;
141 
142 private:
143  // needs to invoke _GetStaticTfType.
144  friend class UsdSchemaRegistry;
146  static const TfType &_GetStaticTfType();
147 
148  static bool _IsTypedSchema();
149 
150  // override SchemaBase virtuals.
152  const TfType &_GetTfType() const override;
153 
154 public:
155  // --------------------------------------------------------------------- //
156  // INCLUDEDPURPOSES
157  // --------------------------------------------------------------------- //
158  /// The list of UsdGeomImageable _purpose_ values that
159  /// should be included in the render. Note this cannot be
160  /// specified per-RenderProduct because it is a statement of
161  /// which geometry is present.
162  ///
163  /// | ||
164  /// | -- | -- |
165  /// | Declaration | `uniform token[] includedPurposes = ["default", "render"]` |
166  /// | C++ Type | VtArray<TfToken> |
167  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->TokenArray |
168  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
171 
172  /// See GetIncludedPurposesAttr(), and also
173  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
174  /// If specified, author \p defaultValue as the attribute's default,
175  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
176  /// the default for \p writeSparsely is \c false.
178  UsdAttribute CreateIncludedPurposesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179 
180 public:
181  // --------------------------------------------------------------------- //
182  // MATERIALBINDINGPURPOSES
183  // --------------------------------------------------------------------- //
184  /// Ordered list of material purposes to consider when
185  /// resolving material bindings in the scene. The empty string
186  /// indicates the "allPurpose" binding.
187  ///
188  /// | ||
189  /// | -- | -- |
190  /// | Declaration | `uniform token[] materialBindingPurposes = ["full", ""]` |
191  /// | C++ Type | VtArray<TfToken> |
192  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->TokenArray |
193  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
194  /// | \ref UsdRenderTokens "Allowed Values" | full, preview, "" |
197 
198  /// See GetMaterialBindingPurposesAttr(), and also
199  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
200  /// If specified, author \p defaultValue as the attribute's default,
201  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
202  /// the default for \p writeSparsely is \c false.
204  UsdAttribute CreateMaterialBindingPurposesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
205 
206 public:
207  // --------------------------------------------------------------------- //
208  // PRODUCTS
209  // --------------------------------------------------------------------- //
210  /// The set of RenderProducts the render should produce.
211  /// This relationship should target UsdRenderProduct prims.
212  /// If no _products_ are specified, an application should produce
213  /// an rgb image according to the RenderSettings configuration,
214  /// to a default display or image name.
215  ///
218 
219  /// See GetProductsRel(), and also
220  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create
223 
224 public:
225  // ===================================================================== //
226  // Feel free to add custom code below this line, it will be preserved by
227  // the code generator.
228  //
229  // Just remember to:
230  // - Close the class declaration with };
231  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
232  // - Close the include guard with #endif
233  // ===================================================================== //
234  // --(BEGIN CUSTOM CODE)--
235 
236  /// Fetch and return \p stage 's render settings, as indicated by root
237  /// layer metadata. If unauthored, or the metadata does not refer to
238  /// a valid UsdRenderSettings prim, this will return an invalid
239  /// UsdRenderSettings prim.
241  static UsdRenderSettings
243 };
244 
246 
247 #endif
static USDRENDER_API UsdRenderSettings Get(const UsdStagePtr &stage, const SdfPath &path)
#define USDRENDER_API
Definition: api.h:40
USDRENDER_API UsdRelationship GetProductsRel() const
static USDRENDER_API UsdRenderSettings GetStageRenderSettings(const UsdStageWeakPtr &stage)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
UsdRenderSettings(const UsdSchemaBase &schemaObj)
Definition: settings.h:80
USDRENDER_API UsdAttribute CreateIncludedPurposesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRENDER_API UsdSchemaKind _GetSchemaKind() const override
USDRENDER_API UsdAttribute GetIncludedPurposesAttr() const
UsdSchemaKind
Definition: common.h:127
USDRENDER_API UsdAttribute CreateMaterialBindingPurposesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDRENDER_API UsdRelationship CreateProductsRel() const
Definition: path.h:290
USDRENDER_API UsdAttribute GetMaterialBindingPurposesAttr() const
UsdStagePtr UsdStageWeakPtr
Definition: common.h:55
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
UsdRenderSettings(const UsdPrim &prim=UsdPrim())
Definition: settings.h:72
static const UsdSchemaKind schemaKind
Definition: settings.h:66
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
virtual USDRENDER_API ~UsdRenderSettings()
Destructor.
static USDRENDER_API UsdRenderSettings Define(const UsdStagePtr &stage, const SdfPath &path)
Definition: value.h:166
static USDRENDER_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)