Struct ludomath::vec2d::Point

#[repr(C)]
pub struct Point {
    pub x: f32,
    pub y: f32,
}

Represents a cartesian point in the 2D euclidean plane.

Fields

x: f32

The X coordinate of the point.

y: f32

The Y coordinate of the point.

Methods

impl Point

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

Constructs a new point from x- and y-components.

pub fn new_polar_rad(radius: f32, angle: f32) -> Point

Constructs a new point from polar coordinates.

The angle is given in radians.

pub fn new_polar_deg(radius: f32, angle: f32) -> Point

Constructs a new point from polar coordinates.

The angle is given in degrees.

pub fn dist(self, other: Point) -> f32

Computes the euclidean distance between two points.

pub fn rotate(self, pivot: Point, rotation: Rotation) -> Point

Rotates a point around a pivot point.

pub fn rotate_rad(self, pivot: Point, angle: f32) -> Point

Rotates a point angle radians counter-clockwise around a pivot point.

pub fn rotate_deg(self, pivot: Point, angle: f32) -> Point

Rotates a point angle degrees counter-clockwise around a pivot point.

pub fn lerp(self, other: Point, t: f32) -> Point

Linearly interpolates from one point to another by t.

t < 0 or t > 1 gives results outside the rectangular bounds of the points.

pub fn is_in_rect(self, vert1: Point, vert2: Point) -> bool

Returns true if self is within the (inclusive) bounds of the rectangle defined by two points.

pub fn clamp_to_rect(self, vert1: Point, vert2: Point) -> Point

Clamps a vector to within the (inclusive) bounds of the rectangle defined by two points.

pub fn as_vec(self) -> Vector

Reinterprets the x- and y-components of a point as a vector.

pub fn from_gl_vec2(vec2: [f32; 2]) -> Point

Changes the type of a OpenGL-style vec2 array to a Point.

Optimizes into a simple copy, since the types have the same layout. Useful mostly for interop with other libraries, like OpenGL wrappers.

pub fn to_gl_vec2(self) -> [f32; 2]

Changes the type of a Point to a OpenGL-style vec2 array.

Optimizes into a simple copy, since the types have the same layout. Useful mostly for interop with other libraries, like OpenGL wrappers.

pub fn from_vec2(vec2: [f32; 2]) -> Point

Converts a OpenGL-style vec2 to a Point.

Optimizes into a simple copy, since the types have the same layout.

pub fn to_vec2(self) -> [f32; 2]

Converts a Point to a OpenGL-style vec2.

Optimizes into a simple copy, since the types have the same layout.

pub fn to_vec3(self) -> [f32; 3]

Converts a Point to a OpenGL-style vec3.

The result is padded to [x, y, 0].

pub fn to_vec4(self) -> [f32; 4]

Converts a Point to a OpenGL-style vec4.

The result is padded to [x, y, 0, 1].

pub fn arr_from_vec2s(arr: &[[f32; 2]]) -> &[Point]

Reinterprets a slice of vec2s as Points.

Does not allocate a new array, only changes the type of the pointer.

pub fn arr_to_vec2s(arr: &[Point]) -> &[[f32; 2]]

Reinterprets a slice of Points as vec2s.

Does not allocate a new array, only changes the type of the pointer.

Trait Implementations

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

impl Default for Point

fn default() -> Point

Returns the "default value" for a type.

impl PartialEq for Point

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

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

fn ne(&self, __arg_0: &Point) -> bool

This method tests for !=.

impl Debug for Point

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Transformation<Point> for Transform

fn transform(self, pt: Point) -> Point

Returns a transformed copy of an object.

fn inverse_transform(self, pt: Point) -> Point

Transforms an object by the inverse of a transformation.

fn transform_mut(self, operand: &mut T) where
    T: Copy, 

Transforms an object, mutating it.

fn inverse_transform_checked(self, operand: T) -> Option<T>

Transforms an object by the inverse of a transformation.

impl Add<Vector> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, other: Vector) -> Point

Performs the + operation.

impl Add<Point> for Vector

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<Vector> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, other: Vector) -> Point

Performs the - operation.

impl Sub<Point> for Point

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, other: Point) -> Vector

Performs the - operation.

impl AddAssign<Vector> for Point

fn add_assign(&mut self, other: Vector)

Performs the += operation.

impl SubAssign<Vector> for Point

fn sub_assign(&mut self, other: Vector)

Performs the -= operation.