Struct bk2d::point::Point

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

A point

Example

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

assert_eq!(point.x, 1);
assert_eq!(point.y, 2);

Fields

x: i32

y: i32

Methods

impl Point

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

pub fn length(self) -> u32

Distance to origin

Example

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

pub fn inside(self, board: Board) -> bool

Point inside board

Example

let board = bk2d::point::Board::new(5, 5);

assert!(bk2d::point::Point::new(0, 4).inside(board));
assert!(bk2d::point::Point::new(3, 0).inside(board));
assert!(bk2d::point::Point::new(3, 4).inside(board));

pub fn outside(self, board: Board) -> bool

Point outside board

Example

let board = bk2d::point::Board::new(5, 5);

assert!(bk2d::point::Point::new(5, 4).outside(board));
assert!(bk2d::point::Point::new(0, 5).outside(board));
assert!(bk2d::point::Point::new(7, -1).outside(board));

Trait Implementations

impl PartialEq<Point> for Point

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

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

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

This method tests for !=.

impl Clone for Point

fn clone(&self) -> Point

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Point

fn default() -> Point

Returns the "default value" for a type.

impl Eq for Point

impl Copy for Point

impl Debug for Point

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

Formats the value using the given formatter.

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 Sub<Point> for Point

type Output = Path

The resulting type after applying the - operator.

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

Vector between two points

Example

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

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 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));