Struct graphene::Point3D

pub struct Point3D(_);

A point with three components: X, Y, and Z.

Implementations

impl Point3D

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

Computes the cross product of the two given Point3D.

b

a Point3D

Returns

res

return location for the cross product

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

Computes the distance between the two given Point3D.

b

a Point3D

Returns

the distance between two points

delta

return location for the distance components on the X, Y, and Z axis

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

Computes the dot product of the two given Point3D.

b

a Point3D

Returns

the value of the dot product

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

Initializes a Point3D with the given coordinates.

x

the X coordinate of the point

y

the Y coordinate of the point

z

the Z coordinate of the point

Returns

the initialized Point3D

pub fn init_from_point(&mut self, src: &Point3D)

Initializes a Point3D using the coordinates of another Point3D.

src

a Point3D

Returns

the initialized point

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

Initializes a Point3D using the components of a Vec3.

v

a Vec3

Returns

the initialized Point3D

pub fn interpolate(&self, b: &Point3D, factor: f64) -> Point3D

Linearly interpolates each component of self and b using the provided factor, and places the result in res.

b

a Point3D

factor

the interpolation factor

Returns

res

the return location for the interpolated Point3D

pub fn length(&self) -> f32

Computes the length of the vector represented by the coordinates of the given Point3D.

Returns

the length of the vector represented by the point

pub fn near(&self, b: &Point3D, epsilon: f32) -> bool

Checks whether the two points are near each other, within an epsilon factor.

b

a Point3D

epsilon

fuzzyness factor

Returns

true if the points are near each other

pub fn normalize(&self) -> Point3D

Computes the normalization of the vector represented by the coordinates of the given Point3D.

Returns

res

return location for the normalized Point3D

pub fn normalize_viewport(
    &self,
    viewport: &Rect,
    z_near: f32,
    z_far: f32
) -> Point3D

Normalizes the coordinates of a Point3D using the given viewport and clipping planes.

The coordinates of the resulting Point3D will be in the [ -1, 1 ] range.

viewport

a Rect representing a viewport

z_near

the coordinate of the near clipping plane, or 0 for the default near clipping plane

z_far

the coordinate of the far clipping plane, or 1 for the default far clipping plane

Returns

res

the return location for the normalized Point3D

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

Scales the coordinates of the given Point3D by the given factor.

factor

the scaling factor

Returns

res

return location for the scaled point

pub fn to_vec3(&self) -> Vec3

Stores the coordinates of a Point3D into a Vec3.

Returns

v

return location for a Vec3

pub fn zero() -> Point3D

Retrieves a constant point with all three coordinates set to 0.

Returns

a zero point

impl Point3D

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

pub fn from_point(src: &Point3D) -> Point3D

pub fn from_vec3(v: &Vec3) -> Point3D

Trait Implementations

impl Clone for Point3D

fn clone(&self) -> Point3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Point3D

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

Formats the value using the given formatter.

impl Hash for Point3D

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 Point3D

fn cmp(&self, other: &Point3D) -> 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<Point3D> for Point3D

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<Point3D> for Point3D

fn partial_cmp(&self, other: &Point3D) -> 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 Point3D

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Point3D