Struct gooey::core::figures::Point

pub struct Point<T, Unit> {
    pub x: T,
    pub y: T,
    /* private fields */
}

A location represented by an x and y value.

Fields

x: T

y: T

Implementations

impl<T, U> Point<T, U> where
    T: Default + Copy, 

pub fn from_x(x: impl Into<Figure<T, U>>) -> Point<T, U>

Returns a new point with x, and T::default() for y.

pub fn from_y(y: impl Into<Figure<T, U>>) -> Point<T, U>

Returns a new point with y, and T::default() for x.

impl<T, Unit> Point<T, Unit>

pub const fn new(x: T, y: T) -> Point<T, Unit>

Returns a new Point.

impl<T, Unit> Point<T, Unit> where
    T: Copy, 

pub fn from_figures(x: Figure<T, Unit>, y: Figure<T, Unit>) -> Point<T, Unit>

Returns a new Point.

pub fn x(&self) -> Figure<T, Unit>

Returns the x component.

pub fn y(&self) -> Figure<T, Unit>

Returns the y component.

pub fn cast_unit<NewUnit>(&self) -> Point<T, NewUnit>

Returns this value with the new unit. Does not affect the underlying value.

impl<T, Unit> Point<T, Unit> where
    T: NumCast + Copy, 

pub fn try_cast<Output>(self) -> Option<Point<Output, Unit>> where
    Output: NumCast + Copy, 

Attempts to convert from T to Output using NumCast. Returns None if the value can’t be converted.

pub fn cast<Output>(self) -> Point<Output, Unit> where
    Output: NumCast + Copy, 

Converts from T to Output.

Panics

Panics if Self::try_cast() returns None.

impl<T, Unit> Point<T, Unit> where
    T: Signed + Copy, 

pub fn abs(self) -> Point<T, Unit>

Returns a new instance with the absolute value of each component.

pub fn signum(&self) -> Vector<T, Unit>

Returns a Vector with the result of signum() called on each component.

impl<T, Unit> Point<T, Unit> where
    T: PartialOrd<T> + Copy, 

pub fn min(&self, rhs: &Point<T, Unit>) -> Point<T, Unit>

Returns a new Point with the smaller value of each component.

pub fn max(&self, rhs: &Point<T, Unit>) -> Point<T, Unit>

Returns a new Point with the larger value of each component.

Trait Implementations

impl<T, Unit> AbsDiffEq<Point<T, Unit>> for Point<T, Unit> where
    T: AbsDiffEq<T, Epsilon = T> + Copy, 

type Epsilon = <T as AbsDiffEq<T>>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(
    &self,
    other: &Point<T, Unit>,
    epsilon: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon
) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(
    &self,
    other: &Point<T, Unit>,
    epsilon: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon
) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T, Unit> Add<Point<T, Unit>> for Point<T, Unit> where
    T: Add<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the + operator.

fn add(
    self,
    rhs: Point<T, Unit>
) -> <Point<T, Unit> as Add<Point<T, Unit>>>::Output

Performs the + operation.

impl<T, Unit> Add<Size<T, Unit>> for Point<T, Unit> where
    T: Add<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the + operator.

fn add(
    self,
    rhs: Size<T, Unit>
) -> <Point<T, Unit> as Add<Size<T, Unit>>>::Output

Performs the + operation.

impl<T, Unit> Add<Vector<T, Unit>> for Point<T, Unit> where
    T: Add<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the + operator.

fn add(
    self,
    rhs: Vector<T, Unit>
) -> <Point<T, Unit> as Add<Vector<T, Unit>>>::Output

Performs the + operation.

impl<T, Unit> AddAssign<Point<T, Unit>> for Point<T, Unit> where
    T: AddAssign<T> + Copy, 

fn add_assign(&mut self, rhs: Point<T, Unit>)

Performs the += operation.

impl<T, Unit> AddAssign<Size<T, Unit>> for Point<T, Unit> where
    T: AddAssign<T> + Copy, 

fn add_assign(&mut self, rhs: Size<T, Unit>)

Performs the += operation.

impl<T, Unit> AddAssign<Vector<T, Unit>> for Point<T, Unit> where
    T: AddAssign<T> + Copy, 

fn add_assign(&mut self, rhs: Vector<T, Unit>)

Performs the += operation.

impl<T, Unit> Approx<T> for Point<T, Unit> where
    T: AbsDiffEq<T> + Copy, 

fn approx_eq(&self, other: &Point<T, Unit>) -> bool

Returns true if the values are approximately equal. Uses [approx::AbsDiffEq] with the default epsilon.

fn approx_ne(&self, other: &Self) -> bool

