Struct graphene::Vec3

pub struct Vec3(_);

A structure capable of holding a vector with three dimensions: x, y, and z.

The contents of the Vec3 structure are private and should never be accessed directly.

Implementations

impl Vec3

pub fn add(&self, b: &Vec3) -> Vec3

Adds each component of the two given vectors.

b

a Vec3

Returns

res

return location for the resulting vector

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

Computes the cross product of the two given vectors.

b

a Vec3

Returns

res

return location for the resulting vector

pub fn divide(&self, b: &Vec3) -> Vec3

Divides each component of the first operand self by the corresponding component of the second operand b, and places the results into the vector res.

b

a Vec3

Returns

res

return location for the resulting vector

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

Computes the dot product of the two given vectors.

b

a Vec3

Returns

the value of the dot product

pub fn x(&self) -> f32

Retrieves the first component of the given vector self.

Returns

the value of the first component of the vector

pub fn xy(&self) -> Vec2

Creates a Vec2 that contains the first and second components of the given Vec3.

Returns

res

return location for a Vec2

pub fn xy0(&self) -> Vec3

Creates a Vec3 that contains the first two components of the given Vec3, and the third component set to 0.

Returns

res

return location for a Vec3

pub fn xyz0(&self) -> Vec4

Converts a Vec3 in a Vec4 using 0.0 as the value for the fourth component of the resulting vector.

Returns

res

return location for the vector

pub fn xyz1(&self) -> Vec4

Converts a Vec3 in a Vec4 using 1.0 as the value for the fourth component of the resulting vector.

Returns

res

return location for the vector

pub fn xyzw(&self, w: f32) -> Vec4

Converts a Vec3 in a Vec4 using w as the value of the fourth component of the resulting vector.

w

the value of the W component

Returns

res

return location for the vector

pub fn y(&self) -> f32

Retrieves the second component of the given vector self.

Returns

the value of the second component of the vector

pub fn z(&self) -> f32

Retrieves the third component of the given vector self.

Returns

the value of the third component of the vector

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

Initializes a Vec3 using the given values.

This function can be called multiple times.

x

the X field of the vector

y

the Y field of the vector

z

the Z field of the vector

Returns

a pointer to the initialized vector

pub fn init_from_vec3(&mut self, src: &Vec3)

Initializes a Vec3 with the values of another Vec3.

src

a Vec3

Returns

the initialized vector

pub fn interpolate(&self, v2: &Vec3, factor: f64) -> Vec3

Linearly interpolates self and v2 using the given factor.

v2

a Vec3

factor

the interpolation factor

Returns

res

the interpolated vector

pub fn length(&self) -> f32

Retrieves the length of the given vector self.

Returns

the value of the length of the vector

pub fn max(&self, b: &Vec3) -> Vec3

Compares each component of the two given vectors and creates a vector that contains the maximum values.

b

a Vec3

Returns

res

return location for the result vector

pub fn min(&self, b: &Vec3) -> Vec3

Compares each component of the two given vectors and creates a vector that contains the minimum values.

b

a Vec3

Returns

res

return location for the result vector

pub fn multiply(&self, b: &Vec3) -> Vec3

Multiplies each component of the two given vectors.

b

a Vec3

Returns

res

return location for the resulting vector

pub fn near(&self, v2: &Vec3, epsilon: f32) -> bool

Compares the two given Vec3 vectors and checks whether their values are within the given epsilon.

v2

a Vec3

epsilon

the threshold between the two vectors

Returns

true if the two vectors are near each other

pub fn negate(&self) -> Vec3

Negates the given Vec3.

Returns

res

return location for the result vector

pub fn normalize(&self) -> Vec3

Normalizes the given Vec3.

Returns

res

return location for the normalized vector

pub fn scale(&self, factor: f32) -> Vec3

Multiplies all components of the given vector with the given scalar factor.

factor

the scalar factor

Returns

res

return location for the result vector

pub fn subtract(&self, b: &Vec3) -> Vec3

Subtracts from each component of the first operand self the corresponding component of the second operand b and places each result into the components of res.

b

a Vec3

Returns

res

return location for the resulting vector

pub fn one() -> Vec3

Provides a constant pointer to a vector with three components, all sets to 1.

Returns

a constant vector

pub fn x_axis() -> Vec3

Provides a constant pointer to a vector with three components with values set to (1, 0, 0).

Returns

a constant vector

pub fn y_axis() -> Vec3

Provides a constant pointer to a vector with three components with values set to (0, 1, 0).

Returns

a constant vector

pub fn z_axis() -> Vec3

Provides a constant pointer to a vector with three components with values set to (0, 0, 1).

Returns

a constant vector

pub fn zero() -> Vec3

Provides a constant pointer to a vector with three components, all sets to 0.

Returns

a constant vector

impl Vec3

pub fn init_from_float(&mut self, src: &[f32; 3])

Initializes a Vec3 with the values from an array.

src

an array of 3 floating point values

Returns

the initialized vector

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

pub fn from_vec3(src: &Vec3) -> Vec3

pub fn from_float(src: &[f32; 3]) -> Vec3

pub fn to_float(&self) -> [f32; 3]

Copies the components of a Vec3 into the given array.

Returns

dest

return location for an array of floating point values

Trait Implementations

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 Hash for Vec3

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Vec3

fn cmp(&self, other: &Vec3) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Vec3> for Vec3

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Vec3> for Vec3

fn partial_cmp(&self, other: &Vec3) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Vec3

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Vec3