Struct kas_core::geom::Offset

source ·

pub struct Offset(pub i32, pub i32);

Expand description

A (x, y) offset, also known as a vector

This is a relative position. It can be added to or subtracted from a Coord, and it can be added to or subtracted from itself. It can be negative. It can be multiplied by a scalar.

This may be converted to Size with from / into.

Tuple Fields§

§0: i32§1: i32

Implementations§

source §

impl Offset

source

pub const ZERO: Self = _

The constant (0, 0)

source

pub const MIN: Self = _

The minimum value

source

pub const MAX: Self = _

The maximum value

source

pub fn lt(self, rhs: Self) -> bool

True when for all components, lhs < rhs

source

pub fn le(self, rhs: Self) -> bool

True when for all components, lhs ≤ rhs

source

pub fn ge(self, rhs: Self) -> bool

True when for all components, lhs ≥ rhs

source

pub fn gt(self, rhs: Self) -> bool

True when for all components, lhs > rhs

source

pub fn min(self, other: Self) -> Self

Return the minimum, componentwise

Examples found in repository ?

src/event/components.rs (line 154)

    pub fn set_offset(&mut self, offset: Offset) -> TkAction {
        let offset = offset.min(self.max_offset).max(Offset::ZERO);
        if offset == self.offset {
            TkAction::empty()
        } else {
            self.offset = offset;
            TkAction::REGION_MOVED
        }
    }

    /// Scroll to make the given `rect` visible
    ///
    /// Inputs and outputs:
    ///
    /// -   `rect`: the rect to focus in child's coordinate space
    /// -   `window_rect`: the rect of the scroll window
    /// -   returned `Rect`: the focus rect, adjusted for scroll offset; this
    ///     may be set via [`EventMgr::set_scroll`]
    /// -   returned `TkAction`: action to pass to the event manager
    pub fn focus_rect(&mut self, rect: Rect, window_rect: Rect) -> (Rect, TkAction) {
        let v = rect.pos - window_rect.pos;
        let off = Offset::conv(rect.size) - Offset::conv(window_rect.size);
        let offset = self.offset.max(v + off).min(v);
        let action = self.set_offset(offset);
        (rect - self.offset, action)
    }

source

pub fn max(self, other: Self) -> Self

Return the maximum, componentwise

Examples found in repository ?

src/event/components.rs (line 154)

    pub fn set_offset(&mut self, offset: Offset) -> TkAction {
        let offset = offset.min(self.max_offset).max(Offset::ZERO);
        if offset == self.offset {
            TkAction::empty()
        } else {
            self.offset = offset;
            TkAction::REGION_MOVED
        }
    }

    /// Scroll to make the given `rect` visible
    ///
    /// Inputs and outputs:
    ///
    /// -   `rect`: the rect to focus in child's coordinate space
    /// -   `window_rect`: the rect of the scroll window
    /// -   returned `Rect`: the focus rect, adjusted for scroll offset; this
    ///     may be set via [`EventMgr::set_scroll`]
    /// -   returned `TkAction`: action to pass to the event manager
    pub fn focus_rect(&mut self, rect: Rect, window_rect: Rect) -> (Rect, TkAction) {
        let v = rect.pos - window_rect.pos;
        let off = Offset::conv(rect.size) - Offset::conv(window_rect.size);
        let offset = self.offset.max(v + off).min(v);
        let action = self.set_offset(offset);
        (rect - self.offset, action)
    }

source

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to the specified interval, componentwise

source

pub fn transpose(self) -> Self

Return the transpose (swap x and y values)

source

pub fn cwise_mul(self, rhs: Self) -> Self

Return the result of component-wise multiplication

source

pub fn cwise_div(self, rhs: Self) -> Self

Return the result of component-wise division

source

pub fn distance_l1(self) -> i32

Return the L1 (rectilinear / taxicab) distance

source

pub fn distance_l_inf(self) -> i32

Return the L-inf (max) distance

source

pub fn extract<D: Directional>(self, dir: D) -> i32

Extract one component, based on a direction

This merely extracts the horizontal or vertical component. It never negates it, even if the axis is reversed.

source

pub fn set_component<D: Directional>(&mut self, dir: D, value: i32)

Set one component of self, based on a direction

This does not negate components when the direction is reversed.

Examples found in repository ?

src/layout/visitor.rs (line 545)

    pub fn size_rules(
        &mut self,
        mgr: SizeMgr,
        axis: AxisInfo,
        child_rules: SizeRules,
        style: FrameStyle,
    ) -> SizeRules {
        let frame_rules = mgr.frame(style, axis);
        let (rules, offset, size) = frame_rules.surround(child_rules);
        self.offset.set_component(axis, offset);
        self.size.set_component(axis, size);
        rules
    }

source §

impl Offset

source

pub fn new(x: i32, y: i32) -> Self

Construct

source

pub const fn splat(n: i32) -> Self

Construct, using the same value on all axes

Examples found in repository ?

src/geom.rs (line 587)

    pub fn shrink(&self, n: i32) -> Rect {
        let pos = self.pos + Offset::splat(n);
        let size = self.size - Size::splat(n + n);
        Rect { pos, size }
    }

    /// Expand self in all directions by the given `n`
    ///
    /// In debug mode this asserts that `n` is non-negative.
    #[inline]
    #[must_use = "method does not modify self but returns a new value"]
    pub fn expand(&self, n: i32) -> Rect {
        debug_assert!(n >= 0);
        let pos = self.pos - Offset::splat(n);
        let size = self.size + Size::splat(n + n);
        Rect { pos, size }
    }