UsdUI module#

Summary: The UsdUI module provides schemas for encoding information on USD prims for client GUI tools to use in organizing/presenting prims in GUI layouts.

Classes:

`AccessibilityAPI`
`AttributeHints`
`Backdrop`
`HintKeys`
`NodeGraphNodeAPI`
`ObjectHints`
`PrimHints`
`PropertyHints`
`SceneGraphPrimAPI`
`Tokens`

class pxr.UsdUI.AccessibilityAPI#

Methods:

`Apply`
`ApplyDefaultAPI`
`CanApply`
`CreateDefaultAPI`
`CreateDescriptionAttr`
`CreateLabelAttr`
`CreatePriorityAttr`
`Get`
`GetAll`
`GetDescriptionAttr`
`GetLabelAttr`
`GetPriorityAttr`
`GetSchemaAttributeNames`
`IsAccessibilityAPIPath`

static Apply()#

static ApplyDefaultAPI()#

static CanApply()#

static CreateDefaultAPI()#

CreateDescriptionAttr()#

CreateLabelAttr()#

CreatePriorityAttr()#

static Get()#

static GetAll()#

GetDescriptionAttr()#

GetLabelAttr()#

GetPriorityAttr()#

static GetSchemaAttributeNames()#

static IsAccessibilityAPIPath()#

class pxr.UsdUI.AttributeHints#

Methods:

`ApplyValueLabel`
`GetAttribute`
`GetValueLabels`
`GetValueLabelsOrder`
`SetValueLabels`
`SetValueLabelsOrder`

ApplyValueLabel()#

GetAttribute()#

GetValueLabels()#

GetValueLabelsOrder()#

SetValueLabels()#

SetValueLabelsOrder()#

class pxr.UsdUI.Backdrop#

Methods:

`CreateDescriptionAttr`
`Define`
`Get`
`GetDescriptionAttr`
`GetSchemaAttributeNames`

CreateDescriptionAttr()#

static Define()#

static Get()#

GetDescriptionAttr()#

static GetSchemaAttributeNames()#

class pxr.UsdUI.HintKeys#

Attributes:

`DisplayGroup`
`DisplayGroupsExpanded`
`DisplayGroupsShownIf`
`DisplayName`
`Hidden`
`ShownIf`
`UIHints`
`ValueLabels`
`ValueLabelsOrder`

DisplayGroup = 'displayGroup'#

DisplayGroupsExpanded = 'displayGroupsExpanded'#

DisplayGroupsShownIf = 'displayGroupsShownIf'#

DisplayName = 'displayName'#

Hidden = 'hidden'#

ShownIf = 'shownIf'#

UIHints = 'uiHints'#

ValueLabels = 'valueLabels'#

ValueLabelsOrder = 'valueLabelsOrder'#

class pxr.UsdUI.NodeGraphNodeAPI#

Methods:

`Apply`
`CanApply`
`CreateDisplayColorAttr`
`CreateDocURIAttr`
`CreateExpansionStateAttr`
`CreateIconAttr`
`CreatePosAttr`
`CreateSizeAttr`
`CreateStackingOrderAttr`
`Get`
`GetDisplayColorAttr`
`GetDocURIAttr`
`GetExpansionStateAttr`
`GetIconAttr`
`GetPosAttr`
`GetSchemaAttributeNames`
`GetSizeAttr`
`GetStackingOrderAttr`

static Apply()#

static CanApply()#

CreateDisplayColorAttr()#

CreateDocURIAttr()#

CreateExpansionStateAttr()#

CreateIconAttr()#

CreatePosAttr()#

CreateSizeAttr()#

CreateStackingOrderAttr()#

static Get()#

GetDisplayColorAttr()#

GetDocURIAttr()#

GetExpansionStateAttr()#

GetIconAttr()#

GetPosAttr()#

static GetSchemaAttributeNames()#

GetSizeAttr()#

GetStackingOrderAttr()#

class pxr.UsdUI.ObjectHints#

Methods:

`GetDisplayName`
`GetHidden`
`GetObject`
`SetDisplayName`
`SetHidden`

GetDisplayName()#

GetHidden()#

GetObject()#

