Struct Point 

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

A 2D point.

Fields

x: f64

The x coordinate.

y: f64

The y coordinate.

Implementations

impl Point

pub const ZERO: Point

The point (0, 0).

pub const ORIGIN: Point

The point at the origin; (0, 0).

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

Create a new Point with the provided x and y coordinates.

pub const fn to_vec2(self) -> Vec2

Convert this point into a Vec2.

pub fn lerp(self, other: Point, t: f64) -> Point

Linearly interpolate between two points.

pub fn midpoint(self, other: Point) -> Point

Determine the midpoint of two points.

pub fn distance(self, other: Point) -> f64

Euclidean distance.

pub fn distance_squared(self, other: Point) -> f64

Squared Euclidean distance.

pub fn round(self) -> Point

Returns a new Point, with x and y rounded to the nearest integer.

Examples

use kurbo::Point;
let a = Point::new(3.3, 3.6).round();
let b = Point::new(3.0, -3.1).round();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);

pub fn ceil(self) -> Point

Returns a new Point, with x and y rounded up to the nearest integer, unless they are already an integer.

Examples

use kurbo::Point;
let a = Point::new(3.3, 3.6).ceil();
let b = Point::new(3.0, -3.1).ceil();
assert_eq!(a.x, 4.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);

pub fn floor(self) -> Point

Returns a new Point, with x and y rounded down to the nearest integer, unless they are already an integer.

Examples

use kurbo::Point;
let a = Point::new(3.3, 3.6).floor();
let b = Point::new(3.0, -3.1).floor();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 3.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -4.0);

pub fn expand(self) -> Point

Returns a new Point, with x and y rounded away from zero to the nearest integer, unless they are already an integer.

Examples

use kurbo::Point;
let a = Point::new(3.3, 3.6).expand();
let b = Point::new(3.0, -3.1).expand();
assert_eq!(a.x, 4.0);
assert_eq!(a.y, 4.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -4.0);

pub fn trunc(self) -> Point

Returns a new Point, with x and y rounded towards zero to the nearest integer, unless they are already an integer.

Examples

use kurbo::Point;
let a = Point::new(3.3, 3.6).trunc();
let b = Point::new(3.0, -3.1).trunc();
assert_eq!(a.x, 3.0);
assert_eq!(a.y, 3.0);
assert_eq!(b.x, 3.0);
assert_eq!(b.y, -3.0);

pub fn is_finite(self) -> bool

Is this point finite?

pub fn is_nan(self) -> bool

Is this point NaN?

Trait Implementations

impl Add<(f64, f64)> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, _: (f64, f64)) -> Point

Performs the + operation.

impl Add<Vec2> for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<(f64, f64)> for Point

fn add_assign(&mut self, _: (f64, f64))

Performs the += operation.

impl AddAssign<Vec2> for Point

fn add_assign(&mut self, other: Vec2)

Performs the += operation.

impl Clone for Point

fn clone(&self) -> Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl Default for Point

fn default() -> Point

Returns the “default value” for a type.

impl Display for Point

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

Formats the value using the given formatter.

impl From<(f64, f64)> for Point

fn from(v: (f64, f64)) -> Point

Converts to this type from the input type.

impl PartialEq for Point

fn eq(&self, other: &Point) -> 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 Sub<(f64, f64)> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, _: (f64, f64)) -> Point

Performs the - operation.

impl Sub<Vec2> for Point

type Output = Point

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Point

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<(f64, f64)> for Point

fn sub_assign(&mut self, _: (f64, f64))

Performs the -= operation.

impl SubAssign<Vec2> for Point

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

impl Copy for Point

impl StructuralPartialEq for Point