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

#include <aOVSettingsAPI.h>

+ Inheritance diagram for usdKarmaAOVSettingsAPI:

Public Member Functions

 usdKarmaAOVSettingsAPI (const UsdPrim &prim=UsdPrim())
 
 usdKarmaAOVSettingsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDKARMA_API ~usdKarmaAOVSettingsAPI () override
 Destructor. More...
 
USDKARMA_API UsdAttribute GetDriverParametersAovCryptomatteAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovCryptomatteAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovCryptomatterankAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovCryptomatterankAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovCryptomattesidecarAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovCryptomattesidecarAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovDefaultvalueAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovDefaultvalueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovDisableAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovDisableAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovDitherAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovDitherAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovExclude_dcmAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovExclude_dcmAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovFilenameAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovFilenameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovFilterAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovFilterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetDriverParametersAovSamplingAttr () const
 
USDKARMA_API UsdAttribute CreateDriverParametersAovSamplingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- 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 USDKARMA_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDKARMA_API
usdKarmaAOVSettingsAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDKARMA_API
usdKarmaAOVSettingsAPI 
Apply (const UsdPrim &prim)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDKARMA_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaType _GetSchemaType () const override
 
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 

Detailed Description

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

Definition at line 60 of file aOVSettingsAPI.h.

Constructor & Destructor Documentation

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

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

Definition at line 72 of file aOVSettingsAPI.h.

usdKarmaAOVSettingsAPI::usdKarmaAOVSettingsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 80 of file aOVSettingsAPI.h.

usdKarmaAOVSettingsAPI::~usdKarmaAOVSettingsAPI ( )
overridevirtual

Destructor.

Definition at line 43 of file aOVSettingsAPI.cpp.

Member Function Documentation

UsdSchemaType usdKarmaAOVSettingsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

Definition at line 60 of file aOVSettingsAPI.cpp.

usdKarmaAOVSettingsAPI usdKarmaAOVSettingsAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "KarmaAOVSettingsAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid usdKarmaAOVSettingsAPI object is returned upon success. An invalid (or empty) usdKarmaAOVSettingsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

Definition at line 66 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovCryptomatteAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovCryptomatteAttr(), 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.

Definition at line 104 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovCryptomatterankAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovCryptomatterankAttr(), 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.

Definition at line 121 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovCryptomattesidecarAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovCryptomattesidecarAttr(), 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.

Definition at line 138 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovDefaultvalueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovDefaultvalueAttr(), 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.

Definition at line 155 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovDisableAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovDisableAttr(), 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.

Definition at line 172 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovDitherAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovDitherAttr(), 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.

Definition at line 189 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovExclude_dcmAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovExclude_dcmAttr(), 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.

Definition at line 206 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovFilenameAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovFilenameAttr(), 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.

Definition at line 223 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovFilterAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovFilterAttr(), 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.

Definition at line 240 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::CreateDriverParametersAovSamplingAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDriverParametersAovSamplingAttr(), 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.

Definition at line 257 of file aOVSettingsAPI.cpp.

usdKarmaAOVSettingsAPI usdKarmaAOVSettingsAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

usdKarmaAOVSettingsAPI(stage->GetPrimAtPath(path));

Definition at line 49 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovCryptomatteAttr ( ) const
Declaration bool driver:parameters:aov:cryptomatte = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 98 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovCryptomatterankAttr ( ) const
Declaration int driver:parameters:aov:cryptomatterank = 6
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 115 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovCryptomattesidecarAttr ( ) const
Declaration string driver:parameters:aov:cryptomattesidecar = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 132 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovDefaultvalueAttr ( ) const

This is the clear color for the image plane.

Declaration float driver:parameters:aov:defaultvalue = 0
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 149 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovDisableAttr ( ) const
Declaration bool driver:parameters:aov:disable = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 166 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovDitherAttr ( ) const

When Karma quantizes pixels to 8 or 16 bit integer channels, this specifies the dithering to be used. This is only done if the AOV is specified as 8/16 bit output depth. It will not be done if conversion is done when writing floating point values to an image format that only supports 8/16 bit integer channel data.

Declaration float driver:parameters:aov:dither = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 183 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovExclude_dcmAttr ( ) const
Declaration bool driver:parameters:aov:exclude_dcm = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 200 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovFilenameAttr ( ) const
Declaration string driver:parameters:aov:filename = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 217 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovFilterAttr ( ) const

Image plane pixel filters are used to combine multiple samples into a single pixel color. For example, the filter may choose a single sample (closest to the camera, or maximum value), or most commonly, the pixel filter will choose to average the sample values. This parameter specifies a list of filters. These filters are specified as a JSON list.

Declaration string driver:parameters:aov:filter = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 234 of file aOVSettingsAPI.cpp.

UsdAttribute usdKarmaAOVSettingsAPI::GetDriverParametersAovSamplingAttr ( ) const

Indicates whether to average multiple samples into the final color or whether to use the first ray that hits an object. This setting is deprecated in favor of image plane pixel filters.

Declaration token driver:parameters:aov:sampling = "average"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values average, znear, zfar

Definition at line 251 of file aOVSettingsAPI.cpp.

const TfTokenVector & usdKarmaAOVSettingsAPI::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.

Definition at line 281 of file aOVSettingsAPI.cpp.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 137 of file aOVSettingsAPI.h.

Member Data Documentation

const UsdSchemaType usdKarmaAOVSettingsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 66 of file aOVSettingsAPI.h.


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