Overview#

The Welcome Window is a post-startup utility that provides quick-access buttons to help Omniverse Kit users get started with scenes. It offers a clean, ready-to-use interface that helps orient users immediately upon launching the application. The extension is designed to work seamlessly, either embedded directly in the main viewport or as a standalone window.

Functionality#

Welcome UI
The extension displays a window that welcomes users with interactive buttons. These buttons allow users to quickly create an empty scene or open an existing scene.
Render Loading Transition
It supports a render loading UI that provides a smooth background transition. This feature uses a configurable background color to help signal the transition from the welcome screen to the main viewport experience.

Configuration#

Viewport Embedding
Through the setting exts."**omni.kit.window.welcome**".embedInViewport, the welcome window can be embedded inside the main viewport for a more integrated experience.
Render Loading Option
The setting exts."**omni.kit.window.welcome**".showRenderLoading enables the render loading UI, allowing for a dynamic transition. Additionally, the background color used during the transition is set via exts."**omni.kit.viewport.ready**".background_color.

Relationships#

Omni UI Integration
The extension leverages the capabilities of Omni UI for its window and widget components. This dependency ensures a consistent look and feel with the rest of the application, while also streamlining integration with other UI-based extensions.

Considerations#

User Workflow
The extension is intended to work immediately upon startup, providing users with an intuitive entry point to viewport scenes. Customization is available through the provided settings, allowing for adjustments based on the user’s workflow.

This streamlined design keeps the welcome experience efficient and focused on guiding users without requiring manual intervention or additional programming.