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

#include <backdrop.h>

+ Inheritance diagram for UsdUIBackdrop:

Public Member Functions

 UsdUIBackdrop (const UsdPrim &prim=UsdPrim())
 UsdUIBackdrop (const UsdSchemaBase &schemaObj)
virtual USDUI_API ~UsdUIBackdrop ()
 Destructor. More...
USDUI_API UsdAttribute GetDescriptionAttr () const
USDUI_API UsdAttribute CreateDescriptionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API ~UsdTyped ()
- 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
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
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 USDUI_API const
GetSchemaAttributeNames (bool includeInherited=true)
static USDUI_API UsdUIBackdrop Get (const UsdStagePtr &stage, const SdfPath &path)
static USDUI_API UsdUIBackdrop Define (const UsdStagePtr &stage, const SdfPath &path)
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped
- 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

USDUI_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


class UsdSchemaRegistry

Detailed Description

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.

Definition at line 81 of file backdrop.h.

Constructor & Destructor Documentation

UsdUIBackdrop::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

Definition at line 93 of file backdrop.h.

UsdUIBackdrop::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.

Definition at line 101 of file backdrop.h.

virtual USDUI_API UsdUIBackdrop::~UsdUIBackdrop ( )


Member Function Documentation

USDUI_API UsdSchemaKind UsdUIBackdrop::_GetSchemaKind ( ) const

Returns the kind of schema this class belongs to.

See Also

Reimplemented from UsdSchemaBase.

USDUI_API UsdAttribute UsdUIBackdrop::CreateDescriptionAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDescriptionAttr(), 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 USDUI_API UsdUIBackdrop UsdUIBackdrop::Define ( const UsdStagePtr &  stage,
const SdfPath path 

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 USDUI_API UsdUIBackdrop UsdUIBackdrop::Get ( const UsdStagePtr &  stage,
const SdfPath path 

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

USDUI_API UsdAttribute UsdUIBackdrop::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
static USDUI_API const TfTokenVector& UsdUIBackdrop::GetSchemaAttributeNames ( bool  includeInherited = true)

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

Definition at line 165 of file backdrop.h.

Member Data Documentation

const UsdSchemaKind UsdUIBackdrop::schemaKind = UsdSchemaKind::ConcreteTyped

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

See Also

Definition at line 87 of file backdrop.h.

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