omni.kit.viewport.utility Functions

Functions Summary:

capture_viewport_to_buffer

Captures the current viewport and sends the image to a callback function.

capture_viewport_to_file

Capture the provided viewport to a file.

create_drop_helper

Creates a helper object to handle drag-and-drop operations in a viewport.

disable_selection

Disables selection for a given viewport.

frame_viewport_prims

Frames the view of the viewport to include the specified prims.

frame_viewport_selection

Frames the camera in the viewport to include the current selection.

get_active_viewport

Retrieves the active viewport API instance for a given USD context.

get_active_viewport_and_window

Retrieves the active viewport and its window for a given USD context and window name.

get_active_viewport_camera_path

Retrieves the camera Sdf.Path for the active viewport within a specified USD context.

get_active_viewport_camera_string

Retrieves the camera path string for the active viewport within a specified USD context.

get_ground_plane_info

Retrieves the ground plane information including its normal and the planes it occupies.

get_num_viewports

Returns the number of active viewports within an optional USD context.

get_viewport_from_window_name

Retrieves the first viewport API instance from a specified window name.

get_viewport_window_camera_path

Retrieves the camera path for the viewport in the specified window.

get_viewport_window_camera_string

Retrieves the camera path string for the viewport in the specified window.

post_viewport_message

Posts a message as a toast notification to the viewport or viewport window.

toggle_global_visibility

Deprecated since version 1.0.15.