Struct Vector3

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

Fields

x: f32

y: f32

z: f32

Implementations

impl Vector3

pub fn new() -> Vector3

Creates a vector <0.0, 0.0, 0.0>

Examples

use vex::Vector3;
 
let actual = Vector3::new();
let expected = Vector3 { x: 0.0, y: 0.0, z: 0.0 };
assert_eq!(actual, expected);

pub fn one() -> Vector3

Creates a vector <1.0, 1.0, 1.0>

Examples

use vex::Vector3;
 
let actual = Vector3::one();
let expected = Vector3 { x: 1.0, y: 1.0, z: 1.0 };
assert_eq!(actual, expected);

pub fn right() -> Vector3

Creates a right vector

Examples

use vex::Vector3;
 
let actual = Vector3::right();
let expected = Vector3 { x: 1.0, y: 0.0, z: 0.0 };
assert_eq!(actual, expected);

pub fn up() -> Vector3

Creates an up vector

Examples

use vex::Vector3;
let actual = Vector3::up();
let expected = Vector3 { x: 0.0, y: 1.0, z: 0.0 };
assert_eq!(actual, expected);

pub fn forward() -> Vector3

Creates a forward vector

Examples

use vex::Vector3;
 
let actual = Vector3::forward();
let expected = Vector3 { x: 0.0, y: 0.0, z: -1.0 };
assert_eq!(actual, expected);

pub fn make(x: f32, y: f32, z: f32) -> Vector3

Creates a vector from the provided values

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0);
let expected = Vector3 { x: 1.0, y: 2.0, z: 3.0 };
assert_eq!(actual, expected);

pub fn dot(a: &Vector3, b: &Vector3) -> f32

Find the dot product between two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 0.0, 0.0);
let b = Vector3::make(0.0, 0.0, 1.0);
let actual = Vector3::dot(&a, &b);
let expected = 0.0;
assert_eq!(actual, expected);

pub fn cross(a: &Vector3, b: &Vector3) -> Vector3

Find the cross product between two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(0.0, 0.0, 1.0);
let b = Vector3::make(1.0, 0.0, 0.0);
let actual = Vector3::cross(&a, &b);
let expected = Vector3::make(0.0, 1.0, 0.0);
assert_eq!(actual, expected);

pub fn min(a: &Vector3, b: &Vector3) -> Vector3

Find the minimum (component-wise) vector between two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 4.0, 5.0);
let b = Vector3::make(2.0, 3.0, 6.0);
let actual = Vector3::min(&a, &b);
let expected = Vector3::make(1.0, 3.0, 5.0);
assert_eq!(actual, expected);

pub fn max(a: &Vector3, b: &Vector3) -> Vector3

Find the maximum (component-wise) vector between two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 4.0, 5.0);
let b = Vector3::make(2.0, 3.0, 6.0);
let actual = Vector3::max(&a, &b);
let expected = Vector3::make(2.0, 4.0, 6.0);
assert_eq!(actual, expected);

pub fn clamp(&mut self, a: &Vector3, b: &Vector3)

Find the clamped (component-wise) vector between two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 3.0, 5.0);
let b = Vector3::make(2.0, 4.0, 6.0);
let mut actual = Vector3::make(0.0, 5.0, 10.0);
actual.clamp(&a, &b);
let expected = Vector3::make(1.0, 4.0, 6.0);
assert_eq!(actual, expected);

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

Set the components of a vector

Examples

use vex::Vector3;
 
let mut actual = Vector3::new();
actual.set(1.0, 2.0, 3.0);
let expected = Vector3::make(1.0, 2.0, 3.0);
assert_eq!(actual, expected);

pub fn mag(&self) -> f32

Get the magnitude of the vector

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0).mag();
let expected = 3.74165738677;
assert_eq!(actual, expected);

pub fn mag_sq(&self) -> f32

Get the squared magnitude of the vector

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0).mag_sq();
let expected = 14.0;
assert_eq!(actual, expected);

pub fn norm(&mut self) -> f32

Normalize the vector

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual.norm();
let expected = Vector3::make(0.26726124191, 0.53452248382, 0.8017837);
assert_eq!(actual, expected);

pub fn abs(&mut self)

Set the components of a vector to their absolute values

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(-1.0, -2.0, -3.0);
actual.abs();
let expected = Vector3::make(1.0, 2.0, 3.0);
assert_eq!(actual, expected);

pub fn is_valid(&self) -> bool

