Skip to content

Commit

Permalink
Add note in docs about disabling controls by setting sensitivity to 0
Browse files Browse the repository at this point in the history
  • Loading branch information
Plonq committed Nov 21, 2024
1 parent 0671900 commit f3b44b0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,15 @@ pub struct PanOrbitCamera {
/// Should always be >0 otherwise you'll get stuck at 0.
/// Defaults to `0.05`.
pub zoom_lower_limit: f32,
/// The sensitivity of the orbiting motion.
/// The sensitivity of the orbiting motion. A value of `0.0` disables orbiting.
/// Defaults to `1.0`.
pub orbit_sensitivity: f32,
/// How much smoothing is applied to the orbit motion. A value of `0.0` disables smoothing,
/// so there's a 1:1 mapping of input to camera position. A value of `1.0` is infinite
/// smoothing.
/// Defaults to `0.8`.
pub orbit_smoothness: f32,
/// The sensitivity of the panning motion.
/// The sensitivity of the panning motion. A value of `0.0` disables panning.
/// Defaults to `1.0`.
pub pan_sensitivity: f32,
/// How much smoothing is applied to the panning motion. A value of `0.0` disables smoothing,
Expand All @@ -197,6 +197,7 @@ pub struct PanOrbitCamera {
/// Defaults to `0.6`.
pub pan_smoothness: f32,
/// The sensitivity of moving the camera closer or further way using the scroll wheel.
/// A value of `0.0` disables zooming.
/// Defaults to `1.0`.
pub zoom_sensitivity: f32,
/// How much smoothing is applied to the zoom motion. A value of `0.0` disables smoothing,
Expand Down

0 comments on commit f3b44b0

Please sign in to comment.