Skip to main content

BoxDimensions

Struct BoxDimensions 

Source
pub struct BoxDimensions {
    pub total_bounds: Bounds,
    pub content_bounds: Bounds,
    pub viewable_width: usize,
    pub viewable_height: usize,
    pub content_width: usize,
    pub content_height: usize,
    pub horizontal_scroll: f64,
    pub vertical_scroll: f64,
    pub border_thickness: usize,
    pub tab_height: usize,
    pub vertical_scrollbar_width: usize,
    pub horizontal_scrollbar_height: usize,
}
Expand description

Box dimensions and coordinate system definitions

This module formalizes the coordinate systems and size measurements for boxes:

  • Box Span: Total space including borders, tabs, scrollbars, all attachments
  • Content Area: Space available for renderable content (inside borders/scrollbars)
  • Screen Coordinates: Absolute terminal coordinates (0,0 = top-left terminal)
  • Inbox Coordinates: Content-local coordinates (0,0 = top-left content cell)

Fields§

§total_bounds: Bounds

Total box span including all attachments (borders, scrollbars, tabs)

§content_bounds: Bounds

Content area bounds (where renderable content is placed)

§viewable_width: usize

Dimensions of the viewable content area

§viewable_height: usize§content_width: usize

Actual content dimensions (may exceed viewable area)

§content_height: usize§horizontal_scroll: f64

Current scroll positions (0-100 percentage)

§vertical_scroll: f64§border_thickness: usize

Border thickness

§tab_height: usize

Tab bar height (if tabs are present)

§vertical_scrollbar_width: usize

Scrollbar dimensions

§horizontal_scrollbar_height: usize

Implementations§

Source§

impl BoxDimensions

Source

pub fn new( muxbox: &MuxBox, bounds: &Bounds, content_width: usize, content_height: usize, ) -> Self

Create new BoxDimensions from MuxBox state with explicit content size.

This is the single canonical coordinate authority shared by rendering and hit-testing. content_bounds is computed purely from the box’s border and tab presence (inclusive coordinates), and one column/row is always reserved for scrollbars so the viewable region never depends on whether a scrollbar happens to be visible. inbox_to_screen/screen_to_inbox are exact inverses over this region, so any cell a renderer draws via inbox_to_screen is hit-tested back to the same inbox coordinate.

Source

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

Convert screen coordinates to box span coordinates Box span includes borders, tabs, scrollbars - the total area the box occupies

Source

pub fn box_span_to_screen(&self, box_x: usize, box_y: usize) -> (usize, usize)

Convert box span coordinates to screen coordinates

Source

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

Convert screen coordinates to inbox (content-local) coordinates. Exact inverse of inbox_to_screen over the viewable window. The viewable window is [content_left, content_left + viewable_width) horizontally and [content_top, content_top + viewable_height) vertically, so the last viewable cell is reachable (no off-by-one) and the reserved scrollbar column/row is excluded.

Source

pub fn inbox_to_screen(&self, inbox_x: usize, inbox_y: usize) -> (usize, usize)

Convert inbox coordinates to screen coordinates. Returns (usize::MAX, usize::MAX) when the inbox cell is outside content or scrolled out of the viewable window. Exact inverse of screen_to_inbox.

Source

pub fn contains_screen_point(&self, screen_x: usize, screen_y: usize) -> bool

Check if screen coordinates are within the content area

Source

pub fn contains_screen_point_in_span( &self, screen_x: usize, screen_y: usize, ) -> bool

Check if screen coordinates are within the total box span

Source

pub fn calculate_from_muxbox(muxbox: &MuxBox, total_bounds: Bounds) -> Self

Calculate BoxDimensions from MuxBox and bounds

Source

pub fn is_inbox_visible(&self, inbox_x: usize, inbox_y: usize) -> bool

Check if inbox coordinates are currently visible in the viewable area

Source

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

Get the visible inbox region (scroll window)

Trait Implementations§

Source§

impl Clone for BoxDimensions

Source§

fn clone(&self) -> BoxDimensions

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 BoxDimensions

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