Determine whether or not all components of the vector are valid

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0);
assert!(actual.is_valid());

Trait Implementations

impl Add<f32> for Vector3

fn add(self, _rhs: f32) -> Vector3

Find the resulting vector by adding a scalar to a vector’s components

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0) + 1.0;
let expected = Vector3::make(2.0, 3.0, 4.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the + operator.

impl Add for Vector3

fn add(self, _rhs: Vector3) -> Vector3

Add two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 2.0, 3.0);
let b = Vector3::make(4.0, 5.0, 6.0);
let actual = a + b;
let expected = Vector3::make(5.0, 7.0, 9.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the + operator.

impl AddAssign<f32> for Vector3

fn add_assign(&mut self, _rhs: f32)

Increment a vector by a scalar

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual += 10.0;
let expected = Vector3::make(11.0, 12.0, 13.0);
assert_eq!(actual, expected);

impl AddAssign for Vector3

fn add_assign(&mut self, _rhs: Vector3)

Increment a vector by another vector

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual += Vector3::make(1.0, 2.0, 3.0);
let expected = Vector3::make(2.0, 4.0, 6.0);
assert_eq!(actual, expected);

impl Clone for Vector3

fn clone(&self) -> Vector3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector3

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

Formats the value using the given formatter.

impl Display for Vector3

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

Formats the value using the given formatter.

impl Div<f32> for Vector3

fn div(self, _rhs: f32) -> Vector3

Find the resulting vector by dividing a scalar to a vector’s components

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0) / 2.0;
let expected = Vector3::make(0.5, 1.0, 1.5);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the / operator.

impl Div for Vector3

fn div(self, _rhs: Vector3) -> Vector3

Divide two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 2.0, 4.0);
let b = Vector3::make(2.0, 8.0, 32.0);
let actual = a / b;
let expected = Vector3::make(0.5, 0.25, 0.125);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the / operator.

impl DivAssign<f32> for Vector3

fn div_assign(&mut self, _rhs: f32)

Divide a vector by a scalar

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual /= 2.0;
let expected = Vector3::make(0.5, 1.0, 1.5);
assert_eq!(actual, expected);

impl DivAssign for Vector3

fn div_assign(&mut self, _rhs: Vector3)

Divide a vector by another vector

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 4.0);
actual /= Vector3::make(2.0, 8.0, 32.0);
let expected = Vector3::make(0.5, 0.25, 0.125);
assert_eq!(actual, expected);

impl From<Vector2> for Vector3

fn from(item: Vector2) -> Vector3

Creates a Vector3 from the components of a Vector2

Examples

use vex::Vector2;
use vex::Vector3;
 
let input = Vector2::make(1.0, 2.0);
let actual = Vector3::from(input);
let expected = Vector3 { x: 1.0, y: 2.0, z: 0.0 };
assert_eq!(actual, expected);

impl From<Vector3> for Vector2

fn from(item: Vector3) -> Self

Creates a Vector2 from the components of a Vector3

Examples

use vex::Vector2;
use vex::Vector3;
 
let input = Vector3::make(1.0, 2.0, 3.0);
let actual = Vector2::from(input);
let expected = Vector2 { x: 1.0, y: 2.0 };
assert_eq!(actual, expected);

impl From<Vector3> for Vector4

fn from(item: Vector3) -> Vector4

Creates a Vector4 from the components of a Vector3

Examples

use vex::Vector3;
use vex::Vector4;
 
let input = Vector3::make(1.0, 2.0, 3.0);
let actual = Vector4::from(input);
let expected = Vector4 { x: 1.0, y: 2.0, z: 3.0, w: 0.0 };
assert_eq!(actual, expected);

impl From<Vector4> for Vector3

fn from(item: Vector4) -> Vector3

Creates a Vector3 from the components of a Vector4

Examples

use vex::Vector3;
use vex::Vector4;
 
let input = Vector4::make(1.0, 2.0, 3.0, 4.0);
let actual = Vector3::from(input);
let expected = Vector3 { x: 1.0, y: 2.0, z: 3.0 };
assert_eq!(actual, expected);

impl Index<u32> for Vector3

fn index(&self, index: u32) -> &f32

Looks up a component by index

Examples

use vex::Vector3;
 
let mut v = Vector3::make(1.0, 2.0, 3.0);
assert_eq!(v[0], 1.0);
assert_eq!(v[1], 2.0);
assert_eq!(v[2], 3.0);

