Struct GridLine

pub struct GridLine {
    pub start: IVec2,
    pub end: IVec2,
}

A line of points on a 2d grid.

Fields

start: IVec2

end: IVec2

Implementations

impl GridLine

pub fn new(start: impl GridPoint, end: impl GridPoint) -> Self

Create a new grid line. Note that end is included and will be the final point on the line.

pub fn origin(end: impl GridPoint) -> Self

Create a line with the start point at 0,0

pub fn length(&self) -> usize

Trait Implementations

impl Clone for GridLine

fn clone(&self) -> GridLine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridLine

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

Formats the value using the given formatter.

impl Default for GridLine

fn default() -> GridLine

Returns the “default value” for a type.

impl GridShape for GridLine

fn iter(&self) -> GridShapeIterator

Iterate over all the points contained within the grid shape.

fn pos(&self) -> IVec2

The position of the grid shape.

fn set_pos(&mut self, pos: IVec2)

Set the position of the grid shape without changing it’s size.

fn bounds(&self) -> GridRect

Get a rect encompassing the entire shape.

impl IntoIterator for GridLine

type Item = IVec2

The type of the elements being iterated over.

type IntoIter = GridLineIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for GridLine

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GridLine

impl Eq for GridLine

impl StructuralPartialEq for GridLine