trackball

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.

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.
• [Clamp] operation handler ensuring user boundary conditions of observer [Frame].
• 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 [Scene::set_fov()].
• Time-free [Touch] gesture recognition for slide, orbit, scale, and focus operations.

See the release history to keep track of the development.

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.

```rust use trackball::{ nalgebra::{Point2, Vector3}, Frame, Image, Orbit, };

/// Trackball camera mode. pub struct Trackball { // Frame wrt camera eye and target. frame: Frame, // Image as projection of Scene wrt Frame. image: Image, // Orbit induced by displacement on screen. orbit: Orbit, }

impl Trackball { // Usually, a cursor position event with left mouse button being pressed. fn handleleftbuttondisplacement(&mut self, pos: &Point2) { // 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).unwrapordefault(); // Apply induced rotation to local observer frame. self.frame.localorbit(&rot); } // Event when left mouse button is released again. fn handleleftbutton_release(&mut self) { // Can also or instead be invoked on Self::handle_left_button_press(). self.orbit.discard(); } } ```

C11 Implementation

Identical C11 implementation for [Orbit] operation handler behind cc feature gate:

toml [dependencies] trackball = { version = "0.10.0", features = ["cc"] }

License

Copyright © 2021-2023 Rouven Spreckels rs@qu1x.dev

This project is licensed under either of

• Apache License, Version 2.0, (LICENSES/Apache-2.0 or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSES/MIT or https://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.