Skip to main content

MouseDimensions

Struct MouseDimensions 

Source
pub struct MouseDimensions { /* private fields */ }
Expand description

MouseDimensions - Centralizes ALL mouse coordinate translation and hit testing

Eliminates ad hoc coordinate math like:

  • column as usize, row as usize conversions from crossterm
  • inbox_x = screen_x.saturating_sub(content_start_x.saturating_sub(horizontal_offset))
  • Complex coordinate system translations between screen, content, and scrolled spaces
  • Hit testing scattered across multiple files

Replaces scattered coordinate translation from box_renderer.rs, draw_loop.rs, input_loop.rs

Implementations§

Source§

impl MouseDimensions

Source

pub fn new( screen_bounds: Bounds, content_bounds: Bounds, scroll_offset: (usize, usize), content_size: (usize, usize), ) -> Self

Create new mouse dimensions

Source

pub fn set_scroll_offset(&mut self, horizontal: usize, vertical: usize)

Update scroll offset

Source

pub fn crossterm_to_internal(&self, column: u16, row: u16) -> (usize, usize)

Convert crossterm coordinates (u16) to internal coordinates (usize) Centralizes: column as usize, row as usize conversions

Source

pub fn internal_to_crossterm(&self, x: usize, y: usize) -> (u16, u16)

Convert internal coordinates back to crossterm (for event generation)

Source

pub fn is_within_screen_bounds(&self, x: usize, y: usize) -> bool

Test if screen coordinates are within component bounds

Source

pub fn is_within_content_bounds(&self, x: usize, y: usize) -> bool

Test if screen coordinates are within content area

Source

pub fn screen_to_content( &self, screen_x: usize, screen_y: usize, ) -> Option<(usize, usize)>

Convert screen coordinates to content coordinates (accounting for scroll) Centralizes complex translation logic from box_renderer.rs

Source

pub fn content_to_screen( &self, content_x: usize, content_y: usize, ) -> Option<(usize, usize)>

Convert content coordinates to screen coordinates (reverse translation)

Source

pub fn get_visible_content_range(&self) -> ((usize, usize), (usize, usize))

Get the content coordinate range that’s currently visible

Source

pub fn is_content_coordinate_visible( &self, content_x: usize, content_y: usize, ) -> bool

Test if content coordinates are currently visible on screen

Source

pub fn screen_y_to_content_line(&self, screen_y: usize) -> Option<usize>

Calculate which content line a screen Y coordinate corresponds to Useful for text selection and choice navigation

Source

pub fn screen_x_to_content_column(&self, screen_x: usize) -> Option<usize>

Calculate which content column a screen X coordinate corresponds to
Useful for text cursor positioning

Source

pub fn detect_click_region(&self, x: usize, y: usize) -> ClickRegion

Calculate click regions for UI components Centralizes region detection logic

Source

pub fn calculate_distance( &self, x1: usize, y1: usize, x2: usize, y2: usize, ) -> f64

Calculate distance between two points (for drag detection)

Source

pub fn is_drag_operation( &self, start_x: usize, start_y: usize, current_x: usize, current_y: usize, threshold: f64, ) -> bool

Test if mouse movement constitutes a drag (beyond threshold)

Source

pub fn calculate_selection_bounds( &self, start_x: usize, start_y: usize, end_x: usize, end_y: usize, ) -> SelectionBounds

Calculate bounding box for a selection region

Source

pub fn clamp_to_screen_bounds(&self, x: usize, y: usize) -> (usize, usize)

Clamp coordinates to valid screen bounds Prevents out-of-bounds coordinate issues

Source

pub fn clamp_to_content_bounds(&self, x: usize, y: usize) -> (usize, usize)

Clamp coordinates to valid content bounds

Source

pub fn calculate_scroll_to_visible( &self, content_x: usize, content_y: usize, ) -> (i32, i32)

Calculate scroll delta needed to make content coordinate visible

Source

pub fn update_bounds(&mut self, screen_bounds: Bounds, content_bounds: Bounds)

Update mouse dimensions for window/content resize

Source

pub fn update_content_size(&mut self, width: usize, height: usize)

Update content size (when content changes)

Trait Implementations§

Source§

impl Clone for MouseDimensions

Source§

fn clone(&self) -> MouseDimensions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MouseDimensions

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more