Struct tray_rust::linalg::normal::Normal

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

Normal is a standard 3 component normal but transforms as a normal normal when transformations are applied

Fields

x: f32

y: f32

z: f32

Methods

impl Normal

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

Initialize the normal and set values for x, y, z

pub fn broadcast(x: f32) -> Normal

Initialize the normal with the same value of x, y, z

pub fn length_sqr(&self) -> f32

Compute the squared length of the normal

pub fn length(&self) -> f32

Compute the length of the normal

pub fn normalized(&self) -> Normal

Get a normalized copy of this normal

pub fn face_forward(&self, v: &Vector) -> Normal

Return a normal facing along the same direction as v

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 Copy for Normal

impl PartialEq<Normal> 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: &Normal) -> bool

This method tests for !=.

impl PartialOrd<Normal> for Normal

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

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

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

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

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

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

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

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

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

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

impl Debug for Normal

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

Formats the value using the given formatter.

impl Div<Normal> for Normal

type Output = Normal

The resulting type after applying the / operator.

fn div(self, rhs: Normal) -> Normal

Divide the normals components by the right hand side's components

impl Div<f32> for Normal

type Output = Normal

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Normal

Divide the normals components by scalar

impl Sub<Normal> for Normal

type Output = Normal

The resulting type after applying the - operator.

fn sub(self, rhs: Normal) -> Normal

Subtract two normals

impl Add<Normal> for Normal

type Output = Normal

The resulting type after applying the + operator.

fn add(self, rhs: Normal) -> Normal

Add two normals together

impl Mul<Normal> for Normal

type Output = Normal

The resulting type after applying the * operator.

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

Multiply two normals

impl Mul<f32> for Normal

type Output = Normal

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Normal

Scale the normal by some value

impl Mul<Normal> for f32

type Output = Normal

The resulting type after applying the * operator.

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

Scale the normal by some value

impl Mul<Normal> for Transform

type Output = Normal

The resulting type after applying the * operator.

fn mul(self, n: Normal) -> Normal

Multiply the normal by the transform to apply the transformation

impl Neg for Normal

type Output = Normal

The resulting type after applying the - operator.

fn neg(self) -> Normal

Negate the normal

impl Index<usize> for Normal

type Output = f32

The returned type after indexing.

fn index(&self, i: usize) -> &f32

Access the normal by index

• 0 = x
• 1 = y
• 2 = z

impl IndexMut<usize> for Normal

fn index_mut(&mut self, i: usize) -> &mut f32

Access the normal by index

• 0 = x
• 1 = y
• 2 = z

impl StructuralPartialEq for Normal