|
HDK
|
#include <product.h>
Inheritance diagram for UsdRenderProduct: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 USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
| Static Public Attributes inherited from UsdRenderSettingsBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdTyped | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
| USDRENDER_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdRenderSettingsBase | |
| USDRENDER_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdTyped | |
| USD_API bool | _IsCompatible () const override |
| Protected Member Functions inherited from UsdSchemaBase | |
| virtual UsdSchemaKind | _GetSchemaType () const |
| 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 |
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.
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
|
inlineexplicit |
Construct a UsdRenderProduct on the prim held by schemaObj . Should be preferred over UsdRenderProduct(schemaObj.GetPrim()), as it preserves SchemaBase state.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdTyped.
| 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 |
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 |
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:
| 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.
| Declaration | uniform token productType = "raster" |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Variability | SdfVariabilityUniform |
|
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.
|
friend |
|
static |
Compile time constant representing what kind of schema this class is.
1.8.6 
