Struct ambient_api::prelude::ClickArea

pub struct ClickArea {
    pub inner: Element,
    pub on_mouse_enter: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId) + Sync + Send>>>,
    pub on_mouse_leave: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId) + Sync + Send>>>,
    pub on_mouse_hover: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId) + Sync + Send>>>,
    pub on_mouse_input: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId, MouseInput, MouseButton) + Sync + Send>>>,
    pub on_mouse_wheel: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId, Vec2, bool) + Sync + Send>>>,
}

An area that tracks mouse events.

Fields

inner: Element

The inner element.

on_mouse_enter: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId) + Sync + Send>>>

Callback for when the mouse enters the area.

on_mouse_leave: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId) + Sync + Send>>>

Callback for when the mouse leaves the area.

on_mouse_hover: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId) + Sync + Send>>>

Callback for when the mouse hovers over the area.

on_mouse_input: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId, MouseInput, MouseButton) + Sync + Send>>>

Callback for when a mouse button is.

on_mouse_wheel: Vec<Arc<CbDebuggable<dyn Fn(&mut World, EntityId, Vec2, bool) + Sync + Send>>>

Callback for when the mouse wheel is scrolled.

Implementations

impl ClickArea

pub fn new(inner: Element) -> ClickArea

Create a new ClickArea.

pub fn on_mouse_hover<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId) + Sync + Send + 'static,

Set the callback for when the mouse hovers over the area.

pub fn on_mouse_enter<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId) + Sync + Send + 'static,

Set the callback for when the mouse enters the area.

pub fn on_mouse_leave<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId) + Sync + Send + 'static,

Set the callback for when the mouse leaves the area.

pub fn on_mouse_input<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId, MouseInput, MouseButton) + Sync + Send + 'static,

Set the callback for when a mouse button is pressed or released.

pub fn on_mouse_wheel<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId, Vec2, bool) + Sync + Send + 'static,

Set the callback for when the mouse wheel is scrolled.

pub fn on_mouse_down<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId, MouseButton) + Sync + Send + 'static,

Set the callback for when a mouse button is pressed.

pub fn on_mouse_up<F>(self, handle: F) -> ClickArea

where F: Fn(&mut World, EntityId, MouseButton) + Sync + Send + 'static,

Set the callback for when a mouse button is released.

Trait Implementations

impl Clone for ClickArea

fn clone(&self) -> ClickArea

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClickArea

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

Formats the value using the given formatter.

impl ElementComponent for ClickArea

fn render(self: Box<ClickArea>, hooks: &mut Hooks<'_>) -> Element

Render the virtual tree for this component.