UsdRenderSettingsAPI

Fully qualified name: usdrt::UsdRenderSettingsAPI

class UsdRenderSettingsAPI : public usdrt::UsdAPISchemaBase

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

Public Functions

inline explicit UsdRenderSettingsAPI(const UsdPrim &prim = UsdPrim())

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.

inline explicit UsdRenderSettingsAPI(const UsdSchemaBase &schemaObj)

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

inline virtual ~UsdRenderSettingsAPI()

Destructor.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

inline explicit operator bool() const

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.

See also

UsdSchemaBase::_IsCompatible()

Returns:

True if the help prim is valid, and the schema object is compatible with its held prim.

Public Static Functions

static inline const TfToken _GetStaticTfType()

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.

inline virtual bool _IsCompatible() const

Check whether this APISchema object is valid for the currently held prim.

If this is an applied API schema, this returns true if the held prim is valid and already has the API schema applied to it, along with the instanceName (in the case of multiple-apply). The instanceName should not be empty in the case of a multiple-apply API schema.

This check is performed when clients invoke the explicit bool conversion operator, implemented in UsdSchemaBase.

See also

UsdPrim::HasAPI()

inline const TfToken _GetType() const

Helper for subclasses to get this schema’s type token.

Note

This diverges from Usd and returns a TfToken, since we don’t implements TfType.

Returns:

The token representing the schema’s TfType.