Struct duku::Vector3

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

3-component Vector.

Used for 3D sizing and positioning.

Example

let point_1 = Vector3::new(-10.0, -10.0, -10.0);
let point_2 = Vector3::new(10.0, 10.0, 10.0);

target.draw_line_debug(point_1, point_2);

Fields

x: f32

the X component

y: f32

the Y component

z: f32

the Z component

Implementations

impl Vector3

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

Create a new vector

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

Create a new vector with all components with the same value

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

Calculate the dot-product of the vector

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

Calculate the cross-product of the vector

pub fn sqr_length(&self) -> f32

Calculate the squared length of a vector

Can sometimes use this 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 angle_between(&self, other: impl Into<Self>) -> f32

Calculate the angle between 2 vectors

Note: resulting angle is in degrees

Example

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

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

Calculate the projected vector onto some other vector

pub const fn xy(&self) -> Vector2

Get the Vector2 made from this vectors x and y

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

pub const BACK: Self

Shorthand for Vector3::new(0.0, 0.0, -1.0)

pub const FORWARD: Self

Shorthand for Vector3::new(0.0, 0.0, 1.0)

pub const UP: Self

Shorthand for Vector3::new(0.0, 1.0, 0.0)

pub const DOWN: Self

Shorthand for Vector3::new(0.0, -1.0, 0.0)

pub const LEFT: Self

Shorthand for Vector3::new(-1.0, 0.0, 0.0)

pub const RIGHT: Self

Shorthand for Vector3::new(1.0, 0.0, 0.0)

Trait Implementations

impl Add<Vector3> for Vector3

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vector3> for Vector3

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

Performs the += operation.

impl Clone for Vector3

pub fn clone(&self) -> Vector3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vector3

impl Debug for Vector3

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

Formats the value using the given formatter.

impl Default for Vector3

pub fn default() -> Vector3

Returns the "default value" for a type.

impl Div<f32> for Vector3

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vector3

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

Performs the /= operation.

impl From<[f32; 3]> for Vector3

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

Performs the conversion.

impl From<(Vector2, f32)> for Vector3

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

Performs the conversion.

impl From<Color> for Vector3

pub fn from(c: Color) -> Self

Performs the conversion.

impl Index<usize> for Vector3

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 Vector3

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

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

impl Mul<Vector3> for Matrix4

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector3> for Quaternion

type Output = Vector3

The resulting type after applying the * operator.

pub fn mul(self, rhs: Vector3) -> Vector3

Performs the * operation.

impl Mul<f32> for Vector3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vector3

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

Performs the *= operation.

impl Neg for Vector3

type Output = Self

The resulting type after applying the - operator.

pub fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Vector3> for Vector3

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

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

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

This method tests for !=.

impl StructuralPartialEq for Vector3

impl Sub<Vector3> for Vector3

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vector3> for Vector3

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

Performs the -= operation.

impl<'vec> Sum<&'vec Vector3> for Vector3

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

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