Extension: omni.kit.viewport.actions-106.0.2 |
Documentation Generated: Sep 11, 2024 |
Overview
The extension omni.kit.viewport.actions provides a suite of actions for switching cameras, toggle the visibility of elements such as lights, cameras, skeletons, meshes, and HUD components, as well as adjusting renderer settings and viewport resolutions.
Important Action List
Viewport HUD Visibility Actions
toggle_hud_fps_visibility: Toggle the visibility of render fps in HUD.
toggle_hud_resolution_visibility: Toggle the visibility of render resolution in HUD.
toggle_hud_progress_visibility: Toggle the visibility of render progress in HUD.
toggle_hud_camera_speed_visibility: Toggle the visibility of camera speed in HUD.
toggle_hud_memory_visibility: Toggles the visibility of memory in the HUD.
toggle_hud_visibility: Toggles the visibility of all HUD elements.
General Use Case
The extension allows users to easily manage the visibility of different elements within the Omniverse Kit Viewport, change the active camera, adjust rendering settings, and customize the viewport’s appearance to their needs. This can be particularly useful for scene setup, visualization, and ensuring optimal performance during the development process by selectively toggling element visibility. For examples of how to use the APIs, please consult the Python usage pages.