Demo

This examples showcases all built-in gizmo types and interactions. Try hovering and clicking the center gizmo!

cargo run --example demo 

Setup

Add the following to your Cargo.toml

bevy_mod_gizmos = "0.4.0"

Add this to any file you want to use gizmos in

use bevy_mod_gizmos::*;

Add the plugin to your app

.add_plugin(GizmosPlugin)

For interactive gizmos add the following bundle when spawning your camera

GizmoInteractionCamera::default()

To increase performance I recommend the following in your Cargo.toml

[profile.dev.package."*"]
opt-level = 3

Usage

Draw a single gizmo

draw_gizmo(gizmo);

Draw multiple gizmos

draw_gizmos(vec![gizmo, gizmo, gizmo]);

Draw multiple gizmos and a connecting line

draw_gizmos_with_line(vec![gizmo, gizmo, gizmo]);

Draw a line

draw_line(points, color);

Draw a closed line

draw_closed_line(points, color);

Interactions

Gizmo::new(translation, size, color).on_click(|| println!("Clicked!"))
Gizmo::new(translation, size, color).on_hover(|| println!("Hovered!"))
Gizmo::new(translation, size, color).on_click_system(|time: Res<Time>| ...)
Gizmo::new(translation, size, color).on_hover_system(|query: Query<&Transform>| ...)

Bevy Tracking

License

All code in this repository 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. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are very good reasons to include both.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.