[−][src]Struct gdnative::api::InputEventMouseMotion
core class InputEventMouseMotion
inherits InputEventMouse
(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
InputEventMouseMotion inherits methods from:
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 InputEventMouseMotion
[src]
pub fn new() -> Ref<InputEventMouseMotion, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn pressure(&self) -> f64
[src]
Represents the pressure the user puts on the pen. Ranges from [code]0.0[/code] to [code]1.0[/code].
pub fn relative(&self) -> Vector2D<f32, UnknownUnit>
[src]
The mouse position relative to the previous position (position at the last frame).
[b]Note:[/b] Since [InputEventMouseMotion] is only emitted when the mouse moves, the last event won't have a relative position of [code]Vector2(0, 0)[/code] when the user stops moving the mouse.
pub fn speed(&self) -> Vector2D<f32, UnknownUnit>
[src]
The mouse speed in pixels per second.
pub fn tilt(&self) -> Vector2D<f32, UnknownUnit>
[src]
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from [code]-1.0[/code] to [code]1.0[/code] for both axes.
pub fn set_pressure(&self, pressure: f64)
[src]
Represents the pressure the user puts on the pen. Ranges from [code]0.0[/code] to [code]1.0[/code].
pub fn set_relative(&self, relative: Vector2D<f32, UnknownUnit>)
[src]
The mouse position relative to the previous position (position at the last frame).
[b]Note:[/b] Since [InputEventMouseMotion] is only emitted when the mouse moves, the last event won't have a relative position of [code]Vector2(0, 0)[/code] when the user stops moving the mouse.
pub fn set_speed(&self, speed: Vector2D<f32, UnknownUnit>)
[src]
The mouse speed in pixels per second.
pub fn set_tilt(&self, tilt: Vector2D<f32, UnknownUnit>)
[src]
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from [code]-1.0[/code] to [code]1.0[/code] for both axes.
Methods from Deref<Target = InputEventMouse>
pub fn button_mask(&self) -> i64
[src]
The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.
pub fn global_position(&self) -> Vector2D<f32, UnknownUnit>
[src]
The global mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0.
pub fn position(&self) -> Vector2D<f32, UnknownUnit>
[src]
The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse.
pub fn set_button_mask(&self, button_mask: i64)
[src]
The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.
pub fn set_global_position(&self, global_position: Vector2D<f32, UnknownUnit>)
[src]
The global mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0.
pub fn set_position(&self, position: Vector2D<f32, UnknownUnit>)
[src]
The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse.
Trait Implementations
impl Debug for InputEventMouseMotion
[src]
impl Deref for InputEventMouseMotion
[src]
type Target = InputEventMouse
The resulting type after dereferencing.
fn deref(&self) -> &InputEventMouse
[src]
impl DerefMut for InputEventMouseMotion
[src]
fn deref_mut(&mut self) -> &mut InputEventMouse
[src]
impl GodotObject for InputEventMouseMotion
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for InputEventMouseMotion
[src]
fn construct() -> Ref<InputEventMouseMotion, Unique>
[src]
impl SubClass<InputEvent> for InputEventMouseMotion
[src]
impl SubClass<InputEventMouse> for InputEventMouseMotion
[src]
impl SubClass<InputEventWithModifiers> for InputEventMouseMotion
[src]
impl SubClass<Object> for InputEventMouseMotion
[src]
impl SubClass<Reference> for InputEventMouseMotion
[src]
impl SubClass<Resource> for InputEventMouseMotion
[src]
Auto Trait Implementations
impl RefUnwindSafe for InputEventMouseMotion
impl !Send for InputEventMouseMotion
impl !Sync for InputEventMouseMotion
impl Unpin for InputEventMouseMotion
impl UnwindSafe for InputEventMouseMotion
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,