Struct Scope

pub struct Scope<N>
where
    N: Copy + RealField,
{ /* private fields */ }

Scope defining enclosing viewing frustum.

Implements Default and can be created with Scope::default().

Implementations

impl<N> Scope<N>

where N: Copy + RealField,

pub const fn fov(&self) -> Fixed<N>

Fixed quantity wrt field of view, see Self::set_fov().

pub fn set_fov(&mut self, fov: impl Into<Fixed<N>>)

Sets fixed quantity wrt field of view.

Default is fixed vertical field of view of π/4.

use nalgebra::Point2;
use trackball::Scope;

// Current screen size.
let max = Point2::new(800, 600);
// Default scope with fixed vertical field of view of π/4:
//
//   * Increasing width increases horizontal field of view (more can be seen).
//   * Increasing height scales scope zooming in as vertical field of view is fixed.
let mut scope = Scope::default();
// Unfix vertical field of view by fixing current unit per pixel on focus plane at distance
// from eye of one, that is effectively `upp` divided by `zat` to make it scale-independant:
//
//   * Increasing width increases horizontal field of view (more can be seen).
//   * Increasing height increases vertical field of view (more can be seen).
scope.set_fov(scope.fov().to_upp(&max.cast::<f32>()));

pub fn clip_planes(&self, zat: N) -> (N, N)

Clip plane distances from eye regardless of Self::scale() wrt to distance between eye and target.

Default is (1e-1, 1e+3) measured from eye.

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

Sets clip plane distances from target or eye whether Self::scale().

Default is (1e-1, 1e+3) measured from eye.

pub const fn scale(&self) -> bool

Object inspection mode.

Scales clip plane distances by measuring from target instead of eye. Default is false.

pub const fn set_scale(&mut self, oim: bool)

Sets object inspection mode.

Scales clip plane distances by measuring from target instead of eye. Default is false.

pub const fn ortho(&self) -> bool

Orthographic projection mode.

Computes scale-identical orthographic instead of perspective projection. Default is false.

pub const fn set_ortho(&mut self, opm: bool)

Sets orthographic projection mode.

Computes scale-identical orthographic instead of perspective projection. Default is false.

pub fn projection_and_upp( &self, zat: N, max: &OPoint<N, Const<2>>, ) -> (Matrix<N, Const<4>, Const<4>, ArrayStorage<N, 4, 4>>, N)

Projection transformation and unit per pixel on focus plane wrt distance between eye and target and maximum position in screen space.

pub fn cast<M>(self) -> Scope<M>

where M: Copy + RealField, N: SubsetOf<M>,

Casts components to another type, e.g., between f32 and f64.

Trait Implementations

impl<N> Clone for Scope<N>

where N: Clone + Copy + RealField,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Scope<N>

where N: Debug + Copy + RealField,

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

Formats the value using the given formatter.

impl<N> Default for Scope<N>

where N: Copy + RealField,

fn default() -> Scope<N>

Returns the “default value” for a type.

impl<N> PartialEq for Scope<N>

where N: PartialEq + Copy + RealField,

fn eq(&self, other: &Scope<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> Copy for Scope<N>

where N: Copy + RealField,

impl<N> Eq for Scope<N>

where N: Eq + Copy + RealField,

impl<N> StructuralPartialEq for Scope<N>

where N: Copy + RealField,