Struct ultraviolet::vec::Vec2

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

A set of two coordinates which may be interpreted as a vector or point in 2d space.

Generally this distinction between a point and vector is more of a pain than it is worth to distinguish on a type level, however when converting to and from homogeneous coordinates it is quite important.

Fields

x: f32

y: f32

Methods

impl Vec2

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

pub fn broadcast(val: f32) -> Self

pub fn unit_x() -> Self

pub fn unit_y() -> Self

pub fn into_homogeneous_point(self) -> Vec3

Create a homogeneous 2d point from this vector interpreted as a point, meaning the homogeneous component will start with a value of 1.0.

pub fn into_homogeneous_vector(self) -> Vec3

Create a homogeneous 2d vector from this vector, meaning the homogeneous component will always have a value of 0.0.

pub fn from_homogeneous_point(v: Vec3) -> Self

Create a 2d point from a homogeneous 2d point, performing division by the homogeneous component. This should not be used for homogeneous 2d vectors, which will have 0 as their homogeneous component.

pub fn from_homogeneous_vector(v: Vec3) -> Self

Create a 2d vector from homogeneous 2d vector, which simply discards the homogeneous component.

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

pub fn wedge(&self, other: Vec2) -> Bivec2

The wedge (aka exterior) product of two vectors.

This operation results in a bivector, which represents the plane parallel to the two vectors, and which has a 'oriented area' equal to the parallelogram created by extending the two vectors, oriented such that the positive direction is the one which would move self closer to other.

pub fn geom(&self, other: Vec2) -> Rotor2

The geometric product of this and another vector, which is defined as the sum of the dot product and the wedge product.

This operation results in a 'rotor', named as such as it may define a rotation. The rotor which results from the geometric product will rotate in the plane parallel to the two vectors, by twice the angle between them and in the opposite direction (i.e. it will rotate in the direction that would bring other towards self, and rotate in that direction by twice the angle between them).

pub fn rotate_by(&mut self, rotor: Rotor2)

pub fn rotated_by(self, rotor: Rotor2) -> Self

pub fn reflected(&self, normal: Vec2) -> Self

pub fn mag_sq(&self) -> f32

pub fn mag(&self) -> f32

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

pub fn mul_add(&self, mul: Vec2, add: Vec2) -> Self

pub fn abs(&self) -> Self

pub fn clamp(&mut self, min: Self, max: Self)

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

pub fn map<F>(&self, f: F) -> Self where
    F: Fn(f32) -> f32, 

pub fn apply<F>(&mut self, f: F) where
    F: Fn(f32) -> f32, 

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

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

pub fn component_max(&self) -> f32

pub fn component_min(&self) -> f32

pub fn zero() -> Self

pub fn one() -> Self

pub fn xyz(&self) -> Vec3

pub fn xyzw(&self) -> Vec4

pub fn layout() -> Layout

pub fn as_slice(&self) -> &[f32]

pub fn as_byte_slice(&self) -> &[u8]

pub fn as_mut_slice(&mut self) -> &mut [f32]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8]

pub fn as_ptr(&self) -> *const f32

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

pub fn as_mut_ptr(&self) -> *mut f32

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

impl Vec2

pub fn refracted(&mut self, normal: Self, eta: f32) -> Self

Trait Implementations

impl Lerp<f32> for Vec2

fn lerp(&self, end: Self, t: f32) -> Self

impl From<[f32; 2]> for Vec2

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<(f32, f32)> for Vec2

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

Performs the conversion.

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

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

Performs the conversion.

impl<'_> From<&'_ mut (f32, f32)> for Vec2

fn from(comps: &mut (f32, f32)) -> Self

Performs the conversion.

impl From<Vec3> for Vec2

fn from(vec: Vec3) -> Self

Performs the conversion.

impl From<Vec2> for Vec3

fn from(vec: Vec2) -> Self

Performs the conversion.

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

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Div<Vec2> for Vec2

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Sub<Vec2> for Vec2

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Add<Vec2> for Vec2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Mul<Vec2> for Mat2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for Rotor2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for Vec2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for f32

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Vec2

Performs the unary - operation.

impl AddAssign<Vec2> for Vec2

fn add_assign(&mut self, rhs: Vec2)

Performs the += operation.

impl SubAssign<Vec2> for Vec2

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation.

impl MulAssign<Vec2> for Vec2

fn mul_assign(&mut self, rhs: Vec2)

Performs the *= operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl DivAssign<Vec2> for Vec2

fn div_assign(&mut self, rhs: Vec2)

Performs the /= operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.