usdrt::UsdUIBackdrop

Defined in usdrt/scenegraph/usd/usdUI/backdrop.h

Functions

usdrt::UsdUIBackdrop::CreateDescriptionAttr: See GetDescriptionAttr() , and also Create vs Get Property Methods 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 .
usdrt::UsdUIBackdrop::Define: Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
usdrt::UsdUIBackdrop::GetDescriptionAttr: The text label that is displayed on the backdrop in the node graph. This help-description explains what the nodes in a backdrop do.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdUIBackdrop::UsdUIBackdrop: Construct a UsdUIBackdrop on UsdPrim prim . Equivalent to UsdUIBackdrop::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdUIBackdrop::UsdUIBackdrop: Construct a UsdUIBackdrop on the prim held by schemaObj . Should be preferred over UsdUIBackdrop (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdUIBackdrop::operator bool: Boolean operator.
usdrt::UsdUIBackdrop::~UsdUIBackdrop: Destructor.

Variables

usdrt::UsdUIBackdrop::schemaType: Compile time constant representing what kind of schema this class is.

class UsdUIBackdrop : public usdrt::UsdTyped 

Provides a ‘group-box’ for the purpose of node graph organization.

Unlike containers, backdrops do not store the Shader nodes inside of them. Backdrops are an organizational tool that allows Shader nodes to be visually grouped together in a node-graph UI, but there is no direct relationship between a Shader node and a Backdrop.

The guideline for a node-graph UI is that a Shader node is considered part of a Backdrop when the Backdrop is the smallest Backdrop a Shader node’s bounding-box fits inside.

Backdrop objects are contained inside a NodeGraph, similar to how Shader objects are contained inside a NodeGraph.

Backdrops have no shading inputs or outputs that influence the rendered results of a NodeGraph. Therefore they can be safely ignored during import.

Like Shaders and NodeGraphs, Backdrops subscribe to the NodeGraphNodeAPI to specify position and size.

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

Public Functions

inline explicit UsdUIBackdrop(const UsdPrim &prim = UsdPrim()): Construct a UsdUIBackdrop on UsdPrim prim. Equivalent to UsdUIBackdrop::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdUIBackdrop(const UsdSchemaBase &schemaObj): Construct a UsdUIBackdrop on the prim held by schemaObj . Should be preferred over UsdUIBackdrop(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdUIBackdrop(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

inline UsdAttribute GetDescriptionAttr() const

The text label that is displayed on the backdrop in the node graph. This help-description explains what the nodes in a backdrop do.


Declaration	`uniform token ui:description`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

inline UsdAttribute CreateDescriptionAttr() const: See GetDescriptionAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline UsdUIBackdrop Define(const UsdStageRefPtr &stage, const SdfPath &path): Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped 

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