get_ground_plane_info#

omni.kit.viewport.utility.get_ground_plane_info(

viewport,

ortho_special: bool = True,

) → Tuple[Vec3d, List[str]]#

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

Parameters:

• viewport (ViewportAPI) – The viewport API instance for which to get the ground plane information.

• ortho_special (bool, optional) – If True, uses an alternate ground plane for orthographic cameras that are looking down a single axis. Defaults to True.

Returns:

A tuple containing the ground plane normal vector and a list of

plane axes it occupies (e.g., [‘x’, ‘z’]).

Return type:

Tuple[Gf.Vec3d, List[str]]