Struct nalgebra::OrthoMat3

pub struct OrthoMat3<N> {
    // some fields omitted
}

A 3D orthographic projection stored as a 4D matrix.

This flips the z axis and maps a axis-aligned cube to the unit cube with corners varying from (-1, -1, -1) to (1, 1, 1). Reading or modifying its individual properties is costly but applying the transformation is cheap.

Methods

impl<N: BaseFloat> OrthoMat3<N>

fn new(left: N, right: N, bottom: N, top: N, znear: N, zfar: N) -> OrthoMat3<N>

Creates a new orthographic projection matrix.

fn new_with_fov(aspect: N, vfov: N, znear: N, zfar: N) -> OrthoMat3<N>

Creates a new orthographic projection matrix from an aspect ratio and the vertical field of view.

unsafe fn new_with_mat(mat: Mat4<N>) -> OrthoMat3<N>

Creates a new orthographic matrix from a 4D matrix.

This is unsafe because the input matrix is not checked to be a orthographic projection.

fn as_mat<'a>(&'a self) -> &'a Mat4<N>

Returns a reference to the 4D matrix (using homogeneous coordinates) of this projection.

fn left(&self) -> N

The smallest x-coordinate of the view cuboid.

fn right(&self) -> N

The largest x-coordinate of the view cuboid.

fn bottom(&self) -> N

The smallest y-coordinate of the view cuboid.

fn top(&self) -> N

The largest y-coordinate of the view cuboid.

fn znear(&self) -> N

The near plane offset of the view cuboid.

fn zfar(&self) -> N

The far plane offset of the view cuboid.

fn set_left(&mut self, left: N)

Sets the smallest x-coordinate of the view cuboid.

fn set_right(&mut self, right: N)

Sets the largest x-coordinate of the view cuboid.

fn set_bottom(&mut self, bottom: N)

Sets the smallest y-coordinate of the view cuboid.

fn set_top(&mut self, top: N)

Sets the largest y-coordinate of the view cuboid.

fn set_znear(&mut self, znear: N)

Sets the near plane offset of the view cuboid.

fn set_zfar(&mut self, zfar: N)

Sets the far plane offset of the view cuboid.

fn set_left_and_right(&mut self, left: N, right: N)

Sets the view cuboid coordinates along the x axis.

fn set_bottom_and_top(&mut self, bottom: N, top: N)

Sets the view cuboid coordinates along the y axis.

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

Sets the near and far plane offsets of the view cuboid.

fn project_pnt(&self, p: &Pnt3<N>) -> Pnt3<N>

Projects a point.

fn project_vec(&self, p: &Vec3<N>) -> Vec3<N>

Projects a vector.

impl<N: BaseFloat + Clone> OrthoMat3<N>

fn to_mat<'a>(&'a self) -> Mat4<N>

Returns the 4D matrix (using homogeneous coordinates) of this projection.

Trait Implementations

impl<N: Copy> Copy for OrthoMat3<N>

impl<N: Debug> Debug for OrthoMat3<N>

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

Formats the value using the given formatter.

impl<N: Clone> Clone for OrthoMat3<N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Decodable> Decodable for OrthoMat3<N>

fn decode<__DN: Decoder>(__arg_0: &mut __DN) -> Result<OrthoMat3<N>, __DN::Error>

impl<N: Encodable> Encodable for OrthoMat3<N>

fn encode<__SN: Encoder>(&self, __arg_0: &mut __SN) -> Result<(), __SN::Error>

impl<N: PartialEq> PartialEq for OrthoMat3<N>

fn eq(&self, __arg_0: &OrthoMat3<N>) -> bool

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

fn ne(&self, __arg_0: &OrthoMat3<N>) -> bool

This method tests for !=.

impl<N: Eq> Eq for OrthoMat3<N>