#![warn(missing_docs)]
#![doc = include_str!("../README.md")]
use bevy::input::mouse::{MouseMotion, MouseScrollUnit, MouseWheel};
use bevy::prelude::*;
use bevy::render::camera::RenderTarget;
use bevy::window::{PrimaryWindow, WindowRef};
#[cfg(feature = "bevy_egui")]
use bevy_egui::EguiSet;
#[cfg(feature = "bevy_egui")]
pub use egui::EguiWantsFocus;
use std::f32::consts::{PI, TAU};
#[cfg(feature = "bevy_egui")]
mod egui;
mod util;
pub struct PanOrbitCameraPlugin;
impl Plugin for PanOrbitCameraPlugin {
fn build(&self, app: &mut App) {
app.insert_resource(ActiveCameraData::default())
.add_systems(
Update,
(
active_viewport_data
.run_if(|active_cam: Res<ActiveCameraData>| !active_cam.manual),
pan_orbit_camera,
)
.chain()
.in_set(PanOrbitCameraSystemSet),
);
#[cfg(feature = "bevy_egui")]
{
app.init_resource::<EguiWantsFocus>()
.add_systems(
Update,
egui::check_egui_wants_focus
.after(EguiSet::InitContexts)
.before(PanOrbitCameraSystemSet),
)
.configure_sets(
Update,
PanOrbitCameraSystemSet.run_if(resource_equals(EguiWantsFocus {
prev: false,
curr: false,
})),
);
}
}
}
#[derive(SystemSet, Debug, Hash, PartialEq, Eq, Clone)]
pub struct PanOrbitCameraSystemSet;
#[derive(Component, Copy, Clone, Debug, PartialEq)]
pub struct PanOrbitCamera {
pub focus: Vec3,
pub radius: Option<f32>,
pub scale: Option<f32>,
pub alpha: Option<f32>,
pub beta: Option<f32>,
pub target_focus: Vec3,
pub target_alpha: f32,
pub target_beta: f32,
pub target_radius: f32,
pub target_scale: f32,
pub alpha_upper_limit: Option<f32>,
pub alpha_lower_limit: Option<f32>,
pub beta_upper_limit: Option<f32>,
pub beta_lower_limit: Option<f32>,
pub zoom_upper_limit: Option<f32>,
pub zoom_lower_limit: Option<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 modifier_orbit: Option<KeyCode>,
pub modifier_pan: Option<KeyCode>,
pub reversed_zoom: bool,
pub is_upside_down: bool,
pub allow_upside_down: bool,
pub enabled: bool,
pub initialized: bool,
pub force_update: bool,
}
impl Default for PanOrbitCamera {
fn default() -> Self {
PanOrbitCamera {
focus: Vec3::ZERO,
target_focus: Vec3::ZERO,
radius: None,
is_upside_down: false,
allow_upside_down: false,
orbit_sensitivity: 1.0,
orbit_smoothness: 0.8,
pan_sensitivity: 1.0,
pan_smoothness: 0.6,
zoom_sensitivity: 1.0,
zoom_smoothness: 0.8,
button_orbit: MouseButton::Left,
button_pan: MouseButton::Right,
modifier_orbit: None,
modifier_pan: None,
reversed_zoom: false,
enabled: true,
alpha: None,
beta: None,
scale: None,
target_alpha: 0.0,
target_beta: 0.0,
target_radius: 1.0,
target_scale: 1.0,
initialized: false,
alpha_upper_limit: None,
alpha_lower_limit: None,
beta_upper_limit: None,
beta_lower_limit: None,
zoom_upper_limit: None,
zoom_lower_limit: None,
force_update: false,
}
}
}
#[derive(Resource, Default, Debug, PartialEq)]
pub struct ActiveCameraData {
pub entity: Option<Entity>,
pub viewport_size: Option<Vec2>,
pub window_size: Option<Vec2>,
pub manual: bool,
}
fn active_viewport_data(
mut active_cam: ResMut<ActiveCameraData>,
mouse_input: Res<Input<MouseButton>>,
key_input: Res<Input<KeyCode>>,
scroll_events: EventReader<MouseWheel>,
primary_windows: Query<&Window, With<PrimaryWindow>>,
other_windows: Query<&Window, Without<PrimaryWindow>>,
orbit_cameras: Query<(Entity, &Camera, &PanOrbitCamera)>,
) {
let mut new_resource = ActiveCameraData::default();
let mut max_cam_order = 0;
let mut has_input = false;
for (entity, camera, pan_orbit) in orbit_cameras.iter() {
let input_just_activated = util::orbit_just_pressed(pan_orbit, &mouse_input, &key_input)
|| util::pan_just_pressed(pan_orbit, &mouse_input, &key_input)
|| !scroll_events.is_empty();
if input_just_activated {
has_input = true;
if let RenderTarget::Window(win_ref) = camera.target {
let window = match win_ref {
WindowRef::Primary => primary_windows
.get_single()
.expect("Must exist, since the camera is referencing it"),
WindowRef::Entity(entity) => other_windows
.get(entity)
.expect("Must exist, since the camera is referencing it"),
};
if let Some(cursor_pos) = window.cursor_position() {
if let Some(Rect { min, max }) = camera.logical_viewport_rect() {
let cursor_in_vp = cursor_pos.x > min.x
&& cursor_pos.x < max.x
&& cursor_pos.y > min.y
&& cursor_pos.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);
}
}
fn pan_orbit_camera(
active_cam: Res<ActiveCameraData>,
mouse_input: Res<Input<MouseButton>>,
key_input: Res<Input<KeyCode>>,
mut mouse_motion: EventReader<MouseMotion>,
mut scroll_events: EventReader<MouseWheel>,
mut orbit_cameras: Query<(Entity, &mut PanOrbitCamera, &mut Transform, &mut Projection)>,
) {
let mouse_delta = mouse_motion.read().map(|event| event.delta).sum::<Vec2>();
for (entity, mut pan_orbit, mut transform, mut projection) in orbit_cameras.iter_mut() {
let apply_zoom_limits = {
let zoom_upper_limit = pan_orbit.zoom_upper_limit;
let zoom_lower_limit = pan_orbit.zoom_lower_limit;
move |zoom: f32| util::apply_limits(zoom, zoom_upper_limit, zoom_lower_limit).max(0.05)
};
let apply_alpha_limits = {
let alpha_upper_limit = pan_orbit.alpha_upper_limit;
let alpha_lower_limit = pan_orbit.alpha_lower_limit;
move |alpha: f32| util::apply_limits(alpha, alpha_upper_limit, alpha_lower_limit)
};
let apply_beta_limits = {
let beta_upper_limit = pan_orbit.beta_upper_limit;
let beta_lower_limit = pan_orbit.beta_lower_limit;
move |beta: f32| util::apply_limits(beta, beta_upper_limit, beta_lower_limit)
};
if !pan_orbit.initialized {
let (alpha, beta, radius) =
util::calculate_from_translation_and_focus(transform.translation, pan_orbit.focus);
let &mut mut alpha = pan_orbit.alpha.get_or_insert(alpha);
let &mut mut beta = pan_orbit.beta.get_or_insert(beta);
let &mut mut radius = pan_orbit.radius.get_or_insert(radius);
alpha = apply_alpha_limits(alpha);
beta = apply_beta_limits(beta);
radius = apply_zoom_limits(radius);
pan_orbit.alpha = Some(alpha);
pan_orbit.beta = Some(beta);
pan_orbit.radius = Some(radius);
pan_orbit.target_alpha = alpha;
pan_orbit.target_beta = beta;
pan_orbit.target_radius = radius;
pan_orbit.target_focus = pan_orbit.focus;
if let Projection::Orthographic(ref mut p) = *projection {
if pan_orbit.scale.is_none() {
pan_orbit.scale = Some(p.scale);
}
p.scale = apply_zoom_limits(pan_orbit.scale.expect("Just set to Some above"));
pan_orbit.target_scale = p.scale;
}
util::update_orbit_transform(alpha, beta, radius, pan_orbit.focus, &mut transform);
pan_orbit.initialized = true;
}
let mut pan = Vec2::ZERO;
let mut rotation_move = Vec2::ZERO;
let mut scroll_line = 0.0;
let mut scroll_pixel = 0.0;
let mut orbit_button_changed = false;
if pan_orbit.enabled && active_cam.entity == Some(entity) {
if util::orbit_pressed(&pan_orbit, &mouse_input, &key_input) {
rotation_move += mouse_delta * pan_orbit.orbit_sensitivity;
} else if util::pan_pressed(&pan_orbit, &mouse_input, &key_input) {
pan += mouse_delta * pan_orbit.pan_sensitivity;
}
for ev in scroll_events.read() {
let direction = match pan_orbit.reversed_zoom {
true => -1.0,
false => 1.0,
};
let delta_scroll = ev.y * direction * pan_orbit.zoom_sensitivity;
match ev.unit {
MouseScrollUnit::Line => {
scroll_line += delta_scroll;
}
MouseScrollUnit::Pixel => {
scroll_pixel += delta_scroll * 0.005;
}
};
}
if util::orbit_just_pressed(&pan_orbit, &mouse_input, &key_input)
|| util::orbit_just_released(&pan_orbit, &mouse_input, &key_input)
{
orbit_button_changed = true;
}
}
if orbit_button_changed {
let wrapped_beta = (pan_orbit.target_beta % TAU).abs();
pan_orbit.is_upside_down = wrapped_beta > TAU / 4.0 && wrapped_beta < 3.0 * TAU / 4.0;
}
let mut has_moved = false;
if rotation_move.length_squared() > 0.0 {
if let Some(win_size) = active_cam.window_size {
let delta_x = {
let delta = rotation_move.x / win_size.x * PI * 2.0;
if pan_orbit.is_upside_down {
-delta
} else {
delta
}
};
let delta_y = rotation_move.y / win_size.y * PI;
pan_orbit.target_alpha -= delta_x;
pan_orbit.target_beta += delta_y;
has_moved = true;
}
} else if pan.length_squared() > 0.0 {
if let Some(vp_size) = active_cam.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;
}
}
let right = transform.rotation * Vec3::X * -pan.x;
let up = transform.rotation * Vec3::Y * pan.y;
let translation = (right + up) * multiplier;
pan_orbit.target_focus += translation;
has_moved = true;
}
} else if (scroll_line + scroll_pixel).abs() > 0.0 {
let pan_orbit = &mut *pan_orbit;
let (target_value, value) = if let Projection::Orthographic(_) = *projection {
(&mut pan_orbit.target_scale, &mut pan_orbit.scale)
} else {
(&mut pan_orbit.target_radius, &mut pan_orbit.radius)
};
let line_delta = -scroll_line * (*target_value) * 0.2;
let pixel_delta = -scroll_pixel * (*target_value) * 0.2;
*target_value += line_delta + pixel_delta;
*value = value.map(|value| apply_zoom_limits(value + pixel_delta));
has_moved = true;
}
pan_orbit.target_alpha = apply_alpha_limits(pan_orbit.target_alpha);
pan_orbit.target_beta = apply_beta_limits(pan_orbit.target_beta);
pan_orbit.target_radius = apply_zoom_limits(pan_orbit.target_radius);
pan_orbit.target_scale = apply_zoom_limits(pan_orbit.target_scale);
if !pan_orbit.allow_upside_down {
pan_orbit.target_beta =
util::apply_limits(pan_orbit.target_beta, Some(PI / 2.0), Some(-PI / 2.0));
}
if let (Some(alpha), Some(beta), Some(radius)) =
(pan_orbit.alpha, pan_orbit.beta, pan_orbit.radius)
{
if has_moved
|| pan_orbit.target_alpha != alpha
|| pan_orbit.target_beta != beta
|| pan_orbit.target_radius != radius
|| pan_orbit.target_focus != pan_orbit.focus
|| Some(pan_orbit.target_scale) != pan_orbit.scale
|| pan_orbit.force_update
{
let new_alpha = util::lerp_and_snap_f32(
alpha,
pan_orbit.target_alpha,
pan_orbit.orbit_smoothness,
);
let new_beta = util::lerp_and_snap_f32(
beta,
pan_orbit.target_beta,
pan_orbit.orbit_smoothness,
);
let new_radius = util::lerp_and_snap_f32(
radius,
pan_orbit.target_radius,
pan_orbit.zoom_smoothness,
);
let new_scale = util::lerp_and_snap_f32(
pan_orbit.scale.unwrap_or(pan_orbit.target_scale),
pan_orbit.target_scale,
pan_orbit.zoom_smoothness,
);
let new_focus = util::lerp_and_snap_vec3(
pan_orbit.focus,
pan_orbit.target_focus,
pan_orbit.pan_smoothness,
);
if let Projection::Orthographic(ref mut p) = *projection {
p.scale = new_scale;
}
util::update_orbit_transform(
new_alpha,
new_beta,
new_radius,
new_focus,
&mut transform,
);
pan_orbit.alpha = Some(new_alpha);
pan_orbit.beta = Some(new_beta);
pan_orbit.radius = Some(new_radius);
pan_orbit.scale = Some(new_scale);
pan_orbit.focus = new_focus;
pan_orbit.force_update = false;
}
}
}
}