Struct Scope

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

Scope defining enclosing viewing frustum.

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

Implementations

impl<N: Copy + RealField> Scope<N>

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 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 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 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: &Point2<N>) -> (Matrix4<N>, 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: Copy + RealField>(self) -> Scope<M>

where N: SubsetOf<M>,

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

Trait Implementations

impl<N: Clone + Copy + RealField> Clone for Scope<N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + Copy + RealField> Debug for Scope<N>

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

Formats the value using the given formatter.

impl<N: Copy + RealField> Default for Scope<N>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, N> Deserialize<'de> for Scope<N>

where N: Deserialize<'de> + Copy + RealField,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N: PartialEq + Copy + RealField> PartialEq for Scope<N>

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> Serialize for Scope<N>

where N: Serialize + Copy + RealField,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N: Copy + Copy + RealField> Copy for Scope<N>

impl<N: Eq + Copy + RealField> Eq for Scope<N>

impl<N: Copy + RealField> StructuralPartialEq for Scope<N>