Struct Point

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

Helper struct defining a 2D point in space.

Fields

x: i32

The point’s X location

y: i32

The point’s Y location

Implementations

impl Point

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

where T: TryInto<i32>,

Create a new point from an x/y coordinate.

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

Create a new point from i32, this can be constant

pub fn zero() -> Point

Create a zero point

pub fn from_tuple<T>(t: (T, T)) -> Point

where T: TryInto<i32>,

Create a point from a tuple of two i32s

pub fn to_index<T>(self, width: T) -> usize

where T: TryInto<usize>,

Helper for map index conversion

pub fn to_tuple(self) -> (i32, i32)

Converts the point to an i32 tuple

pub fn to_unsigned_tuple(self) -> (usize, usize)

Converts the point to a usize tuple

Panics

This can panic if X or Y are not convertible to a usize.

pub fn to_vec2(self) -> Vec2

Converts the point to an UltraViolet vec2

pub fn from_vec2(v: Vec2) -> Point

Creates a point from an UltraViolet vec2

Trait Implementations

impl Add<i32> for Point

Support adding an int to a point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: i32) -> Point

Performs the + operation.

impl Add for Point

Overloads: We support basic point math Support adding a point to a point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Point) -> Point

Performs the + operation.

impl AddAssign for Point

fn add_assign(&mut self, other: 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 Debug for Point

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

Formats the value using the given formatter.

impl Div<f32> for Point

Support dividing a point by an f32

type Output = Point

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Point

Performs the / operation.

impl Div<i32> for Point

Support dividing a point by an int

type Output = Point

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Point

Support dividing a point by a point

type Output = Point

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Point

fn div_assign(&mut self, other: Point)

Performs the /= operation.

impl From<(f32, f32)> for Point

fn from(item: (f32, f32)) -> Point

Converts to this type from the input type.

impl From<(i32, i32)> for Point

fn from(item: (i32, i32)) -> Point

Converts to this type from the input type.

impl From<Vec2> for Point

fn from(item: Vec2) -> Point

Converts to this type from the input type.

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

Support multiplying a point by an f32

type Output = Point

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Point

Performs the * operation.

impl Mul<i32> for Point

Support multiplying a point by an int

type Output = Point

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Point

Support multiplying a point by a point

type Output = Point

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Point

fn mul_assign(&mut self, other: Point)

Performs the *= operation.

impl PartialEq for Point

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<i32> for Point

Support subtracting an int from a point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: i32) -> Point

Performs the - operation.

impl Sub for Point

Support subtracting a point from a point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: Point) -> Point

Performs the - operation.

impl SubAssign for Point

fn sub_assign(&mut self, other: Point)

Performs the -= operation.

impl Copy for Point

impl Eq for Point

impl StructuralPartialEq for Point