Struct svgbob::Cell

pub struct Cell {
    pub x: i32,
    pub y: i32,
}

     0 1 2 3 4           B C D
    0┌─┬─┬─┬─┐        A┌─┬─┬─┬─┐E
    1├─┼─┼─┼─┤         │ │ │ │ │
    2├─┼─┼─┼─┤        F├─G─H─I─┤J
    3├─┼─┼─┼─┤         │ │ │ │ │
    4├─┼─┼─┼─┤        K├─L─M─N─┤O
    5├─┼─┼─┼─┤         │ │ │ │ │
    6├─┼─┼─┼─┤        P├─Q─R─S─┤T
    7├─┼─┼─┼─┤         │ │ │ │ │
    8└─┴─┴─┴─┘        U└─┴─┴─┴─┘Y
```                      V W X
A single element in the terminal that
can fit 1 character.
Describe the exact location of a point/subcell in a grid.

Fields

x: i32

y: i32

Methods

impl Cell

pub fn a(&self) -> Point

The point at sepcific cell grid of this cell

pub fn b(&self) -> Point

pub fn c(&self) -> Point

pub fn d(&self) -> Point

pub fn e(&self) -> Point

pub fn f(&self) -> Point

pub fn g(&self) -> Point

pub fn h(&self) -> Point

pub fn i(&self) -> Point

pub fn j(&self) -> Point

pub fn k(&self) -> Point

pub fn l(&self) -> Point

pub fn m(&self) -> Point

pub fn n(&self) -> Point

pub fn o(&self) -> Point

pub fn p(&self) -> Point

pub fn q(&self) -> Point

pub fn r(&self) -> Point

pub fn s(&self) -> Point

pub fn t(&self) -> Point

pub fn u(&self) -> Point

pub fn v(&self) -> Point

pub fn w(&self) -> Point

pub fn x(&self) -> Point

pub fn y(&self) -> Point

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

pub fn is_adjacent(&self, other: &Self) -> bool

returns true if the other cell is at: top_left, top, top_right, left, right, bottom_left, bottom, bottom_right of self

pub fn snap_point(point: Point) -> (Self, Point)

Derive which cell this points falls into and snap the point closes to any intersection in the cell grid. FIXME: need to find a way to snap a group of point that lies in boundaries to snap together to a common cell.

pub fn snap_group(points: &[Point]) -> Self

pub fn top_left_most(&self) -> Point

The point at the top right of this cell

pub fn bottom_right_most(&self) -> Point

pub fn localize_point(&self, point: Point) -> Point

turn point into relative distance from the top-left of this cell by simply deducting the point p with this cell's top_left_most point

pub fn localize_cell(&self, cell: Cell) -> Cell

pub fn width() -> f32

pub fn height() -> f32

pub fn unit(l: i32) -> f32

pub fn is_intersected(&self, start: Point, end: Point) -> bool

test whether this cell is intersected with the line segment with point start and end

pub fn is_bounded(&self, bound1: Cell, bound2: Cell) -> bool

check if this cell is bounded by the lower bound and upper bound

pub fn snap(p: Point) -> Point

snap point to a closest intersection of this cellgrid

pub fn clip_line_snap(&self, start: Point, end: Point) -> Option<(Point, Point)>

pub fn clip_line_localize(
    &self,
    start: Point,
    end: Point
) -> Option<(Point, Point)>

clip line then localize the points and snap to the nearest cell grid intersection

pub fn top_left(&self) -> Self

The cell at the top left of this cell

pub fn top(&self) -> Self

pub fn top_right(&self) -> Self

pub fn left(&self) -> Self

The cell at the left of this cell

pub fn right(&self) -> Self

pub fn bottom_left(&self) -> Self

pub fn bottom(&self) -> Self

pub fn bottom_right(&self) -> Self

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Cell

impl Debug for Cell

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

Formats the value using the given formatter.

impl Display for Cell

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

Formats the value using the given formatter.

impl Eq for Cell

impl Hash for Cell

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Cell

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Cell> for Cell

fn eq(&self, other: &Cell) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Cell) -> bool

This method tests for !=.

impl PartialOrd<Cell> for Cell

fn partial_cmp(&self, other: &Cell) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Cell) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Cell) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Cell) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Cell) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Cell