Struct truster::tuple::Tuple

pub struct Tuple { /* fields omitted */ }

Tuple represents a 3D tuple. See the module’s documentation for more information.

Implementations

impl Tuple

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

Returns a new tuple with the given components. You should use Tuple::point and Tuple::vector instead.

pub fn point(x: f64, y: f64, z: f64) -> Self

Returns a new point with the given coordinates.

pub fn vector(x: f64, y: f64, z: f64) -> Self

Returns a new vector with the given coordinates.

pub fn x(&self) -> f64

Returns selfs x coordinate.

pub fn y(&self) -> f64

Returns selfs y coordinate.

pub fn z(&self) -> f64

Returns selfs z coordinate.

pub fn w(&self) -> f64

Returns selfs w coordinate.

pub fn is_point(&self) -> bool

Returns true if self represents a point, false otherwise.

pub fn is_vector(&self) -> bool

Returns true if self represents a vector, false otherwise.

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

Returns the dot product between self and other. See the module’s documentation for examples. Only works for vectors, not points.

pub fn cross(self, other: Self) -> Self

Returns the cross product between self and other. See the module’s documentation for examples. Only works for vectors, not points.

pub fn norm_squared(self) -> f64

Returns the square of the euclidean norm of self. See the module’s documentation for examples. Only works for vectors, not points.

pub fn norm(self) -> f64

Returns the norm of self. See the module’s documentation for examples. Only works for vectors, not points.

pub fn normalized(self) -> Self

Returns a vector in the same direction as self, but with euclidean norm of one. See the module’s documentation for examples. Only works for vectors, not points.

pub fn normalize(&mut self)

Changes self to have a euclidean norm of one, while keeping its direction. See the module’s documentation for examples. Only works for vectors, not points.

pub fn reflect(self, normal: Self) -> Self

Reflects self along normal

Trait Implementations

impl Add<Tuple> for Tuple

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<Tuple> for Tuple

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Tuple

fn clone(&self) -> Tuple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tuple

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

Formats the value using the given formatter.

impl Default for Tuple

fn default() -> Tuple

Returns the “default value” for a type.

impl Display for Tuple

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

Formats the value using the given formatter.

impl Div<f64> for Tuple

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl DivAssign<f64> for Tuple

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl Index<usize> for Tuple

type Output = f64

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Tuple

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Mul<Tuple> for &Matrix

type Output = Tuple

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Tuple

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Tuple

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for Tuple

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<Tuple> for Tuple

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

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

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

This method tests for !=.

impl Sub<Tuple> for Tuple

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<Tuple> for Tuple

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Tuple

impl StructuralPartialEq for Tuple