use std::f32::consts::PI;
use std::f32::consts::TAU;
use bevy::camera::RenderTarget;
use bevy::input::gestures::PinchGesture;
use bevy::input::mouse::MouseWheel;
use bevy::prelude::*;
use bevy::window::PrimaryWindow;
use bevy::window::WindowRef;
use super::constants::SCROLL_ZOOM_FACTOR;
use super::constants::TOUCH_PINCH_SCALE;
use super::input;
use super::input::MouseKeyTracker;
use super::touch::TouchGestures;
use super::touch::TouchInput;
use super::touch::TouchTracker;
use super::traits::OptionalClamp;
use super::types::ActiveCameraData;
use super::types::ButtonZoomAxis;
use super::types::FocusBoundsShape;
use super::types::ForceUpdate;
use super::types::InitializationState;
use super::types::InputControl;
use super::types::TimeSource;
use super::types::UpsideDownPolicy;
use super::types::ZoomDirection;
use super::util;
#[cfg(feature = "bevy_egui")]
use crate::egui::BlockOnEguiFocus;
#[cfg(feature = "bevy_egui")]
use crate::egui::EguiWantsFocus;
#[derive(SystemSet, Debug, Hash, PartialEq, Eq, Clone)]
pub struct OrbitCamSystemSet;
#[derive(Component, Default, Copy, Clone, Debug, PartialEq, Eq)]
pub(super) struct OrbitDragState {
orientation: CameraOrientation,
}
#[derive(Clone, PartialEq, Eq, Debug, Copy, Default)]
enum CameraOrientation {
#[default]
Normal,
UpsideDown,
}
#[derive(Component, Reflect, Copy, Clone, Debug, PartialEq)]
#[reflect(Component)]
#[require(Camera3d, OrbitDragState)]
pub struct OrbitCam {
pub focus: Vec3,
pub radius: Option<f32>,
pub yaw: Option<f32>,
pub pitch: Option<f32>,
pub target_focus: Vec3,
pub target_yaw: f32,
pub target_pitch: f32,
pub target_radius: f32,
pub yaw_upper_limit: Option<f32>,
pub yaw_lower_limit: Option<f32>,
pub pitch_upper_limit: Option<f32>,
pub pitch_lower_limit: Option<f32>,
pub focus_bounds_origin: Vec3,
pub focus_bounds_shape: Option<FocusBoundsShape>,
pub zoom_upper_limit: Option<f32>,
pub zoom_lower_limit: f32,
pub orbit_sensitivity: f32,
pub orbit_smoothness: f32,
pub pan_sensitivity: f32,
pub pan_smoothness: f32,
pub zoom_sensitivity: f32,
pub zoom_smoothness: f32,
pub button_orbit: MouseButton,
pub button_pan: MouseButton,
pub button_zoom: Option<MouseButton>,
pub button_zoom_axis: ButtonZoomAxis,
pub modifier_orbit: Option<KeyCode>,
pub modifier_pan: Option<KeyCode>,
pub input_control: Option<InputControl>,
pub upside_down_policy: UpsideDownPolicy,
pub initialization: InitializationState,
pub force_update: ForceUpdate,
pub axis: [Vec3; 3],
pub time_source: TimeSource,
}
impl Default for OrbitCam {
fn default() -> Self {
Self {
focus: Vec3::ZERO,
target_focus: Vec3::ZERO,
radius: None,
upside_down_policy: UpsideDownPolicy::Prevent,
orbit_sensitivity: 1.0,
orbit_smoothness: 0.1,
pan_sensitivity: 1.0,
pan_smoothness: 0.02,
zoom_sensitivity: 1.0,
zoom_smoothness: 0.1,
button_orbit: MouseButton::Left,
button_pan: MouseButton::Right,
button_zoom: None,
button_zoom_axis: ButtonZoomAxis::Y,
modifier_orbit: None,
modifier_pan: None,
input_control: Some(InputControl::default()),
yaw: None,
pitch: None,
target_yaw: 0.0,
target_pitch: 0.0,
target_radius: 1.0,
initialization: InitializationState::Pending,
yaw_upper_limit: None,
yaw_lower_limit: None,
pitch_upper_limit: None,
pitch_lower_limit: None,
focus_bounds_origin: Vec3::ZERO,
focus_bounds_shape: None,
zoom_upper_limit: None,
zoom_lower_limit: 0.05,
force_update: ForceUpdate::Idle,
axis: [Vec3::X, Vec3::Y, Vec3::Z],
time_source: TimeSource::Virtual,
}
}
}
impl OrbitCam {
fn clamp_yaw(&self, yaw: f32) -> f32 {
yaw.clamp_optional(self.yaw_lower_limit, self.yaw_upper_limit)
}
fn clamp_pitch(&self, pitch: f32) -> f32 {
pitch.clamp_optional(self.pitch_lower_limit, self.pitch_upper_limit)
}
fn clamp_zoom(&self, zoom: f32) -> f32 {
zoom.clamp_optional(Some(self.zoom_lower_limit), self.zoom_upper_limit)
}
fn clamp_focus(&self, focus: Vec3) -> Vec3 {
let Some(shape) = self.focus_bounds_shape else {
return focus;
};
let origin = self.focus_bounds_origin;
match shape {
FocusBoundsShape::Cuboid(shape) => shape.closest_point(focus - origin) + origin,
FocusBoundsShape::Sphere(shape) => shape.closest_point(focus - origin) + origin,
}
}
}
pub(crate) fn active_viewport_data(
mut active_cam: ResMut<ActiveCameraData>,
mouse_input: Res<ButtonInput<MouseButton>>,
key_input: Res<ButtonInput<KeyCode>>,
pinch_events: MessageReader<PinchGesture>,
scroll_events: MessageReader<MouseWheel>,
touches: Res<Touches>,
primary_windows: Query<&Window, With<PrimaryWindow>>,
other_windows: Query<&Window, Without<PrimaryWindow>>,
orbit_cameras: Query<(Entity, &Camera, &RenderTarget, &OrbitCam)>,
#[cfg(feature = "bevy_egui")] egui_wants_focus: Res<EguiWantsFocus>,
#[cfg(feature = "bevy_egui")] block_on_egui_query: Query<&BlockOnEguiFocus>,
) {
let mut new_resource = ActiveCameraData::default();
let mut max_cam_order = 0;
let mut has_input = false;
for (entity, camera, target, pan_orbit) in &orbit_cameras {
let input_just_activated = input::orbit_just_pressed(pan_orbit, &mouse_input, &key_input)
|| input::pan_just_pressed(pan_orbit, &mouse_input, &key_input)
|| !pinch_events.is_empty()
|| !scroll_events.is_empty()
|| input::button_zoom_just_pressed(pan_orbit, &mouse_input)
|| (touches.iter_just_pressed().count() > 0
&& touches.iter_just_pressed().count() == touches.iter().count());
if input_just_activated && pan_orbit.input_control.is_some() {
has_input = true;
let should_get_input = {
#[cfg(feature = "bevy_egui")]
{
if block_on_egui_query.contains(entity) {
!egui_wants_focus.prev && !egui_wants_focus.curr
} else {
true
}
}
#[cfg(not(feature = "bevy_egui"))]
{
true
}
};
if should_get_input {
if let RenderTarget::Window(win_ref) = target {
let Some(window) = (match win_ref {
WindowRef::Primary => primary_windows.single().ok(),
WindowRef::Entity(entity) => other_windows.get(*entity).ok(),
}) else {
continue;
};
if let Some(input_position) = window.cursor_position().or_else(|| {
touches
.iter_just_pressed()
.collect::<Vec<_>>()
.first()
.map(|touch| touch.position())
}) {
if let Some(Rect { min, max }) = camera.logical_viewport_rect() {
let cursor_in_vp = input_position.x > min.x
&& input_position.x < max.x
&& input_position.y > min.y
&& input_position.y < max.y;
if cursor_in_vp && camera.order >= max_cam_order {
new_resource = ActiveCameraData {
entity: Some(entity),
viewport_size: camera.logical_viewport_size(),
window_size: Some(Vec2::new(window.width(), window.height())),
manual: false,
};
max_cam_order = camera.order;
}
}
}
}
}
}
}
if has_input {
active_cam.set_if_neq(new_resource);
}
}
struct CameraInput {
orbit: Vec2,
pan: Vec2,
scroll_line: f32,
scroll_pixel: f32,
orbit_button_changed: bool,
}
fn initialize_orbit_cam(
pan_orbit: &mut OrbitCam,
transform: &mut Transform,
projection: &mut Projection,
) {
let (yaw, pitch, radius) = util::calculate_from_translation_and_focus(
transform.translation,
pan_orbit.focus,
pan_orbit.axis,
);
let &mut mut yaw = pan_orbit.yaw.get_or_insert(yaw);
let &mut mut pitch = pan_orbit.pitch.get_or_insert(pitch);
let &mut mut radius = pan_orbit.radius.get_or_insert(radius);
let mut focus = pan_orbit.focus;
yaw = pan_orbit.clamp_yaw(yaw);
pitch = pan_orbit.clamp_pitch(pitch);
radius = pan_orbit.clamp_zoom(radius);
focus = pan_orbit.clamp_focus(focus);
pan_orbit.yaw = Some(yaw);
pan_orbit.pitch = Some(pitch);
pan_orbit.radius = Some(radius);
pan_orbit.target_yaw = yaw;
pan_orbit.target_pitch = pitch;
pan_orbit.target_radius = radius;
pan_orbit.target_focus = focus;
util::update_orbit_transform(
yaw,
pitch,
radius,
focus,
transform,
projection,
pan_orbit.axis,
);
pan_orbit.initialization = InitializationState::Complete;
}
fn collect_camera_input(
entity: Entity,
orbit_cam: &OrbitCam,
active_cam: &ActiveCameraData,
mouse_key_tracker: &MouseKeyTracker,
touch_tracker: &TouchTracker,
) -> CameraInput {
let mut orbit = Vec2::ZERO;
let mut pan = Vec2::ZERO;
let mut scroll_line = 0.0;
let mut scroll_pixel = 0.0;
let mut orbit_button_changed = false;
if let Some(input_control) = orbit_cam.input_control
&& active_cam.entity == Some(entity)
{
let zoom_sign = match input_control.zoom {
ZoomDirection::Normal => 1.0,
ZoomDirection::Reversed => -1.0,
};
orbit = mouse_key_tracker.orbit * orbit_cam.orbit_sensitivity;
pan = mouse_key_tracker.pan * orbit_cam.pan_sensitivity;
scroll_line = mouse_key_tracker.scroll_line * zoom_sign * orbit_cam.zoom_sensitivity;
scroll_pixel = mouse_key_tracker.scroll_pixel * zoom_sign * orbit_cam.zoom_sensitivity;
orbit_button_changed = mouse_key_tracker.orbit_button_changed;
if let Some(touch_input) = input_control.touch {
let (touch_orbit, touch_pan, touch_zoom_pixel) = match touch_input {
TouchInput::OneFingerOrbit => match touch_tracker.get_touch_gestures() {
TouchGestures::None => (Vec2::ZERO, Vec2::ZERO, 0.0),
TouchGestures::OneFinger(one_finger_gestures) => {
(one_finger_gestures.motion, Vec2::ZERO, 0.0)
},
TouchGestures::TwoFinger(two_finger_gestures) => (
Vec2::ZERO,
two_finger_gestures.motion,
two_finger_gestures.pinch * TOUCH_PINCH_SCALE,
),
},
TouchInput::TwoFingerOrbit => match touch_tracker.get_touch_gestures() {
TouchGestures::None => (Vec2::ZERO, Vec2::ZERO, 0.0),
TouchGestures::OneFinger(one_finger_gestures) => {
(Vec2::ZERO, one_finger_gestures.motion, 0.0)
},
TouchGestures::TwoFinger(two_finger_gestures) => (
two_finger_gestures.motion,
Vec2::ZERO,
two_finger_gestures.pinch * TOUCH_PINCH_SCALE,
),
},
};
orbit += touch_orbit * orbit_cam.orbit_sensitivity;
pan += touch_pan * orbit_cam.pan_sensitivity;
scroll_pixel += touch_zoom_pixel * zoom_sign * orbit_cam.zoom_sensitivity;
}
}
CameraInput {
orbit,
pan,
scroll_line,
scroll_pixel,
orbit_button_changed,
}
}
fn apply_orbit_input(
orbit: Vec2,
pan_orbit: &mut OrbitCam,
drag_state: OrbitDragState,
window_size: Option<Vec2>,
) -> bool {
if orbit.length_squared() > 0.0 {
if let Some(win_size) = window_size {
let delta_x = {
let delta = orbit.x / win_size.x * TAU;
match drag_state.orientation {
CameraOrientation::UpsideDown => -delta,
CameraOrientation::Normal => delta,
}
};
let delta_y = orbit.y / win_size.y * PI;
pan_orbit.target_yaw -= delta_x;
pan_orbit.target_pitch += delta_y;
return true;
}
}
false
}
fn apply_pan_input(
mut pan: Vec2,
pan_orbit: &mut OrbitCam,
viewport_size: Option<Vec2>,
transform: &Transform,
projection: &Projection,
) -> bool {
if pan.length_squared() > 0.0 {
if let Some(vp_size) = viewport_size {
let mut multiplier = 1.0;
match *projection {
Projection::Perspective(ref p) => {
pan *= Vec2::new(p.fov * p.aspect_ratio, p.fov) / vp_size;
if let Some(radius) = pan_orbit.radius {
multiplier = radius;
}
},
Projection::Orthographic(ref p) => {
pan *= Vec2::new(p.area.width(), p.area.height()) / vp_size;
},
Projection::Custom(_) => todo!(),
}
let right = transform.rotation * pan_orbit.axis[0] * -pan.x;
let up = transform.rotation * pan_orbit.axis[1] * pan.y;
let translation = (right + up) * multiplier;
pan_orbit.target_focus += translation;
return true;
}
}
false
}
fn apply_scroll_input(scroll_line: f32, scroll_pixel: f32, pan_orbit: &mut OrbitCam) -> bool {
if (scroll_line + scroll_pixel).abs() > 0.0 {
let line_delta = -scroll_line * pan_orbit.target_radius * SCROLL_ZOOM_FACTOR;
let pixel_delta = -scroll_pixel * pan_orbit.target_radius * SCROLL_ZOOM_FACTOR;
pan_orbit.target_radius += line_delta + pixel_delta;
pan_orbit.radius = pan_orbit
.radius
.map(|value| pan_orbit.clamp_zoom(value + pixel_delta));
return true;
}
false
}
fn smooth_and_update_transform(
pan_orbit: &mut OrbitCam,
transform: &mut Transform,
projection: &mut Projection,
delta: f32,
) {
let (Some(yaw), Some(pitch), Some(radius)) = (pan_orbit.yaw, pan_orbit.pitch, pan_orbit.radius)
else {
return;
};
let new_yaw =
util::lerp_and_snap_f32(yaw, pan_orbit.target_yaw, pan_orbit.orbit_smoothness, delta);
let new_pitch = util::lerp_and_snap_f32(
pitch,
pan_orbit.target_pitch,
pan_orbit.orbit_smoothness,
delta,
);
let new_radius = util::lerp_and_snap_f32(
radius,
pan_orbit.target_radius,
pan_orbit.zoom_smoothness,
delta,
);
let new_focus = util::lerp_and_snap_position(
pan_orbit.focus,
pan_orbit.target_focus,
pan_orbit.pan_smoothness,
delta,
);
util::update_orbit_transform(
new_yaw,
new_pitch,
new_radius,
new_focus,
transform,
projection,
pan_orbit.axis,
);
pan_orbit.yaw = Some(new_yaw);
pan_orbit.pitch = Some(new_pitch);
pan_orbit.radius = Some(new_radius);
pan_orbit.focus = *new_focus;
pan_orbit.force_update = ForceUpdate::Idle;
}
pub(super) fn orbit_cam(
active_cam: Res<ActiveCameraData>,
mouse_key_tracker: Res<MouseKeyTracker>,
touch_tracker: Res<TouchTracker>,
mut orbit_cameras: Query<(
Entity,
&mut OrbitCam,
&mut OrbitDragState,
&mut Transform,
&mut Projection,
)>,
time_real: Res<Time<Real>>,
time_virt: Res<Time<Virtual>>,
) {
for (entity, mut pan_orbit, mut drag_state, mut transform, mut projection) in &mut orbit_cameras
{
if pan_orbit.initialization == InitializationState::Pending {
initialize_orbit_cam(&mut pan_orbit, &mut transform, &mut projection);
}
let input = collect_camera_input(
entity,
&pan_orbit,
&active_cam,
&mouse_key_tracker,
&touch_tracker,
);
if input.orbit_button_changed {
let world_up = pan_orbit.axis[1];
drag_state.orientation = if transform.up().dot(world_up) < 0.0 {
CameraOrientation::UpsideDown
} else {
CameraOrientation::Normal
};
}
let mut has_moved = apply_orbit_input(
input.orbit,
&mut pan_orbit,
*drag_state,
active_cam.window_size,
);
has_moved |= apply_pan_input(
input.pan,
&mut pan_orbit,
active_cam.viewport_size,
&transform,
&projection,
);
has_moved |= apply_scroll_input(input.scroll_line, input.scroll_pixel, &mut pan_orbit);
pan_orbit.target_yaw = pan_orbit.clamp_yaw(pan_orbit.target_yaw);
pan_orbit.target_pitch = pan_orbit.clamp_pitch(pan_orbit.target_pitch);
pan_orbit.target_radius = pan_orbit.clamp_zoom(pan_orbit.target_radius);
pan_orbit.target_focus = pan_orbit.clamp_focus(pan_orbit.target_focus);
if pan_orbit.upside_down_policy == UpsideDownPolicy::Prevent {
pan_orbit.target_pitch = pan_orbit.target_pitch.clamp(-PI / 2.0, PI / 2.0);
}
let delta = match pan_orbit.time_source {
TimeSource::Real => time_real.delta_secs(),
TimeSource::Virtual => time_virt.delta_secs(),
};
let (Some(yaw), Some(pitch), Some(radius)) =
(pan_orbit.yaw, pan_orbit.pitch, pan_orbit.radius)
else {
continue;
};
#[allow(
clippy::float_cmp,
reason = "lerp_and_snap produces bitwise-identical values on convergence"
)]
let needs_update = has_moved
|| pan_orbit.force_update != ForceUpdate::Idle
|| pan_orbit.target_yaw != yaw
|| pan_orbit.target_pitch != pitch
|| pan_orbit.target_radius != radius
|| pan_orbit.target_focus != pan_orbit.focus;
if needs_update {
smooth_and_update_transform(
&mut pan_orbit,
&mut transform,
&mut projection,
delta,
);
}
}
}