glam 0.33.2

// Generated from camera_view.rs.tera template. Edit the template, not the generated file.

//! View (camera) constructors for right-handed world coordinate systems.
//!
//! Every function transforms world space points into a right-handed Y-up
//! view space with X-right and -Z-forward.
//!
//! * `look_at_*` targets a focal point (`center`)
//! * `look_to_*` targets a forward direction (`dir`)
//!
//! Functions returning `Mat4`, `Affine3`, `Affine3A`, or
//! similar return a full view transform (rotation and translation).
//! Functions returning `Mat3`, `Mat3A`, or `Quat` return
//! only the view rotation.

use crate::{camera::camera_impl, Affine3, Affine3A, Mat3, Mat3A, Mat4, Quat, Vec3};

/// Returns a `Mat4` view matrix from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_at_mat4(eye: Vec3, center: Vec3, up: Vec3) -> Mat4 {
    look_to_mat4(eye, (center - eye).normalize(), up)
}

/// Returns a `Mat4` view matrix from eye, forward direction, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_to_mat4(eye: Vec3, dir: Vec3, up: Vec3) -> Mat4 {
    camera_impl::look_to_mat4::<true>(eye, dir, up)
}

/// Returns an `Affine3` view transform from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_at_affine3(eye: Vec3, center: Vec3, up: Vec3) -> Affine3 {
    look_to_affine3(eye, (center - eye).normalize(), up)
}

/// Returns an `Affine3` view transform from eye, forward direction, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_to_affine3(eye: Vec3, dir: Vec3, up: Vec3) -> Affine3 {
    camera_impl::look_to_affine3::<true>(eye, dir, up)
}

/// Returns an `Affine3A` view transform from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_at_affine3a(eye: Vec3, center: Vec3, up: Vec3) -> Affine3A {
    look_to_affine3a(eye, (center - eye).normalize(), up)
}

/// Returns an `Affine3A` view transform from eye, forward direction, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_to_affine3a(eye: Vec3, dir: Vec3, up: Vec3) -> Affine3A {
    camera_impl::look_to_affine3a::<true>(eye, dir, up)
}

/// Returns a `Mat3` view rotation (no translation) from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_at_mat3(eye: Vec3, center: Vec3, up: Vec3) -> Mat3 {
    look_to_mat3((center - eye).normalize(), up)
}

/// Returns a `Mat3` view rotation (no translation) from direction and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_to_mat3(dir: Vec3, up: Vec3) -> Mat3 {
    camera_impl::look_to_mat3::<true>(dir, up)
}

/// Returns a `Mat3A` view rotation (no translation) from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_at_mat3a(eye: Vec3, center: Vec3, up: Vec3) -> Mat3A {
    look_to_mat3a((center - eye).normalize(), up)
}

/// Returns a `Mat3A` view rotation (no translation) from direction and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_to_mat3a(dir: Vec3, up: Vec3) -> Mat3A {
    camera_impl::look_to_mat3a::<true>(dir, up)
}

/// Returns a `Quat` view rotation from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_at_quat(eye: Vec3, center: Vec3, up: Vec3) -> Quat {
    look_to_quat((center - eye).normalize(), up)
}

/// Returns a `Quat` view rotation from direction and up.
///
/// Transforms right-handed world space points into right-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized when `glam_assert` is enabled.
#[inline]
#[must_use]
pub fn look_to_quat(dir: Vec3, up: Vec3) -> Quat {
    camera_impl::look_to_quat::<true>(dir, up)
}