Struct nalgebra::geometry::Perspective3

source ·
#[repr(C)]
pub struct Perspective3<T> { /* private fields */ }
Expand description

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

Implementations§

source§

impl<T> Perspective3<T>

source

pub const fn from_matrix_unchecked(matrix: Matrix4<T>) -> Self

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.

source§

impl<T: RealField> Perspective3<T>

source

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

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

source

pub fn inverse(&self) -> Matrix4<T>

Retrieves the inverse of the underlying homogeneous matrix.

source

pub fn to_homogeneous(self) -> Matrix4<T>

Computes the corresponding homogeneous matrix.

source

pub fn as_matrix(&self) -> &Matrix4<T>

A reference to the underlying homogeneous transformation matrix.

source

pub fn as_projective(&self) -> &Projective3<T>

A reference to this transformation seen as a Projective3.

source

pub fn to_projective(self) -> Projective3<T>

This transformation seen as a Projective3.

source

pub fn into_inner(self) -> Matrix4<T>

Retrieves the underlying homogeneous matrix.

source

pub fn unwrap(self) -> Matrix4<T>

👎Deprecated: use .into_inner() instead

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

source

pub fn aspect(&self) -> T

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

source

pub fn fovy(&self) -> T

Gets the y field of view of the view frustum.

source

pub fn znear(&self) -> T

Gets the near plane offset of the view frustum.

source

pub fn zfar(&self) -> T

Gets the far plane offset of the view frustum.

source

pub fn project_point(&self, p: &Point3<T>) -> Point3<T>

Projects a point. Faster than matrix multiplication.

source

pub fn unproject_point(&self, p: &Point3<T>) -> Point3<T>

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

source

pub fn project_vector<SB>(&self, p: &Vector<T, U3, SB>) -> Vector3<T>
where SB: Storage<T, U3>,

Projects a vector. Faster than matrix multiplication.

source

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

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

source

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

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

source

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

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

source

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

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

source

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§

source§

impl<T: Clone> Clone for Perspective3<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: RealField> From<Perspective3<T>> for Matrix4<T>

source§

fn from(pers: Perspective3<T>) -> Self

Converts to this type from the input type.
source§

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

source§

fn eq(&self, right: &Self) -> bool

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

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.
source§

impl<T: Copy> Copy for Perspective3<T>

Auto Trait Implementations§

§

impl<T> Freeze for Perspective3<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Perspective3<T>
where T: RefUnwindSafe,

§

impl<T> Send for Perspective3<T>
where T: Send,

§

impl<T> Sync for Perspective3<T>
where T: Sync,

§

impl<T> Unpin for Perspective3<T>
where T: Unpin,

§

impl<T> UnwindSafe for Perspective3<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,