Skip to content

Commit 39c2770

Browse files
authored
Explain how to disable pan/zoom/orbit by setting sensitivity to 0 (#89)
1 parent 0671900 commit 39c2770

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,15 +180,15 @@ pub struct PanOrbitCamera {
180180
/// Should always be >0 otherwise you'll get stuck at 0.
181181
/// Defaults to `0.05`.
182182
pub zoom_lower_limit: f32,
183-
/// The sensitivity of the orbiting motion.
183+
/// The sensitivity of the orbiting motion. A value of `0.0` disables orbiting.
184184
/// Defaults to `1.0`.
185185
pub orbit_sensitivity: f32,
186186
/// How much smoothing is applied to the orbit motion. A value of `0.0` disables smoothing,
187187
/// so there's a 1:1 mapping of input to camera position. A value of `1.0` is infinite
188188
/// smoothing.
189189
/// Defaults to `0.8`.
190190
pub orbit_smoothness: f32,
191-
/// The sensitivity of the panning motion.
191+
/// The sensitivity of the panning motion. A value of `0.0` disables panning.
192192
/// Defaults to `1.0`.
193193
pub pan_sensitivity: f32,
194194
/// How much smoothing is applied to the panning motion. A value of `0.0` disables smoothing,
@@ -197,6 +197,7 @@ pub struct PanOrbitCamera {
197197
/// Defaults to `0.6`.
198198
pub pan_smoothness: f32,
199199
/// The sensitivity of moving the camera closer or further way using the scroll wheel.
200+
/// A value of `0.0` disables zooming.
200201
/// Defaults to `1.0`.
201202
pub zoom_sensitivity: f32,
202203
/// How much smoothing is applied to the zoom motion. A value of `0.0` disables smoothing,

0 commit comments

Comments
 (0)