Struct embedded_graphics::geometry::Point

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

2D point.

A point can be used to define the position of a graphics object. For example, a Rectangle may be defined that has its top left corner at (-1, -2). To specify the size of an object Size should be used instead.

Nalgebra support can be enabled with the nalgebra_support feature. This implements From<Vector2<N>> and From<&Vector2<N>> where N is Scalar + Into<i32>. This allows use of Nalgebra’s Vector2 with embedded-graphics where i8, i16, i32, u16 or u8 is used for value storage.

Examples

Create a Point from two integers

use embedded_graphics::geometry::Point;

// Create a coord using the `new` constructor method
let p = Point::new(10, 20);

Create a Point from a Nalgebra Vector2

Be sure to enable the nalgebra_support feature to get Nalgebra integration.

use embedded_graphics::geometry::Point;
use nalgebra::Vector2;

let n_coord = Vector2::new(10i32, 20);

assert_eq!(Point::from(n_coord), Point::new(10, 20));

Convert a Vector2<u8> into a Point

Be sure to enable the nalgebra_support feature to get Nalgebra integration.

Smaller unsigned types that can be converted to i32 are also supported in conversions.

use embedded_graphics::geometry::Point;
use nalgebra::Vector2;

let n_coord = Vector2::new(10u8, 20);

assert_eq!(Point::from(n_coord), Point::new(10, 20));

Fields

x: i32

The x coordinate.

y: i32

The y coordinate.

Implementations

impl Point

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

Creates a point from X and Y coordinates.

pub const fn new_equal(value: i32) -> Point

Creates a point with X and Y values set to an equal value.

Examples

use embedded_graphics::geometry::Point;

let point = Point::new_equal(11);

assert_eq!(point, Point { x: 11, y: 11 });

pub const fn zero() -> Point

Creates a point with X and Y equal to zero.

pub const fn x_axis(self) -> Point

Returns a point with equal x value and y set to 0.

Examples

Move a Point along the X axis.

use embedded_graphics::geometry::Point;

let translate = Point::new(20, 30);

let point = Point::new(10, 15);

let moved_x = point + translate.x_axis();

assert_eq!(moved_x, Point::new(30, 15));

pub const fn y_axis(self) -> Point

Returns a point with equal y value and x set to 0.

Examples

Move a Point along the Y axis.

use embedded_graphics::geometry::Point;

let translate = Point::new(20, 30);

let point = Point::new(10, 15);

let moved_y = point + translate.y_axis();

assert_eq!(moved_y, Point::new(10, 45));

pub const fn abs(self) -> Point

Remove the sign from a coordinate

Examples

let point = Point::new(-5, -10);

assert_eq!(point.abs(), Point::new(5, 10));

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

Returns the componentwise minimum of two Points

Examples

use embedded_graphics::geometry::Point;

let min = Point::new(20, 30).component_min(Point::new(15, 50));

assert_eq!(min, Point::new(15, 30));

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

Returns the componentwise maximum of two Points

Examples

use embedded_graphics::geometry::Point;

let min = Point::new(20, 30).component_max(Point::new(15, 50));

assert_eq!(min, Point::new(20, 50));

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

Returns the componentwise multiplication of two Points.

use embedded_graphics::geometry::Point;

let result = Point::new(20, 30).component_mul(Point::new(-2, 3));

assert_eq!(result, Point::new(-40, 90));

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

Returns the componentwise division of two Pointss.

Panics

Panics if one of the components of other equals zero.

use embedded_graphics::geometry::Point;

let result = Point::new(20, 30).component_div(Point::new(10, -3));

assert_eq!(result, Point::new(2, -10));

Trait Implementations

impl Add<Point> for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Size> for Point

pub fn add(self, other: Size) -> Point

Offsets a point by adding a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

type Output = Point

The resulting type after applying the + operator.

impl AddAssign<Point> for Point

pub fn add_assign(&mut self, other: Point)

Performs the += operation.

impl AddAssign<Size> for Point

pub fn add_assign(&mut self, other: Size)

Offsets a point by adding a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

impl Clone for Point

pub fn clone(&self) -> Point

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl Default for Point

pub fn default() -> Point

Returns the “default value” for a type.

impl Div<i32> for Point

type Output = Point

The resulting type after applying the / operator.

pub fn div(self, rhs: i32) -> Point

Performs the / operation.

impl DivAssign<i32> for Point

pub fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl<'_> From<&'_ [i32; 2]> for Point

pub fn from(other: &[i32; 2]) -> Point

Performs the conversion.

impl<'_, N> From<&'_ Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
    N: Into<i32> + Scalar + Copy, 

pub fn from(
    other: &Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>
) -> Point

Performs the conversion.

impl From<[i32; 2]> for Point

pub fn from(other: [i32; 2]) -> Point

Performs the conversion.

impl From<(i32, i32)> for Point

pub fn from(other: (i32, i32)) -> Point

Performs the conversion.

impl<N> From<Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
    N: Into<i32> + Scalar + Copy, 

pub fn from(
    other: Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>
) -> Point

Performs the conversion.

impl Hash for Point

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Index<usize> for Point

type Output = i32

The returned type after indexing.

pub fn index(&self, idx: usize) -> &i32

Performs the indexing (container[index]) operation.

impl Mul<i32> for Point

type Output = Point

The resulting type after applying the * operator.

pub fn mul(self, rhs: i32) -> Point

Performs the * operation.

impl MulAssign<i32> for Point

pub fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl Neg for Point

type Output = Point

The resulting type after applying the - operator.

pub fn neg(self) -> <Point as Neg>::Output

Performs the unary - operation.

impl Ord for Point

pub fn cmp(&self, other: &Point) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Point> for Point

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

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

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

This method tests for !=.

impl PartialOrd<Point> for Point

pub fn partial_cmp(&self, other: &Point) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Point> for Point

type Output = Point

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Size> for Point

pub fn sub(self, other: Size) -> Point

Offsets a point by subtracting a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

type Output = Point

The resulting type after applying the - operator.

impl SubAssign<Point> for Point

pub fn sub_assign(&mut self, other: Point)

Performs the -= operation.

impl SubAssign<Size> for Point

pub fn sub_assign(&mut self, other: Size)

Offsets a point by subtracting a size.

Panics

This function will panic if width or height are too large to be represented as an i32 and debug assertions are enabled.

impl<'_> TryFrom<&'_ [u32; 2]> for Point

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    point: &[u32; 2]
) -> Result<Point, <Point as TryFrom<&'_ [u32; 2]>>::Error>

Performs the conversion.

impl TryFrom<[u32; 2]> for Point

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    point: [u32; 2]
) -> Result<Point, <Point as TryFrom<[u32; 2]>>::Error>

Performs the conversion.

impl TryFrom<(u32, u32)> for Point

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    point: (u32, u32)
) -> Result<Point, <Point as TryFrom<(u32, u32)>>::Error>

Performs the conversion.

impl Copy for Point

impl Eq for Point

impl StructuralEq for Point

impl StructuralPartialEq for Point