viewport-lib 0.18.2

3D viewport rendering library
Documentation 
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

//! Camera tracking binding for follow-camera behavior.

use crate::interaction::selection::NodeId;

/// Camera tracking mode for [`super::ViewportRuntime`].
///
/// When set, the runtime computes a suggested camera center after each step
/// and emits it as a [`super::CameraFollowTarget`] event on
/// [`super::RuntimeOutput::events`]. The app reads the event by calling
/// `output.events.read::<CameraFollowTarget>()` and applies the suggestion
/// however fits the application (typically by setting `camera.center`).
///
/// Set via [`super::ViewportRuntime::set_camera_follow`] or
/// [`super::ViewportRuntime::with_camera_follow`].
#[derive(Debug, Clone)]
pub enum CameraFollow {
    /// Track a scene node.
    ///
    /// The suggested center is `node_world_pos + offset`. Orbit camera distance
    /// and orientation are unaffected; the camera pivots around the moving target.
    Node {
        /// Node to follow.
        id: NodeId,
        /// World-space offset added to the node's position.
        offset: glam::Vec3,
        /// Unused by the runtime itself. Apps may use it to decide whether to
        /// orient the camera toward the node.
        look_at: bool,
    },
    /// No tracking. The runtime does not emit `CameraFollowTarget`.
    Free,
}