Skip to main content

OrbitControls

Struct OrbitControls 

Source
pub struct OrbitControls {
Show 13 fields pub enable_damping: bool, pub damping_factor: f32, pub zoom_damping_factor: f32, pub enable_zoom: bool, pub zoom_speed: f32, pub enable_rotate: bool, pub rotate_speed: f32, pub enable_pan: bool, pub pan_speed: f32, pub min_distance: f32, pub max_distance: f32, pub min_polar_angle: f32, pub max_polar_angle: f32, /* private fields */
}
Expand description

Mouse-based orbit camera controller.

Allows users to rotate, zoom, and pan the camera around a target point using mouse input.

§Controls

InputAction
Left Mouse + DragRotate camera around target
Right Mouse + DragPan camera and target
Scroll WheelZoom in/out

§Features

  • Smooth damping for natural feel
  • Configurable rotation/zoom/pan speeds
  • Distance and angle constraints

§Example

let mut orbit = OrbitControls::new(
    Vec3::new(0.0, 5.0, 10.0),  // camera position
    Vec3::ZERO,                   // look-at target
);

// Customize settings
orbit.enable_damping = true;
orbit.rotate_speed = 0.5;
orbit.min_distance = 2.0;
orbit.max_distance = 50.0;

// In update loop
orbit.update(&mut camera_transform, &input, fov, dt);

Fields§

§enable_damping: bool

Enable smooth damping for rotation and zoom.

§damping_factor: f32

Damping factor for rotation (0.0 = instant, 1.0 = no movement).

§zoom_damping_factor: f32

Damping factor for zoom (0.0 = instant, 1.0 = no movement).

§enable_zoom: bool

Enable mouse wheel zoom.

§zoom_speed: f32

Zoom speed multiplier.

§enable_rotate: bool

Enable left-click rotation.

§rotate_speed: f32

Rotation speed multiplier.

§enable_pan: bool

Enable right-click panning.

§pan_speed: f32

Pan speed multiplier.

§min_distance: f32

Minimum distance from target (zoom limit).

§max_distance: f32

Maximum distance from target (zoom limit).

§min_polar_angle: f32

Minimum polar angle in radians (0 = top-down view).

§max_polar_angle: f32

Maximum polar angle in radians (π = bottom-up view).

Implementations§

Source§

impl OrbitControls

Source

pub fn new(camera_pos: Vec3, target: Vec3) -> OrbitControls

Creates a new orbit controller.

§Arguments
  • camera_pos - Initial camera world position
  • target - Point to orbit around (look-at target)
Source

pub fn update( &mut self, transform: &mut Transform, input: &Input, fov: f32, dt: f32, )

Updates the camera transform based on input.

Call this once per frame in your update loop.

§Arguments
  • transform - Camera’s transform component to modify
  • input - Current input state
  • fov - Camera field of view in radians (for pan scaling)
  • dt - Delta time in seconds
Source

pub fn set_target(&mut self, target: Vec3)

Sets the orbit target point.

The camera will orbit around this point.

Source

pub fn set_position(&mut self, position: Vec3)

Sets the camera position directly.

Updates internal spherical coordinates to match the new position while keeping the current target.

Source

pub fn fit(&mut self, bbox: &BoundingBox)

Frames the camera to fit a pre-computed bounding box.

Positions the camera so the entire bounding box is visible, looking at its center from an appropriate distance.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,