StageColumnItem

class omni.kit.widget.stage.StageColumnItem(path: Path, stage: Stage, enabled: bool, expanded: bool = True)

Bases: object

A dataclass that manages information needed for building columns for a StageItem. It’s not clear what data we need to pass to build_widget. Apart from path, there are potentially other information the column has. To keep the API unchanged over time, we pass in data as a struct. It also allows passing in custom data derived from this class.

Methods

__init__(path, stage, enabled[, expanded])

Constructor.

Attributes

enabled

Whether the item is enabled.

expanded

Whether the item is expanded.

path

The path of the item.

stage

The stage that the item belongs to.

__init__(path: Path, stage: Stage, enabled: bool, expanded: bool = True)

Constructor.

Parameters
  • path (Sdf.Path) – Full path of the item

  • stage (Usd.Stage) – USD Stage

  • enabled (bool) – When false, the widget should be grayed out

Keyword Arguments

expanded (bool) – Whether the item should be expanded.

property enabled: bool

Whether the item is enabled.

Returns

Enabled or not

Return type

bool

property expanded: bool

Whether the item is expanded.

Returns

Expanded or not

Return type

bool

property path: Path

The path of the item.

Returns

The path of the item.

Return type

Sdf.Path

property stage: Stage

The stage that the item belongs to.

Returns

The stage that the item belongs to.

Return type

Usd.Stage