Struct emath::vec2::Vec2

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

A vector has a direction and length. A Vec2 is often used to represent a size.

emath represents positions using crate::Pos2.

Normally the units are points (logical pixels).

Fields

x: f32

Rightwards. Width.

y: f32

Downwards. Height.

Implementations

impl Vec2

pub const X: Self = _

Right

pub const Y: Self = _

Down

pub const RIGHT: Self = _

+X

pub const LEFT: Self = _

-X

pub const UP: Self = _

-Y

pub const DOWN: Self = _

+Y

pub const ZERO: Self = _

pub const INFINITY: Self = _

pub const NAN: Self = _

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

pub const fn splat(v: f32) -> Self

Set both x and y to the same value.

pub fn to_pos2(self) -> Pos2

Treat this vector as a position. v.to_pos2() is equivalent to Pos2::default() + v.

pub fn normalized(self) -> Self

Safe normalize: returns zero if input is zero.

pub fn is_normalized(self) -> bool

Checks if self has length 1.0 up to a precision of 1e-6.

pub fn rot90(self) -> Self

Rotates the vector by 90°, i.e positive X to positive Y (clockwise in egui coordinates).

pub fn length(self) -> f32

pub fn length_sq(self) -> f32

pub fn angle(self) -> f32

Measures the angle of the vector.

use std::f32::consts::TAU;

assert_eq!(Vec2::ZERO.angle(), 0.0);
assert_eq!(Vec2::angled(0.0).angle(), 0.0);
assert_eq!(Vec2::angled(1.0).angle(), 1.0);
assert_eq!(Vec2::X.angle(), 0.0);
assert_eq!(Vec2::Y.angle(), 0.25 * TAU);

assert_eq!(Vec2::RIGHT.angle(), 0.0);
assert_eq!(Vec2::DOWN.angle(), 0.25 * TAU);
assert_eq!(Vec2::UP.angle(), -0.25 * TAU);

pub fn angled(angle: f32) -> Self

Create a unit vector with the given CW angle (in radians).

• An angle of zero gives the unit X axis.
• An angle of 𝞃/4 = 90° gives the unit Y axis.

use std::f32::consts::TAU;

assert_eq!(Vec2::angled(0.0), Vec2::X);
assert!((Vec2::angled(0.25 * TAU) - Vec2::Y).length() < 1e-5);

pub fn floor(self) -> Self

pub fn round(self) -> Self

pub fn ceil(self) -> Self

pub fn abs(self) -> Self

pub fn is_finite(self) -> bool

True if all members are also finite.

pub fn any_nan(self) -> bool

True if any member is NaN.

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

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

pub fn dot(self, other: Self) -> f32

The dot-product of two vectors.

pub fn min_elem(self) -> f32

Returns the minimum of self.x and self.y.

pub fn max_elem(self) -> f32

Returns the maximum of self.x and self.y.

pub fn yx(self) -> Self

Swizzle the axes.

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

Trait Implementations

impl Add<Vec2> for Pos2

type Output = Pos2

The resulting type after applying the + operator.

fn add(self, rhs: Vec2) -> Self

Performs the + operation.

impl Add for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec2> for Pos2

fn add_assign(&mut self, rhs: Vec2)

Performs the += operation.

impl AddAssign for Vec2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

fn default() -> Vec2

Returns the “default value” for a type.

impl Display for Vec2

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

Formats the value using the given formatter.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

fn div(self, factor: f32) -> Self

Performs the / operation.

impl Div for Vec2

Element-wise division

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<&[f32; 2]> for Vec2

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

Converts to this type from the input type.

impl From<&(f32, f32)> for Vec2

fn from(v: &(f32, f32)) -> Self

Converts to this type from the input type.

impl From<&Vec2> for [f32; 2]

fn from(v: &Vec2) -> Self

Converts to this type from the input type.

impl From<&Vec2> for (f32, f32)

fn from(v: &Vec2) -> Self

Converts to this type from the input type.

impl From<[f32; 2]> for Vec2

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

Converts to this type from the input type.

impl From<(f32, f32)> for Vec2

fn from(v: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<Vec2> for [f32; 2]

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for (f32, f32)

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2b> for Vec2

fn from(v: Vec2b) -> Self

Converts to this type from the input type.

impl Index<usize> for Vec2

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &f32

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

fn index_mut(&mut self, index: usize) -> &mut f32

Performs the mutable indexing (container[index]) operation.

impl Mul<Vec2> for Rot2

Rotates (and maybe scales) the vector.

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, v: Vec2) -> Vec2

Performs the * operation.

impl Mul<Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, vec: Vec2) -> Vec2

Performs the * operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, factor: f32) -> Self

Performs the * operation.

impl Mul for Vec2

Element-wise multiplication

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, vec: Self) -> Self

Performs the * operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl NumExt for Vec2

fn at_least(self, lower_limit: Self) -> Self

More readable version of self.max(lower_limit)

fn at_most(self, upper_limit: Self) -> Self

More readable version of self.min(upper_limit)

impl PartialEq for Vec2

fn eq(&self, other: &Vec2) -> 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<Vec2> for Pos2

type Output = Pos2

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2) -> Self

Performs the - operation.

impl Sub for Vec2

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vec2> for Pos2

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation.

impl SubAssign for Vec2

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Zeroable for Vec2

fn zeroed() -> Self

Calls zeroed.

impl Copy for Vec2

impl Eq for Vec2

impl Pod for Vec2

impl StructuralPartialEq for Vec2