Struct embedded_graphics::geometry::Point
source · [−]Expand description
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
sourceimpl Point
impl Point
sourcepub const fn new_equal(value: i32) -> Point
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 });
sourcepub const fn x_axis(self) -> Point
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));
sourcepub const fn y_axis(self) -> Point
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));
sourcepub const fn abs(self) -> Point
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));
sourcepub fn component_min(self, other: Point) -> Point
pub fn component_min(self, other: Point) -> Point
Returns the componentwise minimum of two Point
s
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));
sourcepub fn component_max(self, other: Point) -> Point
pub fn component_max(self, other: Point) -> Point
Returns the componentwise maximum of two Point
s
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));
sourcepub fn component_mul(self, other: Point) -> Point
pub fn component_mul(self, other: Point) -> Point
Returns the componentwise multiplication of two Point
s.
use embedded_graphics::geometry::Point;
let result = Point::new(20, 30).component_mul(Point::new(-2, 3));
assert_eq!(result, Point::new(-40, 90));
sourcepub fn component_div(self, other: Point) -> Point
pub fn component_div(self, other: Point) -> Point
Returns the componentwise division of two Points
s.
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
sourceimpl AddAssign<Point> for Point
impl AddAssign<Point> for Point
sourcepub fn add_assign(&mut self, other: Point)
pub fn add_assign(&mut self, other: Point)
Performs the +=
operation. Read more
sourceimpl AddAssign<Size> for Point
impl AddAssign<Size> for Point
sourcepub fn add_assign(&mut self, other: Size)
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.
sourceimpl DivAssign<i32> for Point
impl DivAssign<i32> for Point
sourcepub fn div_assign(&mut self, rhs: i32)
pub fn div_assign(&mut self, rhs: i32)
Performs the /=
operation. Read more
sourceimpl MulAssign<i32> for Point
impl MulAssign<i32> for Point
sourcepub fn mul_assign(&mut self, rhs: i32)
pub fn mul_assign(&mut self, rhs: i32)
Performs the *=
operation. Read more
sourceimpl Ord for Point
impl Ord for Point
sourceimpl PartialOrd<Point> for Point
impl PartialOrd<Point> for Point
sourcepub fn partial_cmp(&self, other: &Point) -> Option<Ordering>
pub fn partial_cmp(&self, other: &Point) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl SubAssign<Point> for Point
impl SubAssign<Point> for Point
sourcepub fn sub_assign(&mut self, other: Point)
pub fn sub_assign(&mut self, other: Point)
Performs the -=
operation. Read more
sourceimpl SubAssign<Size> for Point
impl SubAssign<Size> for Point
sourcepub fn sub_assign(&mut self, other: Size)
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 Copy for Point
impl Eq for Point
impl StructuralEq for Point
impl StructuralPartialEq for Point
Auto Trait Implementations
impl RefUnwindSafe for Point
impl Send for Point
impl Sync for Point
impl Unpin for Point
impl UnwindSafe for Point
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CheckedAs for T
impl<T> CheckedAs for T
sourcepub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
pub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
sourcepub fn checked_cast_from(src: Src) -> Option<Dst>
pub fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
sourceimpl<T> OverflowingAs for T
impl<T> OverflowingAs for T
sourcepub fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
pub fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
sourcepub fn overflowing_cast_from(src: Src) -> (Dst, bool)
pub fn overflowing_cast_from(src: Src) -> (Dst, bool)
OverflowingCasts the value.
sourceimpl<T> SaturatingAs for T
impl<T> SaturatingAs for T
sourcepub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
pub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
sourcepub fn saturating_cast_from(src: Src) -> Dst
pub fn saturating_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
sourcepub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
pub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
sourcepub fn unwrapped_cast_from(src: Src) -> Dst
pub fn unwrapped_cast_from(src: Src) -> Dst
UnwrappedCasts the value.
sourceimpl<T> WrappingAs for T
impl<T> WrappingAs for T
sourcepub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
pub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
sourcepub fn wrapping_cast_from(src: Src) -> Dst
pub fn wrapping_cast_from(src: Src) -> Dst
WrappingCasts the value.