Returns true if the values are not approximately equal. Uses [approx::AbsDiffEq] with the default epsilon.

impl<T, Unit> Ceil for Point<T, Unit> where
    T: Ceil, 

fn ceil(self) -> Point<T, Unit>

Rounds to the smallest integer equal or greater than the original value.

impl<T, Unit> Clone for Point<T, Unit> where
    T: Clone, 

fn clone(&self) -> Point<T, Unit>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, Unit> Debug for Point<T, Unit> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T, Unit> Default for Point<T, Unit> where
    T: Default, 

fn default() -> Point<T, Unit>

Returns the “default value” for a type.

impl<T> Displayable<T> for Point<T, Points> where
    T: Mul<T, Output = T> + Copy + Div<T, Output = T>, 

type Pixels = Point<T, Pixels>

The Pixels unit type for this implementor.

type Points = Point<T, Points>

The Points unit type for this implementor.

type Scaled = Point<T, Scaled>

The Scaled unit type for this implementor.

fn to_pixels(
    &self,
    scale: &DisplayScale<T>
) -> <Point<T, Points> as Displayable<T>>::Pixels

Returns this value after applying scale, if needed.

fn to_points(
    &self,
    _scale: &DisplayScale<T>
) -> <Point<T, Points> as Displayable<T>>::Points

Returns this value after applying scale, if needed.

fn to_scaled(
    &self,
    scale: &DisplayScale<T>
) -> <Point<T, Points> as Displayable<T>>::Scaled

Returns this value after applying scale, if needed.

impl<T> Displayable<T> for Point<T, Scaled> where
    T: Mul<T, Output = T> + Copy + Div<T, Output = T>, 

type Pixels = Point<T, Pixels>

The Pixels unit type for this implementor.

type Points = Point<T, Points>

The Points unit type for this implementor.

type Scaled = Point<T, Scaled>

The Scaled unit type for this implementor.

fn to_pixels(
    &self,
    scale: &DisplayScale<T>
) -> <Point<T, Scaled> as Displayable<T>>::Pixels

Returns this value after applying scale, if needed.

fn to_points(
    &self,
    scale: &DisplayScale<T>
) -> <Point<T, Scaled> as Displayable<T>>::Points

Returns this value after applying scale, if needed.

fn to_scaled(
    &self,
    _scale: &DisplayScale<T>
) -> <Point<T, Scaled> as Displayable<T>>::Scaled

Returns this value after applying scale, if needed.

impl<T> Displayable<T> for Point<T, Pixels> where
    T: Mul<T, Output = T> + Copy + Div<T, Output = T>, 

type Pixels = Point<T, Pixels>

The Pixels unit type for this implementor.

type Points = Point<T, Points>

The Points unit type for this implementor.

type Scaled = Point<T, Scaled>

The Scaled unit type for this implementor.

fn to_pixels(
    &self,
    _scale: &DisplayScale<T>
) -> <Point<T, Pixels> as Displayable<T>>::Pixels

Returns this value after applying scale, if needed.

fn to_points(
    &self,
    scale: &DisplayScale<T>
) -> <Point<T, Pixels> as Displayable<T>>::Points

Returns this value after applying scale, if needed.

fn to_scaled(
    &self,
    scale: &DisplayScale<T>
) -> <Point<T, Pixels> as Displayable<T>>::Scaled

Returns this value after applying scale, if needed.

impl<T, UnitA, UnitB> Div<Scale<T, UnitA, UnitB>> for Point<T, UnitB> where
    T: Div<T, Output = T> + Copy, 

type Output = Point<T, UnitA>

The resulting type after applying the / operator.

fn div(
    self,
    rhs: Scale<T, UnitA, UnitB>
) -> <Point<T, UnitB> as Div<Scale<T, UnitA, UnitB>>>::Output

Performs the / operation.

impl<T, Unit> Div<T> for Point<T, Unit> where
    T: Div<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> <Point<T, Unit> as Div<T>>::Output

Performs the / operation.

impl<T, Unit> Floor for Point<T, Unit> where
    T: Floor, 

fn floor(self) -> Point<T, Unit>

Rounds to the biggest integer equal or lower than the original value.

impl<T, Unit> From<(T, T)> for Point<T, Unit> where
    T: Copy, 

fn from(tuple: (T, T)) -> Point<T, Unit>

Converts to this type from the input type.

impl<T, Unit> From<Point<T, Unit>> for Vector<T, Unit>

fn from(other: Point<T, Unit>) -> Vector<T, Unit>

Converts to this type from the input type.

impl<T, Unit> From<Vector<T, Unit>> for Point<T, Unit>

fn from(other: Vector<T, Unit>) -> Point<T, Unit>

