Struct Vec3

pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

3D f32 Vector

Fields

x: f32

y: f32

z: f32

Implementations

impl Vec3

pub const DOWN: Vec3

Short for Vec2::new(0.0, -1.0, 0.0)

pub const UP: Vec3

Short for Vec2::new(0.0, 1.0, 0.0)

pub const RIGHT: Vec3

Short for Vec2::new(1.0, 0.0, 0.0)

pub const LEFT: Vec3

Short for Vec2::new(-1.0, 0.0, 0.0)

pub const FORWARD: Vec3

Short for Vec2::new(0.0, 0.0, 1.0)

pub const BACK: Vec3

Short for Vec2::new(0.0, 0.0, -1.0)

pub const ONE: Vec3

Short for Vec2::new(1.0, 1.0, 1.0)

pub const ZERO: Vec3

Short for Vec2::new(0.0, 0.0, 0.0)

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

pub fn set(&mut self, x: f32, y: f32, z: f32)

Sets the values of this vector.

Examples

use gamevecs::Vec3;
let mut vec = Vec3::new(3.0, 4.0, 6.0);
//set the values
vec.set(4.0, 5.0, 5.0);

assert_eq!(Vec3::new(4.0, 5.0, 5.0), vec);

pub fn magnitude(&self) -> f32

Returns the length (distance to (0|0|0)) of this vector.

Examples

use gamevecs::Vec3;
let vec = Vec3::new(3.0, 4.0, 12.0);
//get the magnitude
let magnitude = vec.magnitude();

assert_eq!(13.0, magnitude);

pub fn magnitude_squared(&self) -> f32

Returns the squared length of this vector.

Examples

use gamevecs::Vec3;
let vec = Vec3::new(3.0, 4.0, 12.0);
//get the magnitude
let magnitude = vec.magnitude_squared();

assert_eq!(169.0, magnitude);

pub fn equals(&self, other: Vec3, epsilon: f32) -> bool

Returns true if this vector approximately equals another one.

Examples

use gamevecs::Vec3;
let vec = Vec3::new(3.000001, 4.000001, 5.000001);
let other_vec = Vec3::new(3.0, 4.0, 5.0);

let equals = vec.equals(other_vec, 1e-5);

assert_eq!(true, equals);

pub fn normalized(&self) -> Vec3

Returns this vector with a magnitude of 1. Used when only the direction of the Vector is important.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(0.0, 0.0, 5.0);

//normalize
let normalized = vec1.normalized();

assert_eq!(Vec3::new(0.0, 0.0, 1.0), normalized);

pub fn distance_to(&self, other: Vec3) -> f32

Returns the distance from this vector to another.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(10.0, 20.0, 0.0);
let vec2 = Vec3::new(5.0, 10.0, 10.0);
//get the distance
let distance = vec1.distance_to(vec2);

assert_eq!(15.0, distance);

pub fn distance_to_squared(&self, other: Vec3) -> f32

Returns the squared distance from this vector to another.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(10.0, 20.0, 0.0);
let vec2 = Vec3::new(5.0, 10.0, 10.0);
//get the distance
let distance: f32 = vec1.distance_to_squared(vec2);

assert_eq!(225.0, distance);

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

Returns the dot product of this vector and another one.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(1.0, 2.0, 3.0);
let vec2 = Vec3::new(4.0, 5.0, 6.0);
//get the dot product
let dot_product = vec1.dot(vec2);

assert_eq!(32.0, dot_product);

pub fn cross(&self, other: Vec3) -> Vec3

Returns the cross product of this vector and another one.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(2.0, 3.0, 4.0);
let vec2 = Vec3::new(5.0, 6.0, 7.0);
//get the cross product
let cross_product = vec1.cross(vec2);

assert_eq!(Vec3::new(-3.0, 6.0, -3.0), cross_product);

pub fn angle_between(&self, other: Vec3) -> f32

Returns the angle between this vector and another one.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(1.0, 1.0, 1.0);
let vec2 = Vec3::new(-1.0, -1.0, -1.0);
//get the dot product
let angle = vec1.angle_between(vec2);

assert_eq!(180.0, angle.to_degrees());

pub fn lerp(&self, other: Vec3, t: f32) -> Vec3

Returns the linear interpolation by t between this and another vector. T should be between 0 and 1.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(1.0, 2.0, 4.0);
let other = Vec3::new(3.0, 6.0, 8.0);
//lerp
let new_vec = vec1.lerp(other, 0.5);

assert_eq!(Vec3::new(2.0, 4.0, 6.0), new_vec);

pub fn project(&self, onto: Vec3) -> Vec3

Projects a vector onto another one and returns the result as a new Vec3.

Examples

use gamevecs::Vec3;
let vec1 = Vec3::new(3.0, 4.0, 5.0);
let vec2 = Vec3::new(1.0, 0.0, 0.0);

//project
let projection = vec1.project(vec2);

assert_eq!(Vec3::new(3.0, 0.0, 0.0), projection);

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Vec3)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Display for Vec3

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

Formats the value using the given formatter.

impl Div for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Vec3

fn div_assign(&mut self, rhs: Vec3)

Performs the /= operation.

impl Mul for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Vec3

fn mul_assign(&mut self, rhs: Vec3)

Performs the *= operation.

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vec3

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

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, rhs: Vec3)

Performs the -= operation.

impl Copy for Vec3

impl StructuralPartialEq for Vec3