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

Implementations

impl Vec2

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

pub const 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.

Note: Sometimes called “cross” product in 2D. Such a product is not well defined in 2 dimensions and is really just shorthand notation for a hacky operation that extends the vectors into 3 dimensions, takes the cross product, then returns only the resulting Z component as a pseudoscalar value. This value is will have the same value as the resulting bivector of the wedge product in 2d (a 2d bivector is also a kind of pseudoscalar value), so you may use this product to calculate the same value.

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: FnMut(f32) -> f32, 

pub fn apply<F>(&mut self, f: F) where
    F: FnMut(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_array(&self) -> &[f32; 2]

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 const 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(&mut 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 refract(&mut self, normal: Self, eta: f32)

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

Trait Implementations

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

fn add_assign(&mut self, rhs: Vec2)

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<'de> Deserialize<'de> for Vec2

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

Deserialize this value from the given Serde deserializer.

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 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.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<[f32; 2]> for Vec2

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

Performs the conversion.

impl From<(f32, f32)> for Vec2

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

Performs the conversion.

impl From<IVec2> for Vec2

fn from(v: IVec2) -> Self

Performs the conversion.

impl From<Point2<f32>> for Vec2

fn from(v: Point2<f32>) -> Self

Performs the conversion.

impl From<UVec2> for Vec2

fn from(v: UVec2) -> Self

Performs the conversion.

impl From<Vec2> for [f32; 2]

fn from(v: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for (f32, f32)

fn from(v: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Vec2x4

fn from(vec: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Vec2x8

fn from(vec: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Vec3

fn from(vec: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Vector2<f32>

fn from(v: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Point2<f32>

fn from(v: Vec2) -> Self

Performs the conversion.

impl From<Vec3> for Vec2

fn from(vec: Vec3) -> Self

Performs the conversion.

impl From<Vector2<f32>> for Vec2

fn from(v: Vector2<f32>) -> Self

Performs the conversion.

impl Index<usize> for Vec2

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

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

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

impl Lerp<f32> for Vec2

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

Linearly interpolate between self and end by t between 0.0 and 1.0. i.e. (1.0 - t) * self + (t) * end.

For interpolating Rotors with linear interpolation, you almost certainly want to normalize the returned Rotor. For example,

let interpolated_rotor = rotor1.lerp(rotor2, 0.5).normalized();

For most cases (especially where performance is the primary concern, like in animation interpolation for games, this ‘normalized lerp’ or ‘nlerp’ is probably what you want to use. However, there are situations in which you really want the interpolation between two Rotors to be of constant angular velocity. In this case, check out Slerp.

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 Isometry2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2> for Similarity2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, vec: 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 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 Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Vec2

Performs the unary - operation.

impl PartialEq<Vec2> for Vec2

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

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

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

This method tests for !=.

impl Serialize for Vec2

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

Serialize this value into the given Serde serializer.

impl Slerp<f32> for Vec2

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

Spherical-linear interpolation between self and end based on t from 0.0 to 1.0.

self and end should both be normalized or something bad will happen!

The implementation for SIMD types also requires that the two things being interpolated between are not exactly aligned, or else the result is undefined.

Basically, interpolation that maintains a constant angular velocity from one orientation on a unit hypersphere to another. This is sorta the “high quality” interpolation for Rotors, and it can also be used to interpolate other things, one example being interpolation of 3d normal vectors.

Note that you should often normalize the result returned by this operation, when working with Rotors, etc!

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

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation.

impl Sum<Vec2> for Vec2

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Vec2> for IVec2

fn try_from(v: Vec2) -> Result<Self, Self::Error>

Tries to convert the source to Self in a lossy way, flooring any float value.

Errors

• NaN - If a float value is NaN.
• NotFinite - If a float value is infinity or negative infinity.
• PosOverflow - If a float value would be greater than the the self.component max value.
• NegOverflow - If a float value would be less than the self.component min value.

type Error = FloatConversionError

The type returned in the event of a conversion error.

impl TryFrom<Vec2> for UVec2

fn try_from(v: Vec2) -> Result<Self, Self::Error>

Tries to convert the source to Self in a lossy way, flooring any float value.

Errors

• NaN - If a float value is NaN.
• NotFinite - If a float value is infinity or negative infinity.
• PosOverflow - If a float value would be greater than the the self.component max value.
• NegOverflow - If a float value would be less than the self.component min value.

type Error = FloatConversionError

The type returned in the event of a conversion error.

impl Zeroable for Vec2

fn zeroed() -> Self

Calls zeroed.

impl Copy for Vec2

impl Pod for Vec2

impl StructuralPartialEq for Vec2