Skip to content

aevyrie/bevy_mod_picking

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
February 8, 2022 21:06
March 23, 2023 23:12
src
March 23, 2023 23:12
January 13, 2022 13:39
March 23, 2023 23:15
September 20, 2020 17:09
March 23, 2023 23:15

Mouse Picking for Bevy

crates.io docs.rs CI Bevy tracking

picking_demo

A Bevy plugin for picking, making it easy to interact with meshes in Bevy. Built with bevy_mod_raycast.

Features

  • Mouse intersection coordinates in world space
  • Mouseover and mouseclick events
  • Configurable highlighting
  • Selection state management
  • 3D debug cursor
  • Touch support
  • Common keybindings (Ctrl+A, Ctrl+Click multi-select)

Quickstart

It only takes a few lines to get mouse picking working in your Bevy application using this plugin.

  1. Add the plugin to your app:
.add_plugins(DefaultPickingPlugins);
  1. Mark your camera as the picking source with the PickingCameraBundle component:
.insert(PickingCameraBundle::default());
  1. Add the PickableBundle component to any meshes you want to make pickable:
.insert(PickableBundle::default())

That's all there is to it! Read the docs and look at the provided examples to learn more.

Demo

To run a minimal demo, clone this repository and run:

cargo run --example minimal 

Bevy Version Support

I intend to track the main branch of Bevy. PRs supporting this are welcome!

bevy bevy_mod_picking
0.10 0.12
0.9 0.10, 0.11
0.8 0.8, 0.9
0.7 0.6, 0.7
0.6 0.5
0.5 0.4
0.4 0.3
0.3 0.2

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in bevy_mod_picking by you, shall be licensed as MIT, without any additional terms or conditions.