AbstractGesture

class omni.ui.scene.AbstractGesture

Bases: pybind11_object

The base class for the gestures to provides a way to capture mouse events in 3d scene.

Methods

__init__(*args, **kwargs)
get_gesture_payload(*args, **kwargs)	Overloaded function.
process(self)	Process the gesture and call callbacks if necessary.

Attributes

gesture_payload	Shortcut for sender.get_gesturePayload.
manager	The Manager that controld this gesture.
name	The name of the object.
state	Get the internal state of the gesture.

__init__(*args, **kwargs)

get_gesture_payload(*args, **kwargs)

Overloaded function.

1. get_gesture_payload(self: omni.ui_scene._scene.AbstractGesture) -> omni.ui_scene._scene.AbstractGesture.GesturePayload

Shortcut for sender.get_gesturePayload. OMNIUI_SCENE_API const*

2. get_gesture_payload(self: omni.ui_scene._scene.AbstractGesture, arg0: omni.ui_scene._scene.GestureState) -> omni.ui_scene._scene.AbstractGesture.GesturePayload

Shortcut for sender.get_gesturePayload. OMNIUI_SCENE_API const*

process(

self: omni.ui_scene._scene.AbstractGesture,

) → None

Process the gesture and call callbacks if necessary.

property gesture_payload

Shortcut for sender.get_gesturePayload. OMNIUI_SCENE_API const*

property manager

The Manager that controld this gesture.

property name

The name of the object. It’s used for debugging.

property state

Get the internal state of the gesture.