Overview#

omni.kit.stage_column.active adds an extra column to the stage window, providing a dedicated view for the active status of stage items. This extension enhances the stage window by integrating intuitive indicators and controls for active/inactive states, helping users quickly assess and manage their stage hierarchy. The design intentionally keeps the feature built into the stage window, so no additional scripting is required once enabled.

Concepts#

Active Column Delegate
The extension implements an ActiveColumnDelegate that defines how the active state is represented in the stage window. It handles the layout, header creation, and widget building for active status indicators.
Active Model
A corresponding ActiveModel is provided to manage the boolean state of each stage item. This model synchronizes the UI representation with the underlying active/inactive status.
Icon Management
An Icons singleton is included to scan and provide the appropriate icon based on a given stage item type. This ensures visual consistency across the active status display.

Functionality#

Custom UI Components
The extension builds specialized UI elements for the active status column. It sets an initial width, supports sorting through an ActiveColumnSortPolicy, and offers options to rebuild or destroy widgets as stage items change.
Data Synchronization
ActiveModel ensures that any change in the active state is properly reflected in the UI. Users interact with the stage column seamlessly, altering the active state without needing to manually manage internal data flow.
Sorting and Layout
The delegate includes built-in policies to sort stage items by their active status, allowing users to arrange items from active to inactive (or vice versa) with minimal configuration.

Relationships#

Integration with Stage Window
This extension is designed to work closely with stage window functionalities provided by omni.kit.widget.stage. It leverages Omni UI for its interactive elements, ensuring a smooth integration and consistent user experience.
Dependencies
The extension relies on the functionalities of omni.kit.widget.stage for stage item management and omni.ui for constructing the custom UI components. This dependency guarantees that the active column behaves in harmony with the overall stage window system.

Considerations#

The extension is self-contained and activates its enhancements immediately when enabled. Users benefit from a refined view of stage item states without needing additional configuration.
While it offers visual and sorting capabilities for active status, future updates may extend its integration with other stage window features based on user workflow requirements.