Struct Vec2 

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

A two dimensional mathematical vector

Examples

use miscmath::prelude::*;

let a = Vec2::default();

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

Fields

x: f32

y: f32

Implementations

impl Vec2

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

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

Examples

use miscmath::prelude::*;

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

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

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

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

Examples

pub fn create_random2(range_x: &Range<f32>, range_y: &Range<f32>) -> Vec2

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

Examples

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

Generates a new instance of Vec2 based on a entered angle with a magnitude of 1

Examples

pub fn from_rand_angle(range_x: &Range<f32>, mag: &Option<f32>) -> Vec2

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

Examples

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

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

Examples

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

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

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

pub fn unit() -> Vec2

Generates a new instance of Vec2 initialized as a unit vector of angle 0 and returns it

Examples

use miscmath::prelude::*;

let mut b = Vec2::unit();

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

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

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

Examples

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

Calculates the angle between self and a passed in Vec2

Examples

use miscmath::prelude::*;

let mut a = Vec2::new( &5.6, &7.2 );
let mut b = Vec2::unit();

let angle = a.angle_between( &mut b );

assert!( ( angle - 1.4731481877 ) < 0.00001 );

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

Examples

pub fn cross(&mut self)

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

Examples

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

Calculates the distance between self and the Vec2 passed in

Examples

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

Calculates the distance squared between self and the Vec2 passed in

Examples

pub fn dbg(&self)

Prints debug information of self to terminal

Examples

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

Calculates the dot product between self and a passed in Vec2

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: &Vec2)

Divides the components of self by a Vec2 rhs

Examples

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

Linearly interpolates between self and a passed in Vec2

Examples

use miscmath::prelude::*;

let mut a = Vec2::new( &5.6, &7.2 );
let mut b = Vec2::unit();

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

assert!( ( ( a.x - 3.3 ) < 0.00001 ) && ( ( a.y - 3.6 ) < 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: &Vec2)

Multiplies the components of self by a Vec2 rhs

Examples

pub fn norm(&mut self)

Normalizes the magnitude of self to 1, angle is unchanged

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)

Rotates self by the angle entered

Examples

pub fn set(&mut self, input1: &f32, input2: &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 sub(&mut self, rhs: &Vec2)

Subtracts the components of the rhs Vec2 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 Vec2

Implements Add for Vec2

Examples

use miscmath::prelude::*;
 
let mut x = Vec2::default();
let y = Vec2::new( &5.0, &7.0);
x += y;

assert_eq!(x, y);

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec2

Implements AddAssign for Vec2

Examples

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

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

Examples

use miscmath::prelude::*;

let a = Vec2::default();

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

fn default() -> Self

Returns the “default value” for a type.

impl Div for Vec2

Implements Div for Vec2

Examples

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Vec2

Implements DivAssign for Vec2

Examples

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Mul for Vec2

Implements Mul for Vec2

Examples

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Vec2

Implements MulAssign for Vec2

Examples

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq for Vec2

Implements PartialEq for Vec2

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 Vec2

Implements Rem for Vec2

Examples

type Output = Vec2

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for Vec2

Implements RemAssign for Vec2

Examples

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub for Vec2

Implements Sub for Vec2

Examples

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec2

Implements SubAssign for Vec2

Examples

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Vec2