Converts to this type from the input type.

impl<T, UnitA, UnitB> Mul<Scale<T, UnitA, UnitB>> for Point<T, UnitA> where
    T: Mul<T, Output = T> + Copy, 

type Output = Point<T, UnitB>

The resulting type after applying the * operator.

fn mul(
    self,
    rhs: Scale<T, UnitA, UnitB>
) -> <Point<T, UnitA> as Mul<Scale<T, UnitA, UnitB>>>::Output

Performs the * operation.

impl<T, Unit> Mul<T> for Point<T, Unit> where
    T: Mul<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <Point<T, Unit> as Mul<T>>::Output

Performs the * operation.

impl<T, Unit> Neg for Point<T, Unit> where
    T: Neg<Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the - operator.

fn neg(self) -> <Point<T, Unit> as Neg>::Output

Performs the unary - operation.

impl<T, Unit> PartialEq<Point<T, Unit>> for Point<T, Unit> where
    T: PartialEq<T>, 

fn eq(&self, other: &Point<T, Unit>) -> bool

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

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

This method tests for !=.

impl<T, Unit> PartialEq<Size<T, Unit>> for Point<T, Unit> where
    T: PartialEq<T>, 

fn eq(&self, other: &Size<T, Unit>) -> bool

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

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

This method tests for !=.

impl<T, Unit> PartialEq<Vector<T, Unit>> for Point<T, Unit> where
    T: PartialEq<T>, 

fn eq(&self, other: &Vector<T, Unit>) -> bool

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

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

This method tests for !=.

impl<T, Unit> RelativeEq<Point<T, Unit>> for Point<T, Unit> where
    T: RelativeEq<T, Epsilon = T> + Copy, 

fn default_max_relative(
) -> <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Point<T, Unit>,
    epsilon: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon,
    max_relative: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Point<T, Unit>,
    epsilon: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon,
    max_relative: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<T, Unit> Round for Point<T, Unit> where
    T: Round, 

fn round(self) -> Point<T, Unit>

Rounds to the nearest integer value.

impl<T, Unit> Sub<Point<T, Unit>> for Point<T, Unit> where
    T: Sub<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the - operator.

fn sub(
    self,
    rhs: Point<T, Unit>
) -> <Point<T, Unit> as Sub<Point<T, Unit>>>::Output

Performs the - operation.

impl<T, Unit> Sub<Size<T, Unit>> for Point<T, Unit> where
    T: Sub<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the - operator.

fn sub(
    self,
    rhs: Size<T, Unit>
) -> <Point<T, Unit> as Sub<Size<T, Unit>>>::Output

Performs the - operation.

impl<T, Unit> Sub<Vector<T, Unit>> for Point<T, Unit> where
    T: Sub<T, Output = T> + Copy, 

type Output = Point<T, Unit>

The resulting type after applying the - operator.

fn sub(
    self,
    rhs: Vector<T, Unit>
) -> <Point<T, Unit> as Sub<Vector<T, Unit>>>::Output

Performs the - operation.

impl<T, Unit> SubAssign<Point<T, Unit>> for Point<T, Unit> where
    T: SubAssign<T> + Copy, 

fn sub_assign(&mut self, rhs: Point<T, Unit>)

Performs the -= operation.

impl<T, Unit> SubAssign<Size<T, Unit>> for Point<T, Unit> where
    T: SubAssign<T> + Copy, 

fn sub_assign(&mut self, rhs: Size<T, Unit>)

Performs the -= operation.

impl<T, Unit> SubAssign<Vector<T, Unit>> for Point<T, Unit> where
    T: SubAssign<T> + Copy, 

fn sub_assign(&mut self, rhs: Vector<T, Unit>)

Performs the -= operation.

impl<T, Unit> UlpsEq<Point<T, Unit>> for Point<T, Unit> where
    T: UlpsEq<T, Epsilon = T> + Copy, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(
    &self,
    other: &Point<T, Unit>,
    epsilon: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon,
    max_ulps: u32
) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(
    &self,
    other: &Point<T, Unit>,
    epsilon: <Point<T, Unit> as AbsDiffEq<Point<T, Unit>>>::Epsilon,
    max_ulps: u32
) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T, Unit> Vectorlike<T, Unit> for Point<T, Unit> where
    T: Copy, 

fn to_vector(&self) -> Vector<T, Unit>

Returns self as a Vector.

fn to_size(&self) -> Size<T, Unit>

Returns self as a Size.

fn to_point(&self) -> Point<T, Unit>

Returns self as a Point.

impl<T, Unit> Copy for Point<T, Unit> where
    T: Copy, 

impl<T, Unit> Eq for Point<T, Unit> where
    T: Eq,