Struct Vec3 

pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
    /* private fields */
}

A three dimensional mathematical vector

Examples

use miscmath::prelude::*;

let a = Vec3::default();

assert!( ( a.x < 0.00001 ) && ( a.y < 0.00001 ) && ( a.z < 0.00001 ) );

Fields

x: f32

y: f32

z: f32

Implementations

impl Vec3

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

Generates a new instance of Vec3 initialized to chosen values and returns it

Examples

use miscmath::prelude::*;

let a = Vec3::new( &5.6, &7.2, &6.8 );

assert!( ( ( a.x - 5.6 ) < 0.000001 ) && ( ( a.y - 7.2 ) < 0.000001 ) && ( ( a.z - 6.8 ) < 0.00001 ) );

pub fn create_random(range_x: &Range<f32>) -> Vec3

Generates a new instance of Vec3 initialized to random values in the range entered and returns it

Examples

pub fn create_random3( range_x: &Range<f32>, range_y: &Range<f32>, range_z: &Range<f32>, ) -> Vec3

Generates a new instance of Vec3 initialized to random values in the range entered and returns it

Examples

pub fn from_angle(theta: &f32, phi: &f32, in_mag: &Option<f32>) -> Vec3

Generates a new instance of Vec3 based on a entered angles with a magnitude of 1

Examples

pub fn from_rand_angle(range: &Range<f32>, mag: &Option<f32>) -> Vec3

Generates a new instance of Vec3 initialized to random values in the range entered and returns it

Examples

pub fn random_unit(range: &Range<f32>) -> Vec3

Generates a new instance of Vec3 initialized to a magnitude of 1 and angles of random value in the range entered and returns it

Examples

use std::f32::consts::TAU;
use miscmath::prelude::*;

let mut a = Vec3::random_unit( &( 0.0..TAU ) );

assert!( ( a.x - 1.0 < 0.00001 ) && ( a.y < TAU ) && ( a.z < TAU ) );

pub fn unit() -> Vec3

Generates a new instance of Vec3 initialized as a unit vector with angles of 0 and returns it

Examples

use miscmath::prelude::*;

let mut b = Vec3::unit();

assert!( ( b.x < 0.00001 ) && ( b.y < 0.00001 ) && ( b.z - 1.0 < 0.0001 ) );

pub fn add(&mut self, rhs: &Vec3)

Adds the components from the rhs Vec3 to the corresponding components of self

Examples

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

Calculates the angle between self and a passed in Vec3

Examples

pub fn constrain( &mut self, x_rng: &Range<f32>, y_rng: &Range<f32>, z_rng: &Range<f32>, )

Examples

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

Generates a new instance of Vec3 which is perpendicular to the self instance

Examples

pub fn dist(&self, rhs: &Vec3) -> f32

Calculates the distance between self and the Vec3 passed in

Examples

pub fn dist_sq(&self, rhs: &Vec3) -> f32

Calculates the distance squared between self and the Vec3 passed in

Examples

pub fn dbg(&self)

Prints debug information of self to terminal

Examples

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

Calculates the dot product between self and a passed in Vec3

Examples

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

Divides the components of self by a scalar value rhs

Examples

pub fn div2(&mut self, rhs: &Vec3)

Divides the components of self by a Vec3 rhs

Examples

pub fn lerp(&mut self, rhs: &Vec3, amt: UnitF)

Linearly interpolates between self and a passed in Vec3

Examples

use miscmath::prelude::*;

let mut a = Vec3::new( &5.6, &7.2, &6.8 );
let mut b = Vec3::default();

a.lerp( &b, UnitF::new( 0.5 ) );

assert!( ( ( a.x - 2.8 ) < 0.00001 ) && ( ( a.y - 3.6 ) < 0.00001 ) && ( a.z - 3.4 ) < 0.00001 );

pub fn mag(&self) -> f32

Calculates the magnitude of self

Examples

pub fn mag_sq(&self) -> f32

Calculates the magnitude squared of self

Examples

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

Multiplies the components of self by a scalar value rhs

Examples

pub fn mult2(&mut self, rhs: &Vec3)

Multiplies the components of self by a Vec3 rhs

Examples

pub fn norm(&mut self)

Normalizes the magnitude of self to 1, angle is unchanged

Examples

pub fn phi(&self) -> f32

Calculates the theta of self

Examples

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

Sets the components of self to the remainder of scalar division by rhs

Examples

pub fn rotate(&mut self, theta: &f32, phi: &f32)

Rotates self by the angle entered

Examples

pub fn set( &mut self, input1: &f32, input2: &f32, input3: &f32, coord_system: &CoordSystem, )

Sets components of vector to values entered

Examples

pub fn set_mag(&mut self, input: &f32)

Sets the magnitude of self

Examples

pub fn set_theta(&mut self, input: &f32)

Sets the theta of self

Examples

pub fn set_phi(&mut self, input: &f32)

Sets the phi of self

Examples

pub fn sub(&mut self, rhs: &Vec3)

Subtracts the components of the rhs Vec3 from the corresponding components of self

Examples

pub fn system(&self) -> CoordSystem

Returns the current coordinate system

Examples

pub fn theta(&self) -> f32

Calculates the theta of self

Examples

Trait Implementations

impl Add for Vec3

Implements Add for Vec3

Examples

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec3

Implements AddAssign for Vec3

Examples

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a duplicate 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 Default for Vec3

Implements Default for Vec3 Generates a new instance of Vec3 initialized to zero and returns it

Examples

use miscmath::prelude::*;

let a = Vec3::default();

assert!( ( a.x < 0.000001 ) && ( a.y < 0.000001 ) && ( a.z < 0.00001 ) );

fn default() -> Self

Returns the “default value” for a type.

impl Div for Vec3

Implements Div for Vec3

Examples

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Vec3

Implements DivAssign for Vec3

Examples

use miscmath::prelude::*;
 
let mut x = Vec3::new( &100.0, &50.0, &30.0 );
let y = Vec3::new( &2.0, &5.0 , &3.0 );
let z = Vec3::new( &50.0, &10.0, &10.0 );

x /= y;
 
assert_eq!( x, z );

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Mul for Vec3

Implements Mul for Vec3

Examples

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Vec3

Implements MulAssign for Vec3

Examples

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq for Vec3

Implements PartialEq for Vec3

Examples

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, rhs: &Self) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Rem for Vec3

Implements Rem for Vec3

Examples

type Output = Vec3

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for Vec3

Implements RemAssign for Vec3

Examples

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub for Vec3

Implements Sub for Vec3

Examples

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec3

Implements SubAssign for Vec3

Examples

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Vec3