usdrt::UsdUISceneGraphPrimAPI

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

Functions

usdrt::UsdUISceneGraphPrimAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "SceneGraphPrimAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::UsdUISceneGraphPrimAPI::CreateDisplayGroupAttr: See GetDisplayGroupAttr() , 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::UsdUISceneGraphPrimAPI::CreateDisplayNameAttr: See GetDisplayNameAttr() , 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::UsdUISceneGraphPrimAPI::GetDisplayGroupAttr: When publishing a nodegraph or a material, it can be useful to provide an optional display group, for organizational purposes and readability. This is because often the usd shading hierarchy is rather flat while we want to display it in organized groups.
usdrt::UsdUISceneGraphPrimAPI::GetDisplayNameAttr: When publishing a nodegraph or a material, it can be useful to provide an optional display name, for readability.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdUISceneGraphPrimAPI::UsdUISceneGraphPrimAPI: Construct a UsdUISceneGraphPrimAPI on UsdPrim prim . Equivalent to UsdUISceneGraphPrimAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdUISceneGraphPrimAPI::UsdUISceneGraphPrimAPI: Construct a UsdUISceneGraphPrimAPI on the prim held by schemaObj . Should be preferred over UsdUISceneGraphPrimAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdUISceneGraphPrimAPI::operator bool: Boolean operator.
usdrt::UsdUISceneGraphPrimAPI::~UsdUISceneGraphPrimAPI: Destructor.

Variables

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

class UsdUISceneGraphPrimAPI : public usdrt::UsdAPISchemaBase 

/// Utility schema for display properties of a prim

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 UsdUISceneGraphPrimAPI(const UsdPrim &prim = UsdPrim()): Construct a UsdUISceneGraphPrimAPI on UsdPrim prim. Equivalent to UsdUISceneGraphPrimAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

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

inline virtual ~UsdUISceneGraphPrimAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetDisplayNameAttr() const

When publishing a nodegraph or a material, it can be useful to provide an optional display name, for readability.


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

inline UsdAttribute CreateDisplayNameAttr() const: See GetDisplayNameAttr(), 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.

inline UsdAttribute GetDisplayGroupAttr() const

When publishing a nodegraph or a material, it can be useful to provide an optional display group, for organizational purposes and readability. This is because often the usd shading hierarchy is rather flat while we want to display it in organized groups.


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

inline UsdAttribute CreateDisplayGroupAttr() const: See GetDisplayGroupAttr(), 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 UsdUISceneGraphPrimAPI Apply(const UsdPrim &prim)

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

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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

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.