Screen

class omni.ui.scene.Screen

Bases: AbstractShape

The empty shape that triggers all the gestures at any place. Is used to track gestures when the user clicked the empty space. For example for cameras.

Methods

__init__(self, **kwargs)

Constructor.

get_gesture_payload(*args, **kwargs)

Overloaded function.

Attributes

gesture_payload

Contains all the information about the intersection.
__init__(self: omni.ui_scene._scene.Screen, **kwargs) → None

Constructor.

`kwargsdict`

See below

### Keyword Arguments:

`gesture`

All the gestures assigned to this shape.

`gestures`

All the gestures assigned to this shape.

`visible`

This property holds whether the item is visible.

get_gesture_payload(*args, **kwargs)

Overloaded function.

  1. get_gesture_payload(self: omni.ui_scene._scene.Screen) -> omni.ui_scene._scene.ScreenGesturePayload

Contains all the information about the intersection.

  1. get_gesture_payload(self: omni.ui_scene._scene.Screen, arg0: omni.ui_scene._scene.GestureState) -> omni.ui_scene._scene.ScreenGesturePayload

Contains all the information about the intersection at the specific state.

property gesture_payload

Contains all the information about the intersection.