Struct substrate::geometry::point::Point

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

A point in two-dimensional space.

Fields

x: i64

The x-coordinate of the point.

y: i64

The y-coordinate of the point.

Implementations

impl Point

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

Creates a new Point from (x,y) coordinates.

pub const fn from_dir_coords(dir: Dir, a: i64, b: i64) -> Point

Creates a new point from the given direction and coordinates.

If dir is Dir::Horiz, a becomes the x-coordinate and b becomes the y-coordinate. If dir is Dir::Vert, a becomes the y-coordinate and b becomes the x-coordinate.

pub const fn zero() -> Point

Returns the origin, (0, 0).

Example

let origin = Point::zero();
assert_eq!(origin, Point::new(0, 0));

pub const fn coord(&self, dir: Dir) -> i64

Gets the coordinate associated with direction dir.

pub fn snap_to_grid(&self, grid: i64) -> Point

Snaps the x and y coordinates of this point to the nearest multiple of grid.

pub fn snap_x_to_grid(&self, grid: i64) -> Point

Snaps only the x-coordinate of this point to the nearest multiple of grid.

pub fn snap_y_to_grid(&self, grid: i64) -> Point

Snaps only the y-coordinate of this point to the nearest multiple of grid.

Trait Implementations

impl Add<Dims> for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Dims> for Point

fn add_assign(&mut self, rhs: Dims)

Performs the += operation.

impl AddAssign for Point

fn add_assign(&mut self, rhs: Point)

Performs the += operation.

impl Clone for Point

fn clone(&self) -> Point

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Contains<Point> for Polygon

fn contains(&self, p: &Point) -> Containment

Determines if a point is contained within a polygon.

Example

let points = vec![
    Point { x: -4, y: 0 },
    Point { x: 0, y: 0 },
    Point { x: 1, y: 2 },
    Point { x: 2, y: 2 },
    Point { x: -4, y: 5 },
];
let p1 = Point::new(0,0);
let p2 = Point::new(0,4);
let p3 = Point::new(-5,3);
let p4 = Point::new(-2,4);
let p5 = Point::new(-2,2);
let polygon = Polygon::from_verts(points);
assert_eq!(polygon.contains(&p1), Containment::Full);
assert_eq!(polygon.contains(&p2), Containment::None);
assert_eq!(polygon.contains(&p3), Containment::None);
assert_eq!(polygon.contains(&p4), Containment::Full);
assert_eq!(polygon.contains(&p5), Containment::Full);

fn encloses(&self, other: &T) -> bool

Returns true if other is fully enclosed in this shape.

fn partially_intersects(&self, other: &T) -> bool

Returns true if other is fully or partially enclosed in this shape.

impl Contains<Point> for Rect

fn contains(&self, other: &Point) -> Containment

Returns a Containment indicating how other is enclosed within this shape.

fn encloses(&self, other: &T) -> bool

Returns true if other is fully enclosed in this shape.

fn partially_intersects(&self, other: &T) -> bool

Returns true if other is fully or partially enclosed in this shape.

impl Contains<Point> for Ring

fn contains(&self, other: &Point) -> Containment

Returns a Containment indicating how other is enclosed within this shape.

fn encloses(&self, other: &T) -> bool

Returns true if other is fully enclosed in this shape.

fn partially_intersects(&self, other: &T) -> bool

Returns true if other is fully or partially enclosed in this shape.

impl Contains<Point> for Shape

fn contains(&self, p: &Point) -> Containment

Returns a Containment indicating how other is enclosed within this shape.

fn encloses(&self, other: &T) -> bool

Returns true if other is fully enclosed in this shape.

fn partially_intersects(&self, other: &T) -> bool

Returns true if other is fully or partially enclosed in this shape.

impl Debug for Point

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

Formats the value using the given formatter.

impl Default for Point

fn default() -> Point

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Point

fn deserialize<__D>( __deserializer: __D ) -> Result<Point, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(i64, i64)> for Point

fn from(value: (i64, i64)) -> Point

Converts to this type from the input type.

impl From<Point> for Dims

fn from(value: Point) -> Dims

Create a new dimension object from a point.

The width field of the resulting Dims will be the point’s x-coordinate. The height field of the resulting Dims will be the point’s y-coordinate.

impl HasTransformedView for Point

type TransformedView = Point

An object storing a transformed view of Self.

fn transformed_view( &self, trans: Transformation ) -> <Point as HasTransformedView>::TransformedView

Produces a transformed view of self.

impl Hash for Point

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Dims> for Point

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

Multiplies the x-coordinate of the point by the dimension’s width, and the y-coordinate of the point by the dimension’s height.

type Output = Point

The resulting type after applying the * operator.

impl Mul for Point

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

Multiplies the two points element wise.

type Output = Point

The resulting type after applying the * operator.

impl Ord for Point

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Point

fn eq(&self, other: &Point) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Point

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

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

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

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

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

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

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

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

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 Serialize for Point

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Point

type Output = Point

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Point

fn sub_assign(&mut self, rhs: Point)

Performs the -= operation.

impl TransformMut for Point

fn transform_mut(&mut self, trans: Transformation)

Applies matrix-vector Transformation trans.

impl TranslateMut for Point

fn translate_mut(&mut self, p: Point)

Translates the shape by a Point through mutation.

impl Copy for Point

impl Eq for Point

impl StructuralPartialEq for Point