settingsBase.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_SETTINGSBASE_H
25 #define USDRENDER_GENERATED_SETTINGSBASE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRender/api.h"
31 #include "pxr/usd/usd/typed.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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RENDERSETTINGSBASE //
51 // -------------------------------------------------------------------------- //
52 
65 {
66 public:
71 
76  explicit UsdRenderSettingsBase(const UsdPrim& prim=UsdPrim())
77  : UsdTyped(prim)
78  {
79  }
80 
84  explicit UsdRenderSettingsBase(const UsdSchemaBase& schemaObj)
85  : UsdTyped(schemaObj)
86  {
87  }
88 
90  USDRENDER_API
91  virtual ~UsdRenderSettingsBase();
92 
96  USDRENDER_API
97  static const TfTokenVector &
98  GetSchemaAttributeNames(bool includeInherited=true);
99 
109  USDRENDER_API
110  static UsdRenderSettingsBase
111  Get(const UsdStagePtr &stage, const SdfPath &path);
112 
113 
114 protected:
118  USDRENDER_API
119  UsdSchemaKind _GetSchemaKind() const override;
120 
121 private:
122  // needs to invoke _GetStaticTfType.
123  friend class UsdSchemaRegistry;
124  USDRENDER_API
125  static const TfType &_GetStaticTfType();
126 
127  static bool _IsTypedSchema();
128 
129  // override SchemaBase virtuals.
130  USDRENDER_API
131  const TfType &_GetTfType() const override;
132 
133 public:
134  // --------------------------------------------------------------------- //
135  // RESOLUTION
136  // --------------------------------------------------------------------- //
146  USDRENDER_API
148 
154  USDRENDER_API
155  UsdAttribute CreateResolutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // PIXELASPECTRATIO
160  // --------------------------------------------------------------------- //
170  USDRENDER_API
172 
178  USDRENDER_API
179  UsdAttribute CreatePixelAspectRatioAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180 
181 public:
182  // --------------------------------------------------------------------- //
183  // ASPECTRATIOCONFORMPOLICY
184  // --------------------------------------------------------------------- //
217  USDRENDER_API
219 
225  USDRENDER_API
226  UsdAttribute CreateAspectRatioConformPolicyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
227 
228 public:
229  // --------------------------------------------------------------------- //
230  // DATAWINDOWNDC
231  // --------------------------------------------------------------------- //
269  USDRENDER_API
271 
277  USDRENDER_API
278  UsdAttribute CreateDataWindowNDCAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
279 
280 public:
281  // --------------------------------------------------------------------- //
282  // INSTANTANEOUSSHUTTER
283  // --------------------------------------------------------------------- //
296  USDRENDER_API
298 
304  USDRENDER_API
305  UsdAttribute CreateInstantaneousShutterAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
306 
307 public:
308  // --------------------------------------------------------------------- //
309  // DISABLEMOTIONBLUR
310  // --------------------------------------------------------------------- //
321  USDRENDER_API
323 
329  USDRENDER_API
330  UsdAttribute CreateDisableMotionBlurAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
331 
332 public:
333  // --------------------------------------------------------------------- //
334  // CAMERA
335  // --------------------------------------------------------------------- //
339  USDRENDER_API
341 
344  USDRENDER_API
346 
347 public:
348  // ===================================================================== //
349  // Feel free to add custom code below this line, it will be preserved by
350  // the code generator.
351  //
352  // Just remember to:
353  // - Close the class declaration with };
354  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
355  // - Close the include guard with #endif
356  // ===================================================================== //
357  // --(BEGIN CUSTOM CODE)--
358 };
359 
360 PXR_NAMESPACE_CLOSE_SCOPE
361 
362 #endif
USDRENDER_API UsdAttribute CreateDataWindowNDCAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDataWindowNDCAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdRenderSettingsBase(const UsdSchemaBase &schemaObj)
Construct a UsdRenderSettingsBase on the prim held by schemaObj .
Definition: settingsBase.h:84
USDRENDER_API UsdAttribute GetResolutionAttr() const
The image pixel resolution, corresponding to the camera's screen window.
USDRENDER_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDRENDER_API UsdAttribute GetInstantaneousShutterAttr() const
Deprecated - use disableMotionBlur instead.
USDRENDER_API UsdAttribute CreatePixelAspectRatioAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPixelAspectRatioAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDRENDER_API UsdAttribute CreateInstantaneousShutterAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInstantaneousShutterAttr(), and also Create vs Get Property Methods for when to use Get vs Cre...
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDRENDER_API UsdAttribute GetDisableMotionBlurAttr() const
Disable all motion blur by setting the shutter interval of the targeted camera to [0,...
Abstract base class that defines render settings that can be specified on either a RenderSettings pri...
Definition: settingsBase.h:64
static USDRENDER_API UsdRenderSettingsBase Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRenderSettingsBase holding the prim adhering to this schema at path on stage.
USDRENDER_API UsdAttribute GetAspectRatioConformPolicyAttr() const
Indicates the policy to use to resolve an aspect ratio mismatch between the camera aperture and image...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDRENDER_API UsdRelationship CreateCameraRel() const
See GetCameraRel(), and also Create vs Get Property Methods for when to use Get vs Create.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: settingsBase.h:70
virtual USDRENDER_API ~UsdRenderSettingsBase()
Destructor.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDRENDER_API UsdAttribute GetDataWindowNDCAttr() const
dataWindowNDC specifies the axis-aligned rectangular region in the adjusted aperture window within wh...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
UsdRenderSettingsBase(const UsdPrim &prim=UsdPrim())
Construct a UsdRenderSettingsBase on UsdPrim prim .
Definition: settingsBase.h:76
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDRENDER_API UsdAttribute CreateDisableMotionBlurAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisableMotionBlurAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Represents a non-concrete typed schema.
USDRENDER_API UsdAttribute CreateAspectRatioConformPolicyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAspectRatioConformPolicyAttr(), and also Create vs Get Property Methods for when to use Get vs...
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDRENDER_API UsdAttribute GetPixelAspectRatioAttr() const
The aspect ratio (width/height) of image pixels.
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 UsdRelationship GetCameraRel() const
The camera relationship specifies the primary camera to use in a render.
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:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
USDRENDER_API UsdAttribute CreateResolutionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetResolutionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.