Struct rustracer::normal::Normal

pub struct Normal {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

3D Normal struct.

Note: a 3D normal is a 3D vector with norm equal to 1, but it acts differently when 3D transformation is applied.
So is better to create 2 two different objects (structs) despite similarity and doubling the code.

Fields

x: f32

x component.

y: f32

y component.

z: f32

z component.

Implementations

impl Normal

pub fn neg(&self) -> Self

Return the reversed normal.

pub fn dot(self, other: Normal) -> f32

Compute the dot product between two normals.

pub fn squared_norm(self) -> f32

Return the squared norm (Euclidean length) of a normal.

This is faster than norm if you just need the squared norm.

pub fn norm(self) -> f32

Return the norm (Euclidean length) of a normal.

pub fn normalize(self) -> Self

Modify the normal’s norm so that it becomes equal to 1.

And return the normalized normal.

Trait Implementations

impl Clone for Normal

fn clone(&self) -> Normal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Normal

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

Formats the value using the given formatter.

impl Display for Normal

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

Formats the value using the given formatter.

impl From<(f32, f32, f32)> for Normal

fn from(xyz: (f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<Normal> for Vector

fn from(normal: Normal) -> Self

Converts to this type from the input type.

impl IsClose for Normal

fn is_close(&self, other: Normal) -> bool

Return true if the three xyz components of two Normal are close.

impl Mul<Normal> for Transformation

type Output = Normal

The resulting type after applying the * operator.

fn mul(self, normal: Normal) -> Self::Output

Performs the * operation.

impl Mul<Vector> for Normal

type Output = Normal

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Normal

type Output = Normal

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Normal

type Output = Normal

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Normal

fn eq(&self, other: &Normal) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Normal

impl StructuralPartialEq for Normal