Struct kiss3d_trackball::Trackball

pub struct Trackball {
    pub input: Input<f32>,
    pub clamp: Clamp<f32>,
    pub frame: Frame<f32>,
    pub reset: Frame<f32>,
    pub scene: Scene<f32>,
    // some fields omitted
}

Trackball camera mode.

A trackball camera is a camera working similarly like a trackball device. The camera eye orbits around its target, the trackball’s center, and always looks at it. This implementation is split into several members defined by the trackball crate categorizing all the methods to control the different aspects of a camera.

Camera Input

Following default inputs are defined which are customizable via Self::input:

Mouse	Touch	Action
Left Button Press + Drag	One-Finger + Drag	Orbits around target.
↳ but at trackball’s border	Two-Finger + Roll	Rolls about view direction.
Drag + Left Shift	Any-Finger + Drag + Left Shift	First person view.
Right Button Press + Drag	Two-Finger + Drag	Slides trackball on focus plane.
Scroll In/Out	Two-Finger + Pinch Out/In	Scales distance zooming in/out.
Left Button Press + Release	Any-Finger + Release	Slides to cursor/finger position.

Keyboard	Action
O	Switches between orthographic and perspective projection.
Enter	Resets camera eye and target to Self::reset.

Camera Alignment

Realign camera via Self::frame and define user boundary conditions via Self::clamp like minimum and maximum target distance from camera eye. Optionally, update the alignment to reset to when pressing Input::reset_key() via Self::reset.

Camera Projection

Adjust camera projection via Self::scene like setting field of view or clip plane distances.

Fields

input: Input<f32>

Input keys/buttons and their modifiers.

clamp: Clamp<f32>

Clamp as user boundary conditions of Frame.

frame: Frame<f32>

Frame wrt camera eye and target.

reset: Frame<f32>

Reset frame wrt camera eye and target.

scene: Scene<f32>

Scene wrt enclosing viewing frustum.

Implementations

impl Trackball

pub fn new(
    target: Point3<f32>,
    eye: &Point3<f32>,
    up: &Vector3<f32>
) -> Trackball

Creates camera with eye position inclusive its roll attitude and target position.

Default viewing frustum has a fixed vertical field of view of π/4 with near and far clip planes at 1E-1 and 1E+6.

Note: Argument order differs from cameras in kiss3d::camera.

pub fn new_with_frustum(
    target: Point3<f32>,
    eye: &Point3<f32>,
    up: &Vector3<f32>,
    fov: impl Into<Fixed<f32>>,
    znear: f32,
    zfar: f32
) -> Trackball

Like Self::new() but with custom viewing frustum.

For a fixed vertical field of view simply pass an f32 angle in radians as fov, otherwise see Fixed and Scene::set_fov().

Note: Argument order differs from cameras in kiss3d::camera.

Trait Implementations

impl Camera for Trackball

fn clip_planes(&self) -> (f32, f32)

The clipping planes, aka. (znear, zfar).

fn view_transform(&self) -> Isometry3<f32>

The camera view transform.

fn eye(&self) -> Point3<f32>

The camera position.

fn handle_event(&mut self, canvas: &Canvas, event: &WindowEvent)

Handle a mouse event.

fn upload(
    &self,
    _: usize,
    proj: &mut ShaderUniform<Matrix4<f32>>,
    view: &mut ShaderUniform<Matrix4<f32>>
)

Upload the camera view and projection to the gpu. This can be called multiple times on the render loop.

fn transformation(&self) -> Matrix4<f32>

The transformation applied by the camera to transform a point in world coordinates to a point in device coordinates.

fn inverse_transformation(&self) -> Matrix4<f32>

The transformation applied by the camera to transform point in device coordinates to a point in world coordinate.

fn update(&mut self, _: &Canvas)

Update the camera. This is called once at the beginning of the render loop.

pub fn num_passes(&self) -> usize

The number of passes required by this camera.

pub fn start_pass(&self, _pass: usize, _canvas: &Canvas)

Indicates that a pass will begin.

pub fn render_complete(&self, _canvas: &Canvas)

Indicates that the scene has been rendered and the post-processing is being run.

pub fn project(
    &self,
    world_coord: &Point<f32, 3_usize>,
    size: &Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
) -> Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>

Converts a 3d point to 2d screen coordinates, assuming the screen has the size size.

pub fn unproject(
    &self,
    window_coord: &Point<f32, 2_usize>,
    size: &Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
) -> (Point<f32, 3_usize>, Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>)

Converts a point in 2d screen coordinates to a ray (a 3d position and a direction).

impl Clone for Trackball

fn clone(&self) -> Trackball

Returns a copy of the value.

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

Performs copy-assignment from source.