omni.kit.viewport.utility¶

Viewport Utility

CHANGELOG

omni.kit.viewport.utility.capture_viewport_to_buffer(viewport_api, on_capture_fn: Callable, is_hdr: bool = False)¶: Capture the provided viewport and send it to a callback.

omni.kit.viewport.utility.capture_viewport_to_file(viewport_api, file_path: Optional[str] = None, is_hdr: bool = False, render_product_path: Optional[str] = None)¶: Capture the provided viewport to a file.

omni.kit.viewport.utility.create_drop_helper(*args, **kwargs)¶

omni.kit.viewport.utility.frame_viewport_selection(viewport_api=None, force_legacy_api: bool = False)¶

omni.kit.viewport.utility.get_active_viewport(usd_context_name: str = '')¶: Return the active Viewport for a given UsdContext.

omni.kit.viewport.utility.get_active_viewport_camera_path(usd_context_name: str = '') → pxr.Sdf.Path ¶: Return a Sdf.Path to the camera used by the active Viewport for a specific UsdContext.

omni.kit.viewport.utility.get_active_viewport_camera_string(usd_context_name: str = '') → str¶: Return a string path to the camera used by the active Viewport for a specific UsdContext.

omni.kit.viewport.utility.get_num_viewports(usd_context_name: Optional[str] = None)¶

omni.kit.viewport.utility.get_viewport_from_window_name(window_name: Optional[str] = None)¶: Return the first Viewport that is held inside a specific Window name.

omni.kit.viewport.utility.get_viewport_window_camera_path(window_name: Optional[str] = None) → pxr.Sdf.Path ¶: Return a Sdf.Path to the camera used by the active Viewport in a named Window.

omni.kit.viewport.utility.get_viewport_window_camera_string(window_name: Optional[str] = None) → str¶: Return a string path to the camera used by the active Viewport in a named Window.

omni.kit.viewport.utility.post_viewport_message(viewport_api, message: str)¶

omni.kit.viewport.utility.toggle_global_visibility(force_legacy_api: bool = False)¶