Struct na::geometry::Perspective3

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

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

Methods

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

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

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

pub fn from_matrix_unchecked(
    matrix: Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>
) -> Perspective3<N>

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

It is not checked whether or not the given matrix actually represents an orthographic projection.

pub fn inverse(
    &self
) -> Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>

Retrieves the inverse of the underlying homogeneous matrix.

pub fn to_homogeneous(
    &self
) -> Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>

Computes the corresponding homogeneous matrix.

pub fn as_matrix(
    &self
) -> &Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>

A reference to the underlying homogeneous transformation matrix.

pub fn as_projective(&self) -> &Transform<N, U3, TProjective>

A reference to this transformation seen as a Projective3.

pub fn to_projective(&self) -> Transform<N, U3, TProjective>

This transformation seen as a Projective3.

pub fn into_inner(
    self
) -> Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>

Retrieves the underlying homogeneous matrix.

pub fn unwrap(
    self
) -> Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>

Deprecated:

use .into_inner() instead

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

pub fn aspect(&self) -> N

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

pub fn fovy(&self) -> N

Gets the y field of view of the view frustum.

pub fn znear(&self) -> N

Gets the near plane offset of the view frustum.

pub fn zfar(&self) -> N

Gets the far plane offset of the view frustum.

pub fn project_point(&self, p: &Point<N, U3>) -> Point<N, U3>

Projects a point. Faster than matrix multiplication.

pub fn unproject_point(&self, p: &Point<N, U3>) -> Point<N, U3>

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

pub fn project_vector<SB>(
    &self,
    p: &Matrix<N, U3, U1, SB>
) -> Matrix<N, U3, U1, <DefaultAllocator as Allocator<N, U3, U1>>::Buffer> where
    SB: Storage<N, U3, U1>, 

Projects a vector. Faster than matrix multiplication.

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

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

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

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

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

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

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

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

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

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

Trait Implementations

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

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

fn clone(&self) -> Perspective3<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

#[must_use]

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

This method tests for !=.

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

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

Formats the value using the given formatter.

impl<N> From<Perspective3<N>> for Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer> where
    N: RealField, 

fn from(
    orth: Perspective3<N>
) -> Matrix<N, U4, U4, <DefaultAllocator as Allocator<N, U4, U4>>::Buffer>

Performs the conversion.