SetDisplayName()#

SetHidden()#

class pxr.UsdUI.PrimHints#

Methods:

`GetDisplayGroupExpanded`
`GetDisplayGroupShownIf`
`GetDisplayGroupsExpanded`
`GetDisplayGroupsShownIf`
`GetPrim`
`SetDisplayGroupExpanded`
`SetDisplayGroupShownIf`
`SetDisplayGroupsExpanded`
`SetDisplayGroupsShownIf`

GetDisplayGroupExpanded()#

GetDisplayGroupShownIf()#

GetDisplayGroupsExpanded()#

GetDisplayGroupsShownIf()#

GetPrim()#

SetDisplayGroupExpanded()#

SetDisplayGroupShownIf()#

SetDisplayGroupsExpanded()#

SetDisplayGroupsShownIf()#

class pxr.UsdUI.PropertyHints#

Methods:

`GetDisplayGroup`
`GetProperty`
`GetShownIf`
`SetDisplayGroup`
`SetShownIf`

GetDisplayGroup()#

GetProperty()#

GetShownIf()#

SetDisplayGroup()#

SetShownIf()#

class pxr.UsdUI.SceneGraphPrimAPI#

Methods:

`Apply`
`CanApply`
`CreateDisplayGroupAttr`
`CreateDisplayNameAttr`
`Get`
`GetDisplayGroupAttr`
`GetDisplayNameAttr`
`GetSchemaAttributeNames`

static Apply()#

static CanApply()#

CreateDisplayGroupAttr()#

CreateDisplayNameAttr()#

static Get()#

GetDisplayGroupAttr()#

GetDisplayNameAttr()#

static GetSchemaAttributeNames()#

class pxr.UsdUI.Tokens#

Attributes:

AccessibilityAPI = 'AccessibilityAPI'#

Backdrop = 'Backdrop'#

NodeGraphNodeAPI = 'NodeGraphNodeAPI'#

SceneGraphPrimAPI = 'SceneGraphPrimAPI'#

accessibility = 'accessibility'#

accessibility_MultipleApplyTemplate_Description = 'accessibility:__INSTANCE_NAME__:description'#

accessibility_MultipleApplyTemplate_Label = 'accessibility:__INSTANCE_NAME__:label'#

accessibility_MultipleApplyTemplate_Priority = 'accessibility:__INSTANCE_NAME__:priority'#

closed = 'closed'#

default_ = 'default'#

description = 'description'#

high = 'high'#

label = 'label'#

low = 'low'#

minimized = 'minimized'#

open = 'open'#

priority = 'priority'#

standard = 'standard'#

uiDescription = 'ui:description'#

uiDisplayGroup = 'ui:displayGroup'#

uiDisplayName = 'ui:displayName'#

uiNodegraphNodeDisplayColor = 'ui:nodegraph:node:displayColor'#

uiNodegraphNodeDocURI = 'ui:nodegraph:node:docURI'#

uiNodegraphNodeExpansionState = 'ui:nodegraph:node:expansionState'#

uiNodegraphNodeIcon = 'ui:nodegraph:node:icon'#

uiNodegraphNodePos = 'ui:nodegraph:node:pos'#

uiNodegraphNodeSize = 'ui:nodegraph:node:size'#

uiNodegraphNodeStackingOrder = 'ui:nodegraph:node:stackingOrder'#

`AccessibilityAPI`
`Backdrop`
`NodeGraphNodeAPI`
`SceneGraphPrimAPI`
`accessibility`
`accessibility_MultipleApplyTemplate_Description`
`accessibility_MultipleApplyTemplate_Label`
`accessibility_MultipleApplyTemplate_Priority`
`closed`
`default_`
`description`
`high`
`label`
`low`
`minimized`
`open`
`priority`
`standard`
`uiDescription`
`uiDisplayGroup`
`uiDisplayName`
`uiNodegraphNodeDisplayColor`
`uiNodegraphNodeDocURI`
`uiNodegraphNodeExpansionState`
`uiNodegraphNodeIcon`
`uiNodegraphNodePos`
`uiNodegraphNodeSize`
`uiNodegraphNodeStackingOrder`