type Output = f32

The returned type after indexing.

impl IndexMut<u32> for Vector3

fn index_mut<'a>(&'a mut self, index: u32) -> &'a mut f32

Mutate a component by index

Examples

use vex::Vector3;
 
let mut v = Vector3::new();
v[0] = 4.0;
v[1] = 5.0;
v[2] = 6.0;
assert_eq!(v[0], 4.0);
assert_eq!(v[1], 5.0);
assert_eq!(v[2], 6.0);

impl Matrix<Vector3> for Matrix3

fn transform_point(&self, point: &Vector3) -> Vector3

Find the resulting vector given a vector and matrix

Examples

use vex::Matrix;
use vex::Matrix3;
use vex::Vector3;
 
let m = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let v = Vector3::make(1.0, 2.0, 3.0);
let actual = m.transform_point(&v);
let expected = Vector3::make(30.0, 36.0, 42.0);
assert_eq!(actual, expected);

impl Matrix<Vector3> for Matrix4

fn transform_point(&self, point: &Vector3) -> Vector3

Find the resulting vector given a vector and matrix

Examples

use vex::Matrix;
use vex::Matrix4;
use vex::Vector3;
 
let m = Matrix4::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0);
let v = Vector3::make(1.0, 2.0, 3.0);
let actual = m.transform_point(&v);
let expected = Vector3::make(51.0, 58.0, 65.0);
assert_eq!(actual, expected);

impl Mul<f32> for Vector3

fn mul(self, _rhs: f32) -> Vector3

Find the resulting vector by multiplying a scalar to a vector’s components

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0) * 2.0;
let expected = Vector3::make(2.0, 4.0, 6.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the * operator.

impl Mul for Vector3

fn mul(self, _rhs: Vector3) -> Vector3

Multiply two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 2.0, 3.0);
let b = Vector3::make(3.0, 4.0, 5.0);
let actual = a * b;
let expected = Vector3::make(3.0, 8.0, 15.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the * operator.

impl MulAssign<f32> for Vector3

fn mul_assign(&mut self, _rhs: f32)

Multiply a vector by a scalar

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual *= 2.0;
let expected = Vector3::make(2.0, 4.0, 6.0);
assert_eq!(actual, expected);

impl MulAssign for Vector3

fn mul_assign(&mut self, _rhs: Vector3)

Multiply a vector by another vector

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual *= Vector3::make(2.0, 3.0, 6.0);
let expected = Vector3::make(2.0, 6.0, 18.0);
assert_eq!(actual, expected);

impl Neg for Vector3

fn neg(self) -> Vector3

Negates all components in a vector

Examples

use vex::Vector3;
 
let actual = -Vector3::make(1.0, 2.0, 3.0);
let expected = Vector3::make(-1.0, -2.0, -3.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the - operator.

impl PartialEq for Vector3

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

Determines if two vectors’ components are equivalent

Examples

use vex::Vector3;
 
assert!(Vector3::new() == Vector3::new());

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<f32> for Vector3

fn sub(self, _rhs: f32) -> Vector3

Find the resulting vector by subtracting a scalar from a vector’s components

Examples

use vex::Vector3;
 
let actual = Vector3::make(1.0, 2.0, 3.0) - 10.0;
let expected = Vector3::make(-9.0, -8.0, -7.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the - operator.

impl Sub for Vector3

fn sub(self, _rhs: Vector3) -> Vector3

Subtract two vectors

Examples

use vex::Vector3;
 
let a = Vector3::make(1.0, 2.0, 3.0);
let b = Vector3::make(5.0, 4.0, 3.0);
let actual = a - b;
let expected = Vector3::make(-4.0, -2.0, 0.0);
assert_eq!(actual, expected);

type Output = Vector3

The resulting type after applying the - operator.

impl SubAssign<f32> for Vector3

fn sub_assign(&mut self, _rhs: f32)

Decrement a vector by a scalar

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual -= 1.0;
let expected = Vector3::make(0.0, 1.0, 2.0);
assert_eq!(actual, expected);

impl SubAssign for Vector3

fn sub_assign(&mut self, _rhs: Vector3)

Decrement a vector by another vector

Examples

use vex::Vector3;
 
let mut actual = Vector3::make(1.0, 2.0, 3.0);
actual -= Vector3::make(1.0, 2.0, 3.0);
assert_eq!(actual, Vector3::new());

impl Copy for Vector3