Struct duku::Vec2

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

2-component Vector.

Used for 2D sizing and positioning.

Examples

let point1 = Vec2::new(-10.0, -10.0);
let point2 = Vec2::new(10.0, 10.0);

// when drawing
t.line(point1, point2);

Fields

x: f32

the X component

y: f32

the Y component

Implementations

impl Vec2

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

Create a vector

pub const fn up() -> Self

Create a vector facing up

pub const fn down() -> Self

Create a vector facing down

pub const fn left() -> Self

Create a vector facing left

pub const fn right() -> Self

Create a vector facing right

pub fn dot(&self, other: impl Into<Self>) -> f32

Calculate the dot-product of the vector

pub fn sqr_length(&self) -> f32

Calculate the squared length of a vector

Can sometimes be used instead of length, because this is faster.

pub fn length(&self) -> f32

Calculate the length of a vector

pub fn unit(&self) -> Self

Calculate the unit vector

The unit vector is of length 1 and can also be thought of as the direction of the vector.

pub fn normal(&self) -> Self

Calculate the normal vector

The normal vector is a vector perpendicular to the original.

May not be unit length

pub fn angle_between(&self, other: impl Into<Self>) -> f32

Calculate the angle between 2 vectors

Resulting angle is in degrees

Examples

let up = Vec2::up();
let right = Vec2::right();
let angle = up.angle_between(right);
// angle is ~90 degrees

pub fn floor(&self) -> Self

Floor every component of the vector

pub fn ceil(&self) -> Self

Ceil every component of the vector

pub fn round(&self) -> Self

Round every component of the vector

Trait Implementations

impl Add<Vec2> for Vec2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec2> for Vec2

pub fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec2

pub fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec2

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

pub fn default() -> Vec2

Returns the "default value" for a type.

impl Div<f32> for Vec2

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec2

pub fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<[f32; 2]> for Vec2

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

Performs the conversion.

impl Index<usize> for Vec2

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec2

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

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

impl Mul<f32> for Vec2

type Output = Self

The resulting type after applying the * operator.

pub fn mul(self, rhs: f32) -> Self

Performs the * operation.

impl MulAssign<f32> for Vec2

pub fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Vec2

type Output = Self

The resulting type after applying the - operator.

pub fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Vec2> for Vec2

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

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

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

This method tests for !=.

impl StructuralPartialEq for Vec2

impl Sub<Vec2> for Vec2

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vec2> for Vec2

pub fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.