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

#include <settingsAPI.h>

+ Inheritance diagram for UsdRenderSettingsAPI:

Public Member Functions

 UsdRenderSettingsAPI (const UsdPrim &prim=UsdPrim())
 
 UsdRenderSettingsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDRENDER_API ~UsdRenderSettingsAPI ()
 Destructor. More...
 
- 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 USDRENDER_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRENDER_API
UsdRenderSettingsAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRENDER_API
UsdRenderSettingsAPI 
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

USDRENDER_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
 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

UsdRenderSettingsAPI is a base class for API schemas to encode renderer-specific settings.

Definition at line 57 of file settingsAPI.h.

Constructor & Destructor Documentation

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

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

Definition at line 69 of file settingsAPI.h.

UsdRenderSettingsAPI::UsdRenderSettingsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 77 of file settingsAPI.h.

virtual USDRENDER_API UsdRenderSettingsAPI::~UsdRenderSettingsAPI ( )
virtual

Destructor.

Member Function Documentation

USDRENDER_API UsdSchemaType UsdRenderSettingsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdAPISchemaBase.

static USDRENDER_API UsdRenderSettingsAPI UsdRenderSettingsAPI::Apply ( const UsdPrim prim)
static

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

Returns
A valid UsdRenderSettingsAPI object is returned upon success. An invalid (or empty) UsdRenderSettingsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static USDRENDER_API UsdRenderSettingsAPI UsdRenderSettingsAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

UsdRenderSettingsAPI(stage->GetPrimAtPath(path));
static USDRENDER_API const TfTokenVector& UsdRenderSettingsAPI::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 134 of file settingsAPI.h.

Member Data Documentation

const UsdSchemaType UsdRenderSettingsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 63 of file settingsAPI.h.


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