Struct bk2d::point::Path

pub struct Path {
    pub dx: i32,
    pub dy: i32,
}

A path, or a vector

Example

let path = bk2d::point::Path::new(2, 1);

assert_eq!(path.dx, 2);
assert_eq!(path.dy, 1);

assert_eq!(path.length(), 3); // 2 + 1

Merge multiple path

let a = bk2d::point::Path::new(2, 1);
let b = bk2d::point::Path::new(-3, 2);
let c = bk2d::point::Path::new(1, 0);
assert_eq!(bk2d::point::Path::merge(&[a, b, c]), bk2d::point::Path::new(0, 3));
assert_eq!(a + b + c, bk2d::point::Path::new(0, 3));

Common direction

assert_eq!(bk2d::point::Path::up(), bk2d::point::Path::new(0, -1));
assert_eq!(bk2d::point::Path::down(), bk2d::point::Path::new(0, 1));
assert_eq!(bk2d::point::Path::left(), bk2d::point::Path::new(-1, 0));
assert_eq!(bk2d::point::Path::right(), bk2d::point::Path::new(1, 0));

Fields

dx: i32

dy: i32

Methods

impl Path

pub fn new(dx: i32, dy: i32) -> Path

pub fn up() -> Path

pub fn down() -> Path

pub fn left() -> Path

pub fn right() -> Path

pub fn merge(paths: &[Path]) -> Path

Merge multiple path

Example

let a = bk2d::point::Path::new(2, 1);
let b = bk2d::point::Path::new(-3, 2);
let c = bk2d::point::Path::new(1, 0);
assert_eq!(bk2d::point::Path::merge(&[a, b]), bk2d::point::Path::new(-1, 3));
assert_eq!(bk2d::point::Path::merge(&[a, c]), bk2d::point::Path::new(3, 1));
assert_eq!(bk2d::point::Path::merge(&[b, c]), bk2d::point::Path::new(-2, 2));
assert_eq!(bk2d::point::Path::merge(&[a, b, c]), bk2d::point::Path::new(0, 3));

pub fn length(self) -> u32

Distance of path

Example

assert_eq!(bk2d::point::Path::new(1, 2).length(), 3);
assert_eq!(bk2d::point::Path::new(5, -3).length(), 8);

Trait Implementations

impl PartialEq<Path> for Path

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

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

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

This method tests for !=.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Path

fn default() -> Path

Returns the "default value" for a type.

impl Eq for Path

impl Copy for Path

impl Debug for Path

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

Formats the value using the given formatter.

impl Add<Path> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, other: Path) -> Point

Point moves on the path

Example

let a = bk2d::point::Point::new(3, 1);
let b = bk2d::point::Path::new(-2, 1);
assert_eq!(a + b, bk2d::point::Point::new(1, 2));

impl Add<Path> for Path

type Output = Path

The resulting type after applying the + operator.

fn add(self, other: Path) -> Path

Vector Addition

Example

let a = bk2d::point::Path::new(2, 1);
let b = bk2d::point::Path::new(-3, 2);
let c = bk2d::point::Path::new(1, 0);
assert_eq!(a + b, bk2d::point::Path::new(-1, 3));
assert_eq!(a + c, bk2d::point::Path::new(3, 1));
assert_eq!(b + c, bk2d::point::Path::new(-2, 2));
assert_eq!(a + b + c, bk2d::point::Path::new(0, 3));

impl Sub<Path> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, other: Path) -> Point

Point moves backward on the path

Example

let a = bk2d::point::Point::new(1, 2);
let b = bk2d::point::Path::new(-2, 1);
assert_eq!(a - b, bk2d::point::Point::new(3, 1));

impl AddAssign<Path> for Point

fn add_assign(&mut self, other: Path)

Point moves on the path

Example

let mut a = bk2d::point::Point::new(3, 1);
a += bk2d::point::Path::new(-2, 1);
assert_eq!(a, bk2d::point::Point::new(1, 2));

impl SubAssign<Path> for Point

fn sub_assign(&mut self, other: Path)

Point moves backward on the path

Example

let mut a = bk2d::point::Point::new(1, 2);
a -= bk2d::point::Path::new(-2, 1);
assert_eq!(a, bk2d::point::Point::new(3, 1));