get_active_viewport

omni.kit.viewport.utility.get_active_viewport(usd_context_name: str = '')

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

If no USD context name is provided, the current USD context is used.

Parameters:

usd_context_name (str, optional) – The name of the USD context to query. Defaults to an empty string, which indicates the current USD context.

Returns:

The active viewport API instance, or None if not found.

Return type:

Optional[ViewportAPI]