Struct Vec3D

Source

pub struct Vec3D {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

Fields§

§x: f64§y: f64§z: f64

Implementations§

Source §

impl Vec3D

Source

pub fn new(x: f64, y: f64, z: f64) -> Vec3D

Examples found in repository ?

examples/example.rs (line 5)

3fn main() {
4    // Simple initialisation
5    let vec1 = Vec3D::new(1.0, 2.0, 3.0);
6    println!("{}", vec1);               // Prints: "[1.0, 2.0, 3.0]"
7
8    // Operator overloads for clean code
9    let vec2 = Vec3D::new(3.0, 4.0, 5.0);
10    let vec3 = vec1 + vec2;
11    println!("{}", vec3);               // Prints: "[4.0, 6.0, 8.0]"
12
13    let vec4 = vec3 * 2.0;
14    println!("{}", vec4);               // Prints: "[8.0, 12.0, 16.0]"
15
16    // Common vector operations
17    let dot_product = vec3.dot(vec4);
18    println!("{}", dot_product);        // Prints: "232"
19
20    let vec5 = Vec3D::new(1.0, 0.0, 0.0);
21    let vec6 = Vec3D::new(0.0, 1.0, 0.0);
22    let cross_product = vec5.cross(vec6);
23    println!("{}", cross_product);      // Prints: "[0.0, 0.0, 1.0]"
24
25    // Plus initialisations from spherical/cylindrical coordinates, rotations and more
26}

Source

pub fn new_from_spherical_coordinates( r: f64, theta: f64, phi: f64, ) -> Result<Vec3D, Vec3DError>

Creates a new 3D vector from spherical coordinates

r - radial distance
theta - polar angle
phi - azimuthal angle

§Errors

Will return a Vec3DError if:

r < 0
theta < 0
theta > PI

Source

pub fn new_from_cylindrical_coordinates( r: f64, phi: f64, z: f64, ) -> Result<Vec3D, Vec3DError>

Creates a new 3D vector from cylindrical coordinates

r - radial distance
phi - angle
z - height along z-axis

§Errors

Will return a Vec3DError if:

r < 0

Source

pub fn zeros() -> Vec3D

Returns a new vector with a value of 0.0 in each axis

Source

pub fn ones() -> Vec3D

Returns a new vector with a value of 1.0 in each axis

Source

pub fn x_proj(&self) -> Vec3D

Returns the projection of the vector in the x-axis

Source

pub fn y_proj(&self) -> Vec3D

Returns the projection of the vector in the y-axis

Source

pub fn z_proj(&self) -> Vec3D

Returns the projection of the vector in the z-axis

Source

pub fn theta(&self) -> f64

Returns the vector’s theta value in spherical coordinates

Source

pub fn phi(&self) -> f64

Returns the vector’s phi value in spherical/cylindrical coordinates

Source

pub fn mag(&self) -> f64

Returns the vector’s magnitude

Source

pub fn mag2(&self) -> f64

Returns the vector’s magnitude^2

Source

pub fn norm(&self) -> Vec3D

Returns a new vector of the current vector normalised

Source

pub fn unit(&self) -> Vec3D

Alias for Vec3D::norm

Source

pub fn inner_product(&self, other: Vec3D) -> f64

Returns the inner product of this vector with another vector

Source

pub fn dot(&self, other: Vec3D) -> f64

Alias for Vec3D::inner_product

Examples found in repository ?

examples/example.rs (line 17)

3fn main() {
4    // Simple initialisation
5    let vec1 = Vec3D::new(1.0, 2.0, 3.0);
6    println!("{}", vec1);               // Prints: "[1.0, 2.0, 3.0]"
7
8    // Operator overloads for clean code
9    let vec2 = Vec3D::new(3.0, 4.0, 5.0);
10    let vec3 = vec1 + vec2;
11    println!("{}", vec3);               // Prints: "[4.0, 6.0, 8.0]"
12
13    let vec4 = vec3 * 2.0;
14    println!("{}", vec4);               // Prints: "[8.0, 12.0, 16.0]"
15
16    // Common vector operations
17    let dot_product = vec3.dot(vec4);
18    println!("{}", dot_product);        // Prints: "232"
19
20    let vec5 = Vec3D::new(1.0, 0.0, 0.0);
21    let vec6 = Vec3D::new(0.0, 1.0, 0.0);
22    let cross_product = vec5.cross(vec6);
23    println!("{}", cross_product);      // Prints: "[0.0, 0.0, 1.0]"
24
25    // Plus initialisations from spherical/cylindrical coordinates, rotations and more
26}

Source

pub fn distance_to(&self, other: Vec3D) -> f64

Returns the distance between this vector and another vector

Source

pub fn distance_to2(&self, other: Vec3D) -> f64

Returns the distance^2 between this vector and another vector

Source

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

Returns the cross product of this vector with another vector

Examples found in repository ?

examples/example.rs (line 22)

3fn main() {
4    // Simple initialisation
5    let vec1 = Vec3D::new(1.0, 2.0, 3.0);
6    println!("{}", vec1);               // Prints: "[1.0, 2.0, 3.0]"
7
8    // Operator overloads for clean code
9    let vec2 = Vec3D::new(3.0, 4.0, 5.0);
10    let vec3 = vec1 + vec2;
11    println!("{}", vec3);               // Prints: "[4.0, 6.0, 8.0]"
12
13    let vec4 = vec3 * 2.0;
14    println!("{}", vec4);               // Prints: "[8.0, 12.0, 16.0]"
15
16    // Common vector operations
17    let dot_product = vec3.dot(vec4);
18    println!("{}", dot_product);        // Prints: "232"
19
20    let vec5 = Vec3D::new(1.0, 0.0, 0.0);
21    let vec6 = Vec3D::new(0.0, 1.0, 0.0);
22    let cross_product = vec5.cross(vec6);
23    println!("{}", cross_product);      // Prints: "[0.0, 0.0, 1.0]"
24
25    // Plus initialisations from spherical/cylindrical coordinates, rotations and more
26}