All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRenderSettings Class Reference

A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of the RenderProducts that should result, and the UsdGeomImageable purposes that should be rendered. More...

+ Inheritance diagram for UsdRenderSettings:

Public Member Functions

 UsdRenderSettings (const UsdPrim &prim=UsdPrim())
 Construct a UsdRenderSettings on UsdPrim prim . More...
 
 UsdRenderSettings (const UsdSchemaBase &schemaObj)
 Construct a UsdRenderSettings on the prim held by schemaObj . More...
 
virtual USDRENDER_API ~UsdRenderSettings ()
 Destructor. More...
 
USDRENDER_API UsdAttribute GetIncludedPurposesAttr () const
 The list of UsdGeomImageable purpose values that should be included in the render. More...
 
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. More...
 
USDRENDER_API UsdAttribute GetMaterialBindingPurposesAttr () const
 Ordered list of material purposes to consider when resolving material bindings in the scene. More...
 
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 Create. More...
 
USDRENDER_API UsdRelationship GetProductsRel () const
 The set of RenderProducts the render should produce. More...
 
USDRENDER_API UsdRelationship CreateProductsRel () const
 See GetProductsRel(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
- Public Member Functions inherited from UsdRenderSettingsBase
 UsdRenderSettingsBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdRenderSettingsBase on UsdPrim prim . More...
 
 UsdRenderSettingsBase (const UsdSchemaBase &schemaObj)
 Construct a UsdRenderSettingsBase on the prim held by schemaObj . More...
 
virtual USDRENDER_API ~UsdRenderSettingsBase ()
 Destructor. More...
 
USDRENDER_API UsdAttribute GetResolutionAttr () const
 The image pixel resolution, corresponding to the camera's screen window. More...
 
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. More...
 
USDRENDER_API UsdAttribute GetPixelAspectRatioAttr () const
 The aspect ratio (width/height) of image pixels. More...
 
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. More...
 
USDRENDER_API UsdAttribute GetAspectRatioConformPolicyAttr () const
 Indicates the policy to use to resolve an aspect ratio mismatch between the camera aperture and image settings. More...
 
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 Create. More...
 
USDRENDER_API UsdAttribute GetDataWindowNDCAttr () const
 dataWindowNDC specifies the axis-aligned rectangular region in the adjusted aperture window within which the renderer should produce data. More...
 
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. More...
 
USDRENDER_API UsdAttribute GetInstantaneousShutterAttr () const
 Override the targeted camera's shutterClose to be equal to the value of its shutterOpen, to produce a zero-width shutter interval. More...
 
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 Create. More...
 
USDRENDER_API UsdRelationship GetCameraRel () const
 The camera relationship specifies the primary camera to use in a render. More...
 
USDRENDER_API UsdRelationship CreateCameraRel () const
 See GetCameraRel(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 Construct a UsdTyped on UsdPrim prim . More...
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 Construct a UsdTyped on the prim wrapped by schemaObj . More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
UsdSchemaType GetSchemaType () const
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 Return true if this schema object is compatible with its held prim, false otherwise. More...
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API SdfPrimSpecHandle GetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

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 classes. More...
 
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. More...
 
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::IsDefined()) on this stage. More...
 
static USDRENDER_API
UsdRenderSettings 
GetStageRenderSettings (const UsdStageWeakPtr &stage)
 Fetch and return stage 's render settings, as indicated by root layer metadata. More...
 
- Static Public Member Functions inherited from UsdRenderSettingsBase
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 classes. More...
 
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. More...
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdTyped holding the prim adhering to this schema at path on stage. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdRenderSettingsBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDRENDER_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdRenderSettingsBase
USDRENDER_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More...
 
- Protected Member Functions inherited from UsdSchemaBase
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of the RenderProducts that should result, and the UsdGeomImageable purposes that should be rendered.

How settings affect rendering

Definition at line 63 of file settings.h.

Constructor & Destructor Documentation

UsdRenderSettings ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRenderSettings on UsdPrim prim .

Equivalent to UsdRenderSettings::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 75 of file settings.h.

UsdRenderSettings ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRenderSettings on the prim held by schemaObj .

Should be preferred over UsdRenderSettings(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 83 of file settings.h.

virtual USDRENDER_API ~UsdRenderSettings ( )
virtual

Destructor.

Member Function Documentation

USDRENDER_API UsdSchemaType _GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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 Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRENDER_API UsdRelationship CreateProductsRel ( ) const

See GetProductsRel(), and also Create vs Get Property Methods for when to use Get vs Create.

static USDRENDER_API UsdRenderSettings Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDRENDER_API UsdRenderSettings Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdRenderSettings holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

* UsdRenderSettings(stage->GetPrimAtPath(path));
*
USDRENDER_API UsdAttribute GetIncludedPurposesAttr ( ) const

The list of UsdGeomImageable purpose values that should be included in the render.

Note this cannot be specified per-RenderProduct because it is a statement of which geometry is present.

Declaration uniform token[] includedPurposes = ["default", "render"]
C++ Type VtArray<TfToken>
Usd Type SdfValueTypeNames->TokenArray
Variability SdfVariabilityUniform
USDRENDER_API UsdAttribute GetMaterialBindingPurposesAttr ( ) const

Ordered list of material purposes to consider when resolving material bindings in the scene.

The empty string indicates the "allPurpose" binding.

Declaration uniform token[] materialBindingPurposes = ["full", ""]
C++ Type VtArray<TfToken>
Usd Type SdfValueTypeNames->TokenArray
Variability SdfVariabilityUniform
Allowed Values full, preview, ""
USDRENDER_API UsdRelationship GetProductsRel ( ) const

The set of RenderProducts the render should produce.

This relationship should target UsdRenderProduct prims. If no products are specified, an application should produce an rgb image according to the RenderSettings configuration, to a default display or image name.

static USDRENDER_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static USDRENDER_API UsdRenderSettings GetStageRenderSettings ( const UsdStageWeakPtr &  stage)
static

Fetch and return stage 's render settings, as indicated by root layer metadata.

If unauthored, or the metadata does not refer to a valid UsdRenderSettings prim, this will return an invalid UsdRenderSettings prim.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaType

Definition at line 69 of file settings.h.


The documentation for this class was generated from the following file: