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

#include <sceneGraphPrimAPI.h>

+ Inheritance diagram for UsdUISceneGraphPrimAPI:

Public Member Functions

 UsdUISceneGraphPrimAPI (const UsdPrim &prim=UsdPrim())
 
 UsdUISceneGraphPrimAPI (const UsdSchemaBase &schemaObj)
 
virtual USDUI_API ~UsdUISceneGraphPrimAPI ()
 Destructor. More...
 
USDUI_API UsdAttribute GetDisplayNameAttr () const
 
USDUI_API UsdAttribute CreateDisplayNameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDUI_API UsdAttribute GetDisplayGroupAttr () const
 
USDUI_API UsdAttribute CreateDisplayGroupAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- 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
 
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
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDUI_API
UsdUISceneGraphPrimAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDUI_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
 
static USDUI_API
UsdUISceneGraphPrimAPI 
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 UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
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 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
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
 

Friends

class UsdSchemaRegistry
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
 

Detailed Description

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.

Definition at line 64 of file sceneGraphPrimAPI.h.

Constructor & Destructor Documentation

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

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

Definition at line 76 of file sceneGraphPrimAPI.h.

UsdUISceneGraphPrimAPI::UsdUISceneGraphPrimAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 84 of file sceneGraphPrimAPI.h.

virtual USDUI_API UsdUISceneGraphPrimAPI::~UsdUISceneGraphPrimAPI ( )
virtual

Destructor.

Member Function Documentation

USDUI_API UsdSchemaKind UsdUISceneGraphPrimAPI::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDUI_API UsdUISceneGraphPrimAPI UsdUISceneGraphPrimAPI::Apply ( const UsdPrim prim)
static

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.

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.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static USDUI_API bool UsdUISceneGraphPrimAPI::CanApply ( const UsdPrim prim,
std::string whyNot = nullptr 
)
static

Returns true if this single-apply API schema can be applied to the given prim. If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
USDUI_API UsdAttribute UsdUISceneGraphPrimAPI::CreateDisplayGroupAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDisplayGroupAttr(), 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.

USDUI_API UsdAttribute UsdUISceneGraphPrimAPI::CreateDisplayNameAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDisplayNameAttr(), 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 UsdUISceneGraphPrimAPI UsdUISceneGraphPrimAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

UsdUISceneGraphPrimAPI(stage->GetPrimAtPath(path));
USDUI_API UsdAttribute UsdUISceneGraphPrimAPI::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
USDUI_API UsdAttribute UsdUISceneGraphPrimAPI::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
static USDUI_API const TfTokenVector& UsdUISceneGraphPrimAPI::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 162 of file sceneGraphPrimAPI.h.

Member Data Documentation

const UsdSchemaKind UsdUISceneGraphPrimAPI::schemaKind = UsdSchemaKind::SingleApplyAPI
static

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

See Also
UsdSchemaKind

Definition at line 70 of file sceneGraphPrimAPI.h.


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