Small docs improvements
This commit is contained in:
parent
52ca5c95ef
commit
54f1c71742
@ -16,7 +16,7 @@ use crate::base::{Matrix4, Vector, Vector3};
|
|||||||
|
|
||||||
use crate::geometry::{Point3, Projective3};
|
use crate::geometry::{Point3, Projective3};
|
||||||
|
|
||||||
/// A 3D orthographic projection stored as an homogeneous 4x4 matrix.
|
/// A 3D orthographic projection stored as a homogeneous 4x4 matrix.
|
||||||
pub struct Orthographic3<N: RealField> {
|
pub struct Orthographic3<N: RealField> {
|
||||||
matrix: Matrix4<N>,
|
matrix: Matrix4<N>,
|
||||||
}
|
}
|
||||||
|
@ -17,7 +17,7 @@ use crate::base::{Matrix4, Scalar, Vector, Vector3};
|
|||||||
|
|
||||||
use crate::geometry::{Point3, Projective3};
|
use crate::geometry::{Point3, Projective3};
|
||||||
|
|
||||||
/// A 3D perspective projection stored as an homogeneous 4x4 matrix.
|
/// A 3D perspective projection stored as a homogeneous 4x4 matrix.
|
||||||
pub struct Perspective3<N: Scalar> {
|
pub struct Perspective3<N: Scalar> {
|
||||||
matrix: Matrix4<N>,
|
matrix: Matrix4<N>,
|
||||||
}
|
}
|
||||||
@ -89,7 +89,7 @@ impl<N: RealField> Perspective3<N> {
|
|||||||
|
|
||||||
/// Wraps the given matrix to interpret it as a 3D perspective matrix.
|
/// 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
|
/// It is not checked whether or not the given matrix actually represents a perspective
|
||||||
/// projection.
|
/// projection.
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn from_matrix_unchecked(matrix: Matrix4<N>) -> Self {
|
pub fn from_matrix_unchecked(matrix: Matrix4<N>) -> Self {
|
||||||
|
@ -2,16 +2,16 @@ use crate::base::dimension::{U2, U3};
|
|||||||
|
|
||||||
use crate::geometry::{TAffine, TGeneral, TProjective, Transform};
|
use crate::geometry::{TAffine, TGeneral, TProjective, Transform};
|
||||||
|
|
||||||
/// A 2D general transformation that may not be invertible. Stored as an homogeneous 3x3 matrix.
|
/// A 2D general transformation that may not be invertible. Stored as a homogeneous 3x3 matrix.
|
||||||
pub type Transform2<N> = Transform<N, U2, TGeneral>;
|
pub type Transform2<N> = Transform<N, U2, TGeneral>;
|
||||||
/// An invertible 2D general transformation. Stored as an homogeneous 3x3 matrix.
|
/// An invertible 2D general transformation. Stored as a homogeneous 3x3 matrix.
|
||||||
pub type Projective2<N> = Transform<N, U2, TProjective>;
|
pub type Projective2<N> = Transform<N, U2, TProjective>;
|
||||||
/// A 2D affine transformation. Stored as an homogeneous 3x3 matrix.
|
/// A 2D affine transformation. Stored as a homogeneous 3x3 matrix.
|
||||||
pub type Affine2<N> = Transform<N, U2, TAffine>;
|
pub type Affine2<N> = Transform<N, U2, TAffine>;
|
||||||
|
|
||||||
/// A 3D general transformation that may not be inversible. Stored as an homogeneous 4x4 matrix.
|
/// A 3D general transformation that may not be inversible. Stored as a homogeneous 4x4 matrix.
|
||||||
pub type Transform3<N> = Transform<N, U3, TGeneral>;
|
pub type Transform3<N> = Transform<N, U3, TGeneral>;
|
||||||
/// An invertible 3D general transformation. Stored as an homogeneous 4x4 matrix.
|
/// An invertible 3D general transformation. Stored as a homogeneous 4x4 matrix.
|
||||||
pub type Projective3<N> = Transform<N, U3, TProjective>;
|
pub type Projective3<N> = Transform<N, U3, TProjective>;
|
||||||
/// A 3D affine transformation. Stored as an homogeneous 4x4 matrix.
|
/// A 3D affine transformation. Stored as a homogeneous 4x4 matrix.
|
||||||
pub type Affine3<N> = Transform<N, U3, TAffine>;
|
pub type Affine3<N> = Transform<N, U3, TAffine>;
|
||||||
|
@ -51,7 +51,7 @@ an optimized set of tools for computer graphics and physics. Those features incl
|
|||||||
allocated on the heap.
|
allocated on the heap.
|
||||||
* Convenient aliases for low-dimensional matrices and vectors: `Vector1` to `Vector6` and
|
* Convenient aliases for low-dimensional matrices and vectors: `Vector1` to `Vector6` and
|
||||||
`Matrix1x1` to `Matrix6x6`, including rectangular matrices like `Matrix2x5`.
|
`Matrix1x1` to `Matrix6x6`, including rectangular matrices like `Matrix2x5`.
|
||||||
* Points sizes known at compile time, and convenience aliases:: `Point1` to `Point6`.
|
* Points sizes known at compile time, and convenience aliases: `Point1` to `Point6`.
|
||||||
* Translation (seen as a transformation that composes by multiplication): `Translation2`,
|
* Translation (seen as a transformation that composes by multiplication): `Translation2`,
|
||||||
`Translation3`.
|
`Translation3`.
|
||||||
* Rotation matrices: `Rotation2`, `Rotation3`.
|
* Rotation matrices: `Rotation2`, `Rotation3`.
|
||||||
@ -60,10 +60,10 @@ an optimized set of tools for computer graphics and physics. Those features incl
|
|||||||
* Algebraic entities with a norm equal to one: `Unit<T>`, e.g., `Unit<Vector3<f32>>`.
|
* Algebraic entities with a norm equal to one: `Unit<T>`, e.g., `Unit<Vector3<f32>>`.
|
||||||
* Isometries (translation ⨯ rotation): `Isometry2`, `Isometry3`
|
* Isometries (translation ⨯ rotation): `Isometry2`, `Isometry3`
|
||||||
* Similarity transformations (translation ⨯ rotation ⨯ uniform scale): `Similarity2`, `Similarity3`.
|
* Similarity transformations (translation ⨯ rotation ⨯ uniform scale): `Similarity2`, `Similarity3`.
|
||||||
* Affine transformations stored as an homogeneous matrix: `Affine2`, `Affine3`.
|
* Affine transformations stored as a homogeneous matrix: `Affine2`, `Affine3`.
|
||||||
* Projective (i.e. invertible) transformations stored as an homogeneous matrix: `Projective2`,
|
* Projective (i.e. invertible) transformations stored as a homogeneous matrix: `Projective2`,
|
||||||
`Projective3`.
|
`Projective3`.
|
||||||
* General transformations that does not have to be invertible, stored as an homogeneous matrix:
|
* General transformations that does not have to be invertible, stored as a homogeneous matrix:
|
||||||
`Transform2`, `Transform3`.
|
`Transform2`, `Transform3`.
|
||||||
* 3D projections for computer graphics: `Perspective3`, `Orthographic3`.
|
* 3D projections for computer graphics: `Perspective3`, `Orthographic3`.
|
||||||
* Matrix factorizations: `Cholesky`, `QR`, `LU`, `FullPivLU`, `SVD`, `Schur`, `Hessenberg`, `SymmetricEigen`.
|
* Matrix factorizations: `Cholesky`, `QR`, `LU`, `FullPivLU`, `SVD`, `Schur`, `Hessenberg`, `SymmetricEigen`.
|
||||||
|
Loading…
Reference in New Issue
Block a user