Crate bevy_pancam

bevy_pancam

A 2d-camera plugin for bevy that works with orthographic cameras.

The motivation is that this could be used for something like a map editor for a 2d game.

Controls

Behaves similarly to common online map applications:

• Click and drag to move the camera
• Scroll to zoom
• Keep Keyboard buttons pushed to move the camera

Usage

Add the plugin to your app

App::new()
    .add_plugins((DefaultPlugins, PanCamPlugin::default()))
    .run();

Add the component to an orthographic camera:

commands.spawn(Camera2dBundle::default())
    .insert(PanCam::default());

This is enough to get going with sensible defaults.

Alternatively, set the fields of the PanCam component to customize behavior:

commands.spawn(Camera2dBundle::default())
    .insert(PanCam {
        grab_buttons: vec![MouseButton::Left, MouseButton::Middle], // which buttons should drag the camera
        move_keys: DirectionKeys {      // the keyboard buttons used to move the camera
            up:    vec![KeyCode::KeyQ], // initalize the struct like this or use the provided methods for
            down:  vec![KeyCode::KeyW], // common key combinations
            left:  vec![KeyCode::KeyE],
            right: vec![KeyCode::KeyR],
        },
        speed: 400., // the speed for the keyboard movement
        enabled: true, // when false, controls are disabled. See toggle example.
        zoom_to_cursor: true, // whether to zoom towards the mouse or the center of the screen
        min_scale: 1., // prevent the camera from zooming too far in
        max_scale: Some(40.), // prevent the camera from zooming too far out
    });

See the simple and toggle examples.

Cargo features

• bevy_egui makes pancam cameras not react when the mouse or keyboard focus is on widgets created with bevy_egui

Bevy Version Support

The main branch targets the latest bevy release.

bevy	bevy_pancam
0.14	0.12, 0.13, 0.14, main
0.13	0.11
0.12	0.10
0.11	0.9
0.10	0.8
0.9	0.7,
0.8	0.5, 0.6
0.7	0.3, 0.4
0.6	0.2
0.5	0.1

License

bevy_pancam is dual-licensed under either

• MIT License (./LICENSE-MIT or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

at your option.

Contributions

PRs welcome!

Structs

• DirectionKeys
  Which keys move the camera in particular directions for keyboard movement
• PanCam
  A component that adds panning camera controls to an orthographic camera
• PanCamPlugin
  Plugin that adds the necessary systems for PanCam components to work
• PanCamSystemSet
  System set to allow ordering of PanCamPlugin