Struct gdnative::api::InputEventMagnifyGesture

pub struct InputEventMagnifyGesture { /* fields omitted */ }

core class InputEventMagnifyGesture inherits InputEventGesture (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

InputEventMagnifyGesture inherits methods from:

• InputEventGesture
• 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 InputEventMagnifyGesture

pub fn new() -> Ref<InputEventMagnifyGesture, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn factor(&self) -> f64

pub fn set_factor(&self, factor: f64)

Methods from Deref<Target = 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.

Trait Implementations

impl Debug for InputEventMagnifyGesture

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

Formats the value using the given formatter.

impl Deref for InputEventMagnifyGesture

type Target = InputEventGesture

The resulting type after dereferencing.

fn deref(&self) -> &InputEventGesture

Dereferences the value.

impl DerefMut for InputEventMagnifyGesture

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

Mutably dereferences the value.

impl GodotObject for InputEventMagnifyGesture

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 Instanciable for InputEventMagnifyGesture

fn construct() -> Ref<InputEventMagnifyGesture, Unique>

impl SubClass<InputEvent> for InputEventMagnifyGesture

impl SubClass<InputEventGesture> for InputEventMagnifyGesture

impl SubClass<InputEventWithModifiers> for InputEventMagnifyGesture

impl SubClass<Object> for InputEventMagnifyGesture

impl SubClass<Reference> for InputEventMagnifyGesture

impl SubClass<Resource> for InputEventMagnifyGesture