frame_viewport_prims

omni.kit.viewport.utility.frame_viewport_prims(

viewport_api=None,

prims: List[str] = None,

)

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

Parameters:

• viewport_api (ViewportAPI, optional) – The viewport API instance to operate on. If not provided, the active viewport is used.

• prims (List[str], optional) – A list of USD prim paths to frame in the viewport. If not provided or empty, no action is taken.

Returns:

True if the operation was successful, False otherwise.

Return type:

bool