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

#include <product.h>

+ Inheritance diagram for UsdRenderProduct:

Public Member Functions

 UsdRenderProduct (const UsdPrim &prim=UsdPrim())
 
 UsdRenderProduct (const UsdSchemaBase &schemaObj)
 
virtual USDRENDER_API ~UsdRenderProduct ()
 Destructor. More...
 
USDRENDER_API UsdAttribute GetProductTypeAttr () const
 
USDRENDER_API UsdAttribute CreateProductTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdAttribute GetProductNameAttr () const
 
USDRENDER_API UsdAttribute CreateProductNameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdRelationship GetOrderedVarsRel () const
 
USDRENDER_API UsdRelationship CreateOrderedVarsRel () const
 
- Public Member Functions inherited from UsdRenderSettingsBase
 UsdRenderSettingsBase (const UsdPrim &prim=UsdPrim())
 
 UsdRenderSettingsBase (const UsdSchemaBase &schemaObj)
 
virtual USDRENDER_API ~UsdRenderSettingsBase ()
 Destructor. More...
 
USDRENDER_API UsdAttribute GetResolutionAttr () const
 
USDRENDER_API UsdAttribute CreateResolutionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdAttribute GetPixelAspectRatioAttr () const
 
USDRENDER_API UsdAttribute CreatePixelAspectRatioAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdAttribute GetAspectRatioConformPolicyAttr () const
 
USDRENDER_API UsdAttribute CreateAspectRatioConformPolicyAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdAttribute GetDataWindowNDCAttr () const
 
USDRENDER_API UsdAttribute CreateDataWindowNDCAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdAttribute GetInstantaneousShutterAttr () const
 
USDRENDER_API UsdAttribute CreateInstantaneousShutterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRENDER_API UsdRelationship GetCameraRel () const
 
USDRENDER_API UsdRelationship CreateCameraRel () const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
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
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDRENDER_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRENDER_API
UsdRenderProduct 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRENDER_API
UsdRenderProduct 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdRenderSettingsBase
static USDRENDER_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRENDER_API
UsdRenderSettingsBase 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdRenderSettingsBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDRENDER_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdRenderSettingsBase
USDRENDER_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 
- 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 UsdRenderProduct describes an image or other file-like artifact produced by a render. A RenderProduct combines one or more RenderVars into a file or interactive buffer. It also provides all the controls established in UsdRenderSettingsBase as optional overrides to whatever the owning UsdRenderSettings prim dictates.

Specific renderers may support additional settings, such as a way to configure compression settings, filetype metadata, and so forth. Such settings can be encoded using renderer-specific API schemas applied to the product prim.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdRenderTokens. So to set an attribute to the value "rightHanded", use UsdRenderTokens->rightHanded as the value.

Definition at line 73 of file product.h.

Constructor & Destructor Documentation

UsdRenderProduct::UsdRenderProduct ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 85 of file product.h.

UsdRenderProduct::UsdRenderProduct ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRenderProduct on the prim held by schemaObj . Should be preferred over UsdRenderProduct(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 93 of file product.h.

virtual USDRENDER_API UsdRenderProduct::~UsdRenderProduct ( )
virtual

Destructor.

Member Function Documentation

USDRENDER_API UsdSchemaType UsdRenderProduct::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

USDRENDER_API UsdRelationship UsdRenderProduct::CreateOrderedVarsRel ( ) const

See GetOrderedVarsRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create

USDRENDER_API UsdAttribute UsdRenderProduct::CreateProductNameAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetProductNameAttr(), and also Usd_Create_Or_Get_Property 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 UsdRenderProduct::CreateProductTypeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetProductTypeAttr(), and also Usd_Create_Or_Get_Property 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.

static USDRENDER_API UsdRenderProduct UsdRenderProduct::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 UsdRenderProduct UsdRenderProduct::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdRenderProduct 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:

UsdRenderProduct(stage->GetPrimAtPath(path));
USDRENDER_API UsdRelationship UsdRenderProduct::GetOrderedVarsRel ( ) const

Specifies the RenderVars that should be consumed and combined into the final product. If ordering is relevant to the output driver, then the ordering of targets in this relationship provides the order to use.

USDRENDER_API UsdAttribute UsdRenderProduct::GetProductNameAttr ( ) const

Specifies the name that the output/display driver should give the product. This is provided as-authored to the driver, whose responsibility it is to situate the product on a filesystem or other storage, in the desired location.

Declaration token productName = ""
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
USDRENDER_API UsdAttribute UsdRenderProduct::GetProductTypeAttr ( ) const

The type of output to produce. The default, "raster", indicates a 2D image.

ote In the future, UsdRender may define additional product types.

Declaration uniform token productType = "raster"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
static USDRENDER_API const TfTokenVector& UsdRenderProduct::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 157 of file product.h.

Member Data Documentation

const UsdSchemaType UsdRenderProduct::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 79 of file product.h.


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