Struct embedded_graphics::geometry::Point [−][src]
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
impl Point
[src]
impl Point
[src]pub const fn new_equal(value: i32) -> Point
[src]
pub const fn new_equal(value: i32) -> Point
[src]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 x_axis(self) -> Point
[src]
pub const fn x_axis(self) -> Point
[src]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
[src]
pub const fn y_axis(self) -> Point
[src]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
[src]
pub const fn abs(self) -> Point
[src]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
[src]
pub fn component_min(self, other: Point) -> Point
[src]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));
pub fn component_max(self, other: Point) -> Point
[src]
pub fn component_max(self, other: Point) -> Point
[src]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));
pub fn component_mul(self, other: Point) -> Point
[src]
pub fn component_mul(self, other: Point) -> Point
[src]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));
pub fn component_div(self, other: Point) -> Point
[src]
pub fn component_div(self, other: Point) -> Point
[src]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
impl AddAssign<Point> for Point
[src]
impl AddAssign<Point> for Point
[src]pub fn add_assign(&mut self, other: Point)
[src]
pub fn add_assign(&mut self, other: Point)
[src]Performs the +=
operation. Read more
impl AddAssign<Size> for Point
[src]
impl AddAssign<Size> for Point
[src]pub fn add_assign(&mut self, other: Size)
[src]
pub fn add_assign(&mut self, other: Size)
[src]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 DivAssign<i32> for Point
[src]
impl DivAssign<i32> for Point
[src]pub fn div_assign(&mut self, rhs: i32)
[src]
pub fn div_assign(&mut self, rhs: i32)
[src]Performs the /=
operation. Read more
impl<'_, N> From<&'_ Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
N: Into<i32> + Scalar + Copy,
[src]
impl<'_, N> From<&'_ Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
N: Into<i32> + Scalar + Copy,
[src]impl<N> From<Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
N: Into<i32> + Scalar + Copy,
[src]
impl<N> From<Matrix<N, U2, U1, <DefaultAllocator as Allocator<N, U2, U1>>::Buffer>> for Point where
N: Into<i32> + Scalar + Copy,
[src]impl MulAssign<i32> for Point
[src]
impl MulAssign<i32> for Point
[src]pub fn mul_assign(&mut self, rhs: i32)
[src]
pub fn mul_assign(&mut self, rhs: i32)
[src]Performs the *=
operation. Read more
impl Ord for Point
[src]
impl Ord for Point
[src]impl PartialOrd<Point> for Point
[src]
impl PartialOrd<Point> for Point
[src]pub fn partial_cmp(&self, other: &Point) -> Option<Ordering>
[src]
pub fn partial_cmp(&self, other: &Point) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl SubAssign<Point> for Point
[src]
impl SubAssign<Point> for Point
[src]pub fn sub_assign(&mut self, other: Point)
[src]
pub fn sub_assign(&mut self, other: Point)
[src]Performs the -=
operation. Read more
impl SubAssign<Size> for Point
[src]
impl SubAssign<Size> for Point
[src]pub fn sub_assign(&mut self, other: Size)
[src]
pub fn sub_assign(&mut self, other: Size)
[src]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
[src]
impl Eq for Point
[src]
impl StructuralEq for Point
[src]
impl StructuralPartialEq for Point
[src]
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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
[src]
impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
[src]pub fn lossless_try_into(self) -> Option<Dst>
[src]
pub fn lossless_try_into(self) -> Option<Dst>
[src]Performs the conversion.
impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
[src]
impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
[src]pub fn lossy_into(self) -> Dst
[src]
pub fn lossy_into(self) -> Dst
[src]Performs the conversion.
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T, Right> ClosedAdd<Right> for T where
T: Add<Right, Output = T> + AddAssign<Right>,
T: Add<Right, Output = T> + AddAssign<Right>,
impl<T, Right> ClosedDiv<Right> for T where
T: Div<Right, Output = T> + DivAssign<Right>,
T: Div<Right, Output = T> + DivAssign<Right>,
impl<T, Right> ClosedMul<Right> for T where
T: Mul<Right, Output = T> + MulAssign<Right>,
T: Mul<Right, Output = T> + MulAssign<Right>,
impl<T> ClosedNeg for T where
T: Neg<Output = T>,
T: Neg<Output = T>,
impl<T, Right> ClosedSub<Right> for T where
T: Sub<Right, Output = T> + SubAssign<Right>,
T: Sub<Right, Output = T> + SubAssign<Right>,