Skip to content

Write 0.14 new gizmos types release notes #1377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/news/draft-bevy-0.14/axes_gizmo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/news/draft-bevy-0.14/grid_gizmos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/news/draft-bevy-0.14/light_gizmos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion release-content/0.14/release-notes/12430_Gizmo_3d_grids.md

This file was deleted.

39 changes: 39 additions & 0 deletions release-content/0.14/release-notes/New_gizmos_types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Gizmos in Bevy allow to easily draw arbitrary shapes to help debugging or authoring content, but also to visualize specific properties of your scene, such has the AABB of your meshes.

In 0.14, several new gizmos have been added to [`bevy::gizmos`]:

#### Grid Gizmos

New grid gizmo types were added with [`Gizmos::grid_2d`] and [`Gizmos::grid`] to draw a plane grid in either 2D or 3D, alongside [`Gizmos::grid_3d`] to draw a 3D grid.

Each grid type can be skewed, scaled and subdivided along its axis, and you can separately control which outer edges to draw.

![Grid gizmos screenshot](grid_gizmos.png)

#### Coordinate Axes Gizmo

The new [`Gizmos::axes`] add a simple way to show the position, orientation and scale of any object from its [`Transform`] plus a base size.
The size of each axis arrow is proportional to the corresponding axis scale in the provided [`Transform`].

![Axes gizmo screenshot](axes_gizmo.png)

#### Light Gizmos

The new [`ShowLightGizmo`] component implements a retained gizmo to visualize lights for [`SpotLight`], [`PointLight`] and [`DirectionalLight`].
Most light properties are visually represented by the gizmos, and the gizmo color can be set to match the light instance or use a variety of other behaviors.

Similar to other retained gizmos, [`ShowLightGizmo`] can be configured per-instance or globally with [`LightGizmoConfigGroup`].

![Light gizmos screenshot](light_gizmos.png)

[`bevy::gizmos`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/index.html
[`Gizmos::grid_2d`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/prelude/struct.Gizmos.html#method.grid_2d
[`Gizmos::grid`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/prelude/struct.Gizmos.html#method.grid
[`Gizmos::grid_3d`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/prelude/struct.Gizmos.html#method.grid_3d
[`Gizmos::axes`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/prelude/struct.Gizmos.html#method.axes
[`Transform`]: https://docs.rs/bevy/0.14.0/bevy/prelude/struct.Transform.html
[`ShowLightGizmo`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/light/struct.ShowLightGizmo.html
[`SpotLight`]: https://docs.rs/bevy/0.14.0/bevy/pbr/struct.SpotLight.html
[`PointLight`]: https://docs.rs/bevy/0.14.0/bevy/pbr/struct.PointLight.html
[`DirectionalLight`]: https://docs.rs/bevy/0.14.0/bevy/pbr/struct.DirectionalLight.html
[`LightGizmoConfigGroup`]: https://docs.rs/bevy/0.14.0/bevy/gizmos/light/struct.LightGizmoConfigGroup.html
18 changes: 3 additions & 15 deletions release-content/0.14/release-notes/_release-notes.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,10 @@ url = "https://github.com/bevyengine/bevy/pull/11906"
file_name = "11906_Run_the_multithreaded_executor_at_the_end_of_each_system_t.md"

[[release_notes]]
title = "Add coordinate axes gizmo"
authors = ["@mweatherley"]
title = "New gizmos types"
authors = ["@mweatherley", "@Kanabenki", "@MrGVSV", "@solis-lumine-vorago","@alice-i-cecile"]
url = "https://github.com/bevyengine/bevy/pull/12211"
file_name = "12211_Add_coordinate_axes_gizmo.md"

[[release_notes]]
title = "Add basic light gizmos"
authors = ["@Kanabenki", "@MrGVSV"]
url = "https://github.com/bevyengine/bevy/pull/12228"
file_name = "12228_Add_basic_light_gizmos.md"
file_name = "New_gizmos_types.md"

[[release_notes]]
title = "Decouple `BackgroundColor` from `UiImage`"
Expand Down Expand Up @@ -70,12 +64,6 @@ authors = ["@Jondolf", "@IQuick143", "@tguichaoua"]
url = "https://github.com/bevyengine/bevy/pull/11658"
file_name = "11658_Add_Rotation2d.md"

[[release_notes]]
title = "Gizmo 3d grids"
authors = ["@lynn-lumen", "@alice-i-cecile"]
url = "https://github.com/bevyengine/bevy/pull/12430"
file_name = "12430_Gizmo_3d_grids.md"

[[release_notes]]
title = "Alignment API for Transforms"
authors = ["@mweatherley"]
Expand Down