Struct math2d::Vector2f

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

Mathematical vector on the 2D (x, y) plane.

Fields

x: f32

Horizontal component.

y: f32

Vertical component.

Methods

impl Vector2f

pub const ZERO: Vector2f

Zero vector, addition identity value.

pub const ONE: Vector2f

One vector, multiplication identity value.

pub const UP: Vector2f

Up vector in the top-left coordinate system common to 2D drawing systems.

pub const RIGHT: Vector2f

Right vector in the top-left coordinate system common to 2D drawing systems.

pub const DOWN: Vector2f

Down vector in the top-left coordinate system common to 2D drawing systems.

pub const LEFT: Vector2f

Left vector in the top-left coordinate system common to 2D drawing systems.

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

Construct a vector from the components.

pub fn to_i32(self) -> Vector2i

Converts the vector to unsigned integer values. Truncates integers, if you want your components to be rounded you must do this manually first.

pub fn to_point(self) -> Point2f

pub fn to_size(self) -> Sizef

Converts this vector to a size value with the x representing width and the y representing height.

pub fn rounded(self) -> Vector2f

Rounds the components of the vector to the nearest integer. Rounds half-way values away from 0.

pub fn dot(self, rhs: Vector2f) -> f32

Dot product of two vectors.

pub fn len_squared(self) -> f32

The squared length of the vector

pub fn len(self) -> f32

The length of the vector. This requires performing a square root, so the squared length should be preferred where possible.

pub fn abs(self) -> Self

Absolute value of the vector components.

pub fn reciprocal(self) -> Self

Component-wise reciprocal

pub fn is_approx_eq(self, other: impl Into<Vector2f>, epsilon: f32) -> bool

Tests if two vectors are approximately equal to each other within a given epsilon. The epsilon is applied component-wise. If you would like to check that two vectors are within a specified distance of each other, you should subtract one from the other and check the length of the resulting distance vector between them.

Trait Implementations

impl Copy for Vector2f

impl PartialEq<Vector2f> for Vector2f

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

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

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

This method tests for !=.

impl Default for Vector2f

fn default() -> Vector2f

Returns the "default value" for a type.

impl From<Vector2f> for Thicknessf

fn from(vec: Vector2f) -> Thicknessf

Performs the conversion.

impl From<f32> for Vector2f

fn from(s: f32) -> Vector2f

Performs the conversion.

impl From<[f32; 2]> for Vector2f

fn from(v: [f32; 2]) -> Vector2f

Performs the conversion.

impl From<Vector2f> for [f32; 2]

fn from(v: Vector2f) -> [f32; 2]

Performs the conversion.

impl From<Vector2f> for Vector2<f32>

fn from(p: Vector2f) -> Vector2<f32>

Performs the conversion.

impl From<Vector2<f32>> for Vector2f

fn from(p: Vector2<f32>) -> Vector2f

Performs the conversion.

impl From<Vec2> for Vector2f

fn from(p: Vec2) -> Vector2f

Performs the conversion.

impl Clone for Vector2f

fn clone(&self) -> Vector2f

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector2f

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

Formats the value using the given formatter.

impl Add<Vector2f> for Rectf

type Output = Rectf

The resulting type after applying the + operator.

fn add(self, rhs: Vector2f) -> Rectf

Performs the + operation.

impl<V> Add<V> for Vector2f where
    V: Into<Vector2f>, 

type Output = Vector2f

The resulting type after applying the + operator.

fn add(self, rhs: V) -> Vector2f

Performs the + operation.

impl Sub<Vector2f> for Rectf

type Output = Rectf

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2f) -> Rectf

Performs the - operation.

impl<V> Sub<V> for Vector2f where
    V: Into<Vector2f>, 

type Output = Vector2f

The resulting type after applying the - operator.

fn sub(self, rhs: V) -> Vector2f

Performs the - operation.

impl Mul<Matrix3x2f> for Vector2f

type Output = Vector2f

The resulting type after applying the * operator.

fn mul(self, m: Matrix3x2f) -> Vector2f

Performs the * operation.

impl<V> Mul<V> for Vector2f where
    V: Into<Vector2f>, 

type Output = Vector2f

The resulting type after applying the * operator.

fn mul(self, rhs: V) -> Self

Performs the * operation.

impl Mul<Vector2f> for f32

type Output = Vector2f

The resulting type after applying the * operator.

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

Performs the * operation.

impl<V> Div<V> for Vector2f where
    V: Into<Vector2f>, 

type Output = Vector2f

The resulting type after applying the / operator.

fn div(self, rhs: V) -> Vector2f

Performs the / operation.

impl Div<Vector2f> for f32

type Output = Vector2f

The resulting type after applying the / operator.

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

Performs the / operation.

impl Neg for Vector2f

type Output = Vector2f

The resulting type after applying the - operator.

fn neg(self) -> Vector2f

Performs the unary - operation.

impl Serialize for Vector2f

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Vector2f

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

Deserialize this value from the given Serde deserializer.