Struct lnkit::prelude::Perspective3

pub struct Perspective3<T> where
    T: Scalar,  { /* fields omitted */ }

A 3D perspective projection stored as a homogeneous 4x4 matrix.

Implementations

impl<T> Perspective3<T> where
    T: RealField, 

pub fn new(aspect: T, fovy: T, znear: T, zfar: T) -> Perspective3<T>

Creates a new perspective matrix from the aspect ratio, y field of view, and near/far planes.

pub fn from_matrix_unchecked(
    matrix: Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>
) -> Perspective3<T>

Wraps the given matrix to interpret it as a 3D perspective matrix.

It is not checked whether or not the given matrix actually represents a perspective projection.

pub fn inverse(
    &self
) -> Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>

Retrieves the inverse of the underlying homogeneous matrix.

pub fn to_homogeneous(
    &self
) -> Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>

Computes the corresponding homogeneous matrix.

pub fn as_matrix(
    &self
) -> &Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>

A reference to the underlying homogeneous transformation matrix.

pub fn as_projective(&self) -> &Transform<T, TProjective, 3_usize>

A reference to this transformation seen as a Projective3.

pub fn to_projective(&self) -> Transform<T, TProjective, 3_usize>

This transformation seen as a Projective3.

pub fn into_inner(
    self
) -> Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>

Retrieves the underlying homogeneous matrix.

pub fn unwrap(
    self
) -> Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>

👎 Deprecated:

use .into_inner() instead

Retrieves the underlying homogeneous matrix. Deprecated: Use Perspective3::into_inner instead.

pub fn aspect(&self) -> T

Gets the width / height aspect ratio of the view frustum.

pub fn fovy(&self) -> T

Gets the y field of view of the view frustum.

pub fn znear(&self) -> T

Gets the near plane offset of the view frustum.

pub fn zfar(&self) -> T

Gets the far plane offset of the view frustum.

pub fn project_point(&self, p: &Point<T, 3_usize>) -> Point<T, 3_usize>

Projects a point. Faster than matrix multiplication.

pub fn unproject_point(&self, p: &Point<T, 3_usize>) -> Point<T, 3_usize>

Un-projects a point. Faster than multiplication by the matrix inverse.

pub fn project_vector<SB>(
    &self,
    p: &Matrix<T, Const<{_: usize}>, Const<1_usize>, SB>
) -> Matrix<T, Const<{_: usize}>, Const<1_usize>, ArrayStorage<T, 3_usize, 1_usize>> where
    SB: Storage<T, Const<{_: usize}>, Const<1_usize>>, 

Projects a vector. Faster than matrix multiplication.

pub fn set_aspect(&mut self, aspect: T)

Updates this perspective matrix with a new width / height aspect ratio of the view frustum.

pub fn set_fovy(&mut self, fovy: T)

Updates this perspective with a new y field of view of the view frustum.

pub fn set_znear(&mut self, znear: T)

Updates this perspective matrix with a new near plane offset of the view frustum.

pub fn set_zfar(&mut self, zfar: T)

Updates this perspective matrix with a new far plane offset of the view frustum.

pub fn set_znear_and_zfar(&mut self, znear: T, zfar: T)

Updates this perspective matrix with new near and far plane offsets of the view frustum.

Trait Implementations

impl<T> Clone for Perspective3<T> where
    T: RealField, 

pub fn clone(&self) -> Perspective3<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for Perspective3<T> where
    T: RealField, 

impl<T> Debug for Perspective3<T> where
    T: RealField, 

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

Formats the value using the given formatter.

impl<'a, T> Deserialize<'a> for Perspective3<T> where
    T: RealField + Deserialize<'a>, 

pub fn deserialize<Des>(
    deserializer: Des
) -> Result<Perspective3<T>, <Des as Deserializer<'a>>::Error> where
    Des: Deserializer<'a>, 

Deserialize this value from the given Serde deserializer.

impl<T> From<Perspective3<T>> for Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>> where
    T: RealField, 

pub fn from(
    pers: Perspective3<T>
) -> Matrix<T, Const<{_: usize}>, Const<{_: usize}>, ArrayStorage<T, 4_usize, 4_usize>>

Performs the conversion.

impl<T> PartialEq<Perspective3<T>> for Perspective3<T> where
    T: RealField, 

pub fn eq(&self, right: &Perspective3<T>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T> Serialize for Perspective3<T> where
    T: RealField + Serialize, 

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.