trackball/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
//! Virtual Trackball Orbiting via the Exponential Map
//!
//! This is an alternative trackball technique using exponential map and parallel transport to
//! preserve distances and angles for inducing coherent and intuitive trackball rotations. For
//! instance, displacements on straight radial lines through the screen's center are carried to arcs
//! of the same length on great circles of the trackball. This is in contrast to state-of-the-art
//! techniques using orthogonal projection which distorts radial distances further away from the
//! screen's center. This implementation strictly follows the recipe given in the paper of
//! Stantchev, G.. “Virtual Trackball Modeling and the Exponential Map.” . [S2CID] [44199608].
//!
//! [S2CID]: https://en.wikipedia.org/wiki/S2CID_(identifier)
//! [44199608]: https://api.semanticscholar.org/CorpusID:44199608
//!
//! # Features
//!
//!   * Common trackball operations split into several operation handlers.
//!   * Coherent and intuitive orbiting via the exponential map, see [`Orbit`] operation handler.
//!   * Identical C11 implementation for [`Orbit`] operation handler behind `cc` feature gate.
//!   * Coherent [`First`] person view aka free look or mouse look wrt [`Orbit`] operation handler.
//!   * Observer [`Frame`] with [`Frame::slide()`], [`Frame::orbit()`], [`Frame::scale()`]
//!     operations in world space and their local complements in camera space and with orbit and
//!     slide operations around arbitrary points in either world or camera space.
//!   * Gliding [`Clamp`] operation handler trait ensuring boundary conditions of observer
//!     [`Frame`]. When [`Delta`] between initial and final [`Frame`] is not orthogonal to a
//!     boundary [`Plane`], [`Delta`] is changed in such a way that the clamped movement glides
//!     along the plane.
//!   * [`Bound`] implementing [`Clamp`] providing customizable orthogonal boundary conditions.
//!   * Object inspection mode scaling clip plane distances by measuring from target instead of eye.
//!   * Scale-preserving transitioning between orthographic and perspective projection mode.
//!   * Converting between [`Fixed`] quantities wrt to field of view, see [`Scope::set_fov()`].
//!   * Time-free [`Touch`] gesture recognition for slide, orbit, scale, and focus operations.
//!
//! # Example
//!
//! A trackball camera mode implementation can be as easy as this by delegating events of your 3D
//! graphics library of choice to the [`Orbit`] operation handler along with other handlers.
//!
//! ```
//! use trackball::{
//! 	nalgebra::{Point2, Vector3},
//! 	Frame, Image, Orbit,
//! };
//!
//! /// Trackball camera mode.
//! pub struct Trackball {
//! 	// Frame wrt camera eye and target.
//! 	frame: Frame<f32>,
//! 	// Image as projection of `Scope` wrt `Frame`.
//! 	image: Image<f32>,
//! 	// Orbit induced by displacement on screen.
//! 	orbit: Orbit<f32>,
//! }
//!
//! impl Trackball {
//! 	// Usually, a cursor position event with left mouse button being pressed.
//! 	fn handle_left_button_displacement(&mut self, pos: &Point2<f32>) {
//! 		// Maximum position as screen's width and height.
//! 		let max = self.image.max();
//! 		// Induced rotation in camera space.
//! 		let rot = self.orbit.compute(&pos, max).unwrap_or_default();
//! 		// Apply induced rotation to local observer frame.
//! 		self.frame.local_orbit(&rot);
//! 	}
//! 	// Event when left mouse button is released again.
//! 	fn handle_left_button_release(&mut self) {
//! 		// Can also or instead be invoked on `Self::handle_left_button_press()`.
//! 		self.orbit.discard();
//! 	}
//! }
//! ```

#![cfg_attr(any(feature = "rkyv", feature = "cc"), deny(unsafe_code))]
#![cfg_attr(not(any(feature = "rkyv", feature = "cc")), forbid(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![no_std]

pub use approx;
pub use nalgebra;

mod bound;
mod clamp;
mod delta;
mod first;
mod fixed;
mod frame;
mod image;
mod orbit;
mod plane;
mod scale;
mod scope;
mod slide;
mod touch;

pub use bound::*;
pub use clamp::*;
pub use delta::*;
pub use first::*;
pub use fixed::*;
pub use frame::*;
pub use image::*;
pub use orbit::*;
pub use plane::*;
pub use scale::*;
pub use scope::*;
pub use slide::*;
pub use touch::*;