Struct gdnative::api::InputEventGesture

pub struct InputEventGesture { /* fields omitted */ }

core class InputEventGesture inherits InputEventWithModifiers (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

InputEventGesture inherits methods from:

• InputEventWithModifiers
• InputEvent
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl InputEventGesture

pub fn position(&self) -> Vector2D<f32, UnknownUnit>

The local gesture position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] that received this gesture.

pub fn set_position(&self, position: Vector2D<f32, UnknownUnit>)

The local gesture position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] that received this gesture.

Methods from Deref<Target = InputEventWithModifiers>

pub fn alt(&self) -> bool

State of the [code]Alt[/code] modifier.

pub fn command(&self) -> bool

State of the [code]Command[/code] modifier.

pub fn control(&self) -> bool

State of the [code]Ctrl[/code] modifier.

pub fn metakey(&self) -> bool

State of the [code]Meta[/code] modifier.

pub fn shift(&self) -> bool

State of the [code]Shift[/code] modifier.

pub fn set_alt(&self, enable: bool)

State of the [code]Alt[/code] modifier.

pub fn set_command(&self, enable: bool)

State of the [code]Command[/code] modifier.

pub fn set_control(&self, enable: bool)

State of the [code]Ctrl[/code] modifier.

pub fn set_metakey(&self, enable: bool)

State of the [code]Meta[/code] modifier.

pub fn set_shift(&self, enable: bool)

State of the [code]Shift[/code] modifier.

Trait Implementations

impl Debug for InputEventGesture

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for InputEventGesture

type Target = InputEventWithModifiers

The resulting type after dereferencing.

fn deref(&self) -> &InputEventWithModifiers

Dereferences the value.

impl DerefMut for InputEventGesture

fn deref_mut(&mut self) -> &mut InputEventWithModifiers

Mutably dereferences the value.

impl GodotObject for InputEventGesture

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl SubClass<InputEvent> for InputEventGesture

impl SubClass<InputEventGesture> for InputEventMagnifyGesture

impl SubClass<InputEventGesture> for InputEventPanGesture

impl SubClass<InputEventWithModifiers> for InputEventGesture

impl SubClass<Object> for InputEventGesture

impl SubClass<Reference> for InputEventGesture

impl SubClass<Resource> for InputEventGesture