Struct Point2 

pub struct Point2 { /* private fields */ }

A 2D point represented with f64 coordinates.

Implementations

impl Point2

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

Creates a point from x and y coordinates.

pub const fn x(&self) -> f64

Returns the horizontal coordinate.

pub const fn y(&self) -> f64

Returns the vertical coordinate.

pub const fn try_new(x: f64, y: f64) -> Result<Self, GeometryError>

Creates a point from finite x and y coordinates.

Errors

Returns GeometryError::NonFiniteComponent when x or y is NaN or infinite.

Examples

use use_geometry::{GeometryError, Point2};

let point = Point2::try_new(1.0, -2.0)?;
assert_eq!(point, Point2::new(1.0, -2.0));

assert!(matches!(
    Point2::try_new(f64::NAN, 0.0),
    Err(GeometryError::NonFiniteComponent { component: "x", .. })
));

pub const fn validate(self) -> Result<Self, GeometryError>

Validates that an existing point contains only finite coordinates.

Errors

Returns GeometryError::NonFiniteComponent when self.x or self.y is NaN or infinite.

Examples

use use_geometry::{GeometryError, Point2};

let validated = Point2::new(3.0, 4.0).validate()?;
assert_eq!(validated, Point2::new(3.0, 4.0));

pub const fn is_finite(self) -> bool

Returns true when both coordinates are finite.

pub const fn origin() -> Self

Returns the origin (0, 0).

pub fn distance_to(self, other: Self) -> f64

Returns the Euclidean distance to another point.

Examples

use use_geometry::Point2;

let origin = Point2::new(0.0, 0.0);
let point = Point2::new(3.0, 4.0);

assert_eq!(origin.distance_to(point), 5.0);

pub fn distance_squared_to(self, other: Self) -> f64

Returns the squared Euclidean distance to another point.

Examples

use use_geometry::Point2;

let left = Point2::new(0.0, 0.0);
let right = Point2::new(3.0, 4.0);

assert_eq!(left.distance_squared_to(right), 25.0);

pub const fn midpoint(self, other: Self) -> Self

Returns the midpoint between this point and another point.

Examples

use use_geometry::Point2;

let left = Point2::new(-2.0, 1.0);
let right = Point2::new(4.0, 5.0);

assert_eq!(left.midpoint(right), Point2::new(1.0, 3.0));

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

Returns a point interpolated between this point and other.

Examples

use use_geometry::Point2;

let start = Point2::new(0.0, 0.0);
let end = Point2::new(8.0, 4.0);

assert_eq!(start.lerp(end, 0.25), Point2::new(2.0, 1.0));

pub const fn translate(self, vector: Vector2) -> Self

Returns a point translated by a vector.

Examples

use use_geometry::{Point2, Vector2};

let point = Point2::new(1.5, -2.0);
let offset = Vector2::new(2.0, 3.5);

assert_eq!(point.translate(offset), Point2::new(3.5, 1.5));

pub const fn aabb(self) -> Aabb2

Returns the degenerate bounding box rooted at this point.

Trait Implementations

impl Add<Vector2> for Point2

type Output = Point2

The resulting type after applying the + operator.

fn add(self, rhs: Vector2) -> Self::Output

Performs the + operation.

impl Clone for Point2

fn clone(&self) -> Point2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point2

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

Formats the value using the given formatter.

impl PartialEq for Point2

fn eq(&self, other: &Point2) -> 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<Vector2> for Point2

type Output = Point2

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2) -> Self::Output

Performs the - operation.

impl Sub for Point2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for Point2

impl StructuralPartialEq for Point2