Merge remote-tracking branch 'upstream/main' into bevy_14

.github/workflows/ci.yaml

@@ -1,10 +1,23 @@
 name: CI
 
 on:
+  # Run on pull requests (PR)
   pull_request:
+    types:
+    # New PR
+    - opened
+    # Change pushed to source branch
+    - synchronize
+    # PR reopened
+    - reopened
+    # PR converted from Draft to Ready For Review
+    - ready_for_review
+  # Run on any new change on the main branch (CI)
   push:
     branches:
       - main
+  # Enable manual trigger via GitHub UI
+  workflow_dispatch:
 
 env:
   CARGO_TERM_COLOR: always

CHANGELOG.md

@@ -3,6 +3,35 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.0] - 2024-07-08
+
+### Changed
+
+- Compatible with Bevy 0.14
+- `Lens::lerp()` now takes a `&mut dyn Targetable<T>` instead of `&mut T`.
+  This ensures the lens can skip change detection if needed.
+  `Targetable<T>` conceptually acts like a `Mut<T>`, but allows encapsulating assets too.
+  There should be no other change than the function signature to upgrade custom lenses,
+  because `dyn Targetable<T>` now implements `Defer` and `DeferMut`, so can be used in place of `&mut T`.
+- `AssetTarget::new()` now takes a simple `Mut<Assets<T>>` instead of `ResMut<Assets<T>>`.
+
+### Fixed
+
+- Fixed change detection such that lenses which do not dereference their target
+  do not unconditionally mark that target (component or asset) as changed from the point of view of ECS. (#91)
+
+### Added
+
+- Added `Targetable::target(&self) -> &T`.
+- `dyn Targetable<T>` now implements `Defer` and `DeferMut`, so can be used in place of `&T` and `&mut T`.
+- Added `ComponentTarget::to_mut(&mut self) -> Mut<'_, T>` to "reborrow" the component target as a `Mut<T>`.
+
+## [0.10.0] - 2024-02-27
+
+### Changed
+
+- Compatible with Bevy 0.13
+
 ## [0.9.0] - 2023-11-07
 
 ### Changed

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_tweening"
-version = "0.9.0"
+version = "0.11.0"
 authors = ["François Mockers <mockersf@gmail.com>", "Jerome Humbert <djeedai@gmail.com>"]
 edition = "2021"
 description = "Tweening animation plugin for the Bevy game engine"
@@ -24,11 +24,11 @@ bevy_ui = ["bevy/bevy_ui", "bevy/bevy_render"]
 bevy_text = ["bevy/bevy_text", "bevy/bevy_render", "bevy/bevy_sprite"]
 
 [dependencies]
-interpolation = "0.2"
-bevy = { version = "0.12", default-features = false }
+interpolation = "0.3"
+bevy = { version = "0.14", default-features = false }
 
 [dev-dependencies]
-bevy-inspector-egui = "0.21"
+bevy-inspector-egui = "0.25"
 
 [[example]]
 name = "menu"

README.md

@@ -5,7 +5,7 @@
 [![Crate](https://img.shields.io/crates/v/bevy_tweening.svg)](https://crates.io/crates/bevy_tweening)
 [![Build Status](https://github.com/djeedai/bevy_tweening/actions/workflows/ci.yaml/badge.svg)](https://github.com/djeedai/bevy_tweening/actions/workflows/ci.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/djeedai/bevy_tweening/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/djeedai/bevy_tweening?branch=main)
-[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-v0.12-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
+[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-v0.14-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
 
 Tweening animation plugin for the Bevy game engine.
 
@@ -24,7 +24,7 @@ Add to `Cargo.toml`:
 
 ```toml
 [dependencies]
-bevy_tweening = "0.9"
+bevy_tweening = "0.11"
 ```
 
 This crate supports the following features:
@@ -144,17 +144,17 @@ The naming scheme for predefined lenses is `"<TargetName><FieldName>Lens"`, wher
 
 | Target Component | Animated Field | Lens | Feature |
 |---|---|---|---|
-| [`Transform`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html) | [`translation`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.translation) | [`TransformPositionLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformPositionLens.html) | |
-| | [`rotation`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (`Quat`)¹ | [`TransformRotationLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotationLens.html) | |
-| | [`rotation`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateXLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateXLens.html) | |
-| | [`rotation`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateYLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateYLens.html) | |
-| | [`rotation`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateZLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateZLens.html) | |
-| | [`rotation`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateAxisLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateAxisLens.html) | |
-| | [`scale`](https://docs.rs/bevy/0.12.0/bevy/transform/components/struct.Transform.html#structfield.scale) | [`TransformScaleLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformScaleLens.html) | |
-| [`Sprite`](https://docs.rs/bevy/0.12.0/bevy/sprite/struct.Sprite.html) | [`color`](https://docs.rs/bevy/0.12.0/bevy/sprite/struct.Sprite.html#structfield.color) | [`SpriteColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.SpriteColorLens.html) | `bevy_sprite` |
-| [`Style`](https://docs.rs/bevy/0.12.0/bevy/ui/struct.Style.html) | [`position`](https://docs.rs/bevy/0.12.0/bevy/ui/struct.Style.html#structfield.position) | [`UiPositionLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.UiPositionLens.html) | `bevy_ui` |
-| [`BackgroundColor`](https://docs.rs/bevy/0.12.0/bevy/ui/struct.BackgroundColor.html)| | [`UiBackgroundColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.UiBackgroundColorLens.html) | `bevy_ui` |
-| [`Text`](https://docs.rs/bevy/0.12.0/bevy/text/struct.Text.html) | [`TextStyle::color`](https://docs.rs/bevy/0.12.0/bevy/text/struct.TextStyle.html#structfield.color) | [`TextColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TextColorLens.html) | `bevy_text` |
+| [`Transform`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html) | [`translation`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.translation) | [`TransformPositionLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformPositionLens.html) | |
+| | [`rotation`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (`Quat`)¹ | [`TransformRotationLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotationLens.html) | |
+| | [`rotation`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateXLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateXLens.html) | |
+| | [`rotation`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateYLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateYLens.html) | |
+| | [`rotation`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateZLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateZLens.html) | |
+| | [`rotation`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateAxisLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformRotateAxisLens.html) | |
+| | [`scale`](https://docs.rs/bevy/0.14.0/bevy/transform/components/struct.Transform.html#structfield.scale) | [`TransformScaleLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TransformScaleLens.html) | |
+| [`Sprite`](https://docs.rs/bevy/0.14.0/bevy/sprite/struct.Sprite.html) | [`color`](https://docs.rs/bevy/0.14.0/bevy/sprite/struct.Sprite.html#structfield.color) | [`SpriteColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.SpriteColorLens.html) | `bevy_sprite` |
+| [`Style`](https://docs.rs/bevy/0.14.0/bevy/ui/struct.Style.html) | [`position`](https://docs.rs/bevy/0.14.0/bevy/ui/struct.Style.html#structfield.position) | [`UiPositionLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.UiPositionLens.html) | `bevy_ui` |
+| [`BackgroundColor`](https://docs.rs/bevy/0.14.0/bevy/ui/struct.BackgroundColor.html)| | [`UiBackgroundColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.UiBackgroundColorLens.html) | `bevy_ui` |
+| [`Text`](https://docs.rs/bevy/0.14.0/bevy/text/struct.Text.html) | [`TextStyle::color`](https://docs.rs/bevy/0.14.0/bevy/text/struct.TextStyle.html#structfield.color) | [`TextColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.TextColorLens.html) | `bevy_text` |
 
 ¹ Shortest-path interpolation between two rotations, using `Quat::slerp()`.
 
@@ -168,7 +168,7 @@ Asset animation always requires the `bevy_asset` feature.
 
 | Target Asset | Animated Field | Lens | Feature |
 |---|---|---|---|
-| [`ColorMaterial`](https://docs.rs/bevy/0.12.0/bevy/sprite/struct.ColorMaterial.html) | [`color`](https://docs.rs/bevy/0.12.0/bevy/sprite/struct.ColorMaterial.html#structfield.color) | [`ColorMaterialColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.ColorMaterialColorLens.html) | `bevy_asset` + `bevy_sprite` |
+| [`ColorMaterial`](https://docs.rs/bevy/0.14.0/bevy/sprite/struct.ColorMaterial.html) | [`color`](https://docs.rs/bevy/0.14.0/bevy/sprite/struct.ColorMaterial.html#structfield.color) | [`ColorMaterialColorLens`](https://docs.rs/bevy_tweening/latest/bevy_tweening/lens/struct.ColorMaterialColorLens.html) | `bevy_asset` + `bevy_sprite` |
 
 ## Custom lens
 
@@ -180,8 +180,8 @@ struct MyXAxisLens {
     end: f32,
 }
 
-impl Lens<Tranform> for MyXAxisLens {
-    fn lerp(&self, target: &mut Tranform, ratio: f32) -> f32 {
+impl Lens<Transform> for MyXAxisLens {
+    fn lerp(&mut self, target: &mut Transform, ratio: f32) {
         let start = Vec3::new(self.start, 0., 0.);
         let end = Vec3::new(self.end, 0., 0.);
         target.translation = start + (end - start) * ratio;
@@ -212,7 +212,7 @@ struct MyCustomLens {
 }
 
 impl Lens<MyCustomComponent> for MyCustomLens {
-    fn lerp(&self, target: &mut MyCustomComponent, ratio: f32) -> f32 {
+    fn lerp(&mut self, target: &mut MyCustomComponent, ratio: f32) {
         target.0 = self.start + (self.end - self.start) * ratio;
     }
 }
@@ -226,63 +226,63 @@ The process is similar to custom components, creating a custom lens for the cust
 
 ## Examples
 
-See the [`examples/`](https://github.com/djeedai/bevy_tweening/tree/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples) folder.
+See the [`examples/`](https://github.com/djeedai/bevy_tweening/tree/ef7090cddd19971316ee1583076007f67ead6580/examples) folder.
 
 ### [`menu`](examples/menu.rs)
 
 ```rust
 cargo run --example menu --features="bevy/bevy_winit"
 ```
 
-![menu](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/menu.gif)
+![menu](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/menu.gif)
 
 ### [`sprite_color`](examples/sprite_color.rs)
 
 ```rust
 cargo run --example sprite_color --features="bevy/bevy_winit"
 ```
 
-![sprite_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/sprite_color.gif)
+![sprite_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/sprite_color.gif)
 
 ### [`transform_rotation`](examples/transform_rotation.rs)
 
 ```rust
 cargo run --example transform_rotation --features="bevy/bevy_winit"
 ```
 
-![sprite_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/transform_rotation.gif)
+![sprite_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/transform_rotation.gif)
 
 ### [`transform_translation`](examples/transform_translation.rs)
 
 ```rust
 cargo run --example transform_translation --features="bevy/bevy_winit"
 ```
 
-![sprite_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/transform_translation.gif)
+![sprite_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/transform_translation.gif)
 
 ### [`colormaterial_color`](examples/colormaterial_color.rs)
 
 ```rust
 cargo run --example colormaterial_color --features="bevy/bevy_winit"
 ```
 
-![colormaterial_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/colormaterial_color.gif)
+![colormaterial_color](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/colormaterial_color.gif)
 
 ### [`ui_position`](examples/ui_position.rs)
 
 ```rust
 cargo run --example ui_position --features="bevy/bevy_winit"
 ```
 
-![ui_position](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/ui_position.gif)
+![ui_position](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/ui_position.gif)
 
 ### [`sequence`](examples/sequence.rs)
 
 ```rust
 cargo run --example sequence --features="bevy/bevy_winit"
 ```
 
-![sequence](https://raw.githubusercontent.com/djeedai/bevy_tweening/77b89d9df5a28f66ae6b153e6d24cf0d58042353/examples/sequence.gif)
+![sequence](https://raw.githubusercontent.com/djeedai/bevy_tweening/ef7090cddd19971316ee1583076007f67ead6580/examples/sequence.gif)
 
 ## Ease Functions
 
@@ -327,6 +327,8 @@ Compatibility of `bevy_tweening` versions:
 
 | `bevy_tweening` | `bevy` |
 | :--             | :--    |
+| `0.11`          | `0.14` |
+| `0.10`          | `0.13` |
 | `0.9`           | `0.12` |
 | `0.8`           | `0.11` |
 | `0.7`           | `0.10` |

benchmarks/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_tweening_bench"
-version = "0.9.0"
+version = "0.11.0"
 authors = ["Jerome Humbert <djeedai@gmail.com>"]
 edition = "2021"
 description = "Tweening plugin for Bevy -- Benchmarks"
@@ -14,11 +14,11 @@ include = ["assets", "thirdparty"]
 exclude = ["examples/*.gif"]
 
 [dependencies]
-criterion = { version = "0.4", features = ["html_reports"] }
+criterion = { version = "0.5", features = ["html_reports"] }
 bevy_tweening = { path = "../" }
 
 [dependencies.bevy]
-version = "0.12"
+version = "0.14"
 default-features = false
 features = ["bevy_render", "bevy_sprite", "bevy_text", "bevy_ui"]
 

benchmarks/benches/lens.rs

@@ -1,14 +1,18 @@
 #[macro_use]
 extern crate criterion;
 
-use bevy::prelude::*;
-use bevy_tweening::lens::*;
+use bevy::{
+    color::palettes::css::{BLUE, RED},
+    ecs::component::Tick,
+    prelude::*,
+};
+use bevy_tweening::{lens::*, ComponentTarget};
 use criterion::{black_box, Criterion};
 
 fn text_color_lens(c: &mut Criterion) {
     let mut lens = TextColorLens {
-        start: Color::RED,
-        end: Color::BLUE,
+        start: RED.into(),
+        end: BLUE.into(),
         section: 0,
     };
     let mut text = Text::from_section(
@@ -19,9 +23,18 @@ fn text_color_lens(c: &mut Criterion) {
             color: Color::WHITE,
         },
     )
-    .with_alignment(TextAlignment::Center);
+    .with_justify(JustifyText::Center);
+    let mut added = Tick::new(0);
+    let mut last_changed = Tick::new(0);
+    let mut target = ComponentTarget::new(Mut::new(
+        &mut text,
+        &mut added,
+        &mut last_changed,
+        Tick::new(0),
+        Tick::new(0),
+    ));
     c.bench_function("TextColorLens", |b| {
-        b.iter(|| lens.lerp(&mut text, black_box(0.3)))
+        b.iter(|| lens.lerp(&mut target, black_box(0.3)))
     });
 }
 
@@ -31,8 +44,17 @@ fn transform_position_lens(c: &mut Criterion) {
         end: Vec3::ONE,
     };
     let mut transform = Transform::IDENTITY;
+    let mut added = Tick::new(0);
+    let mut last_changed = Tick::new(0);
+    let mut target = ComponentTarget::new(Mut::new(
+        &mut transform,
+        &mut added,
+        &mut last_changed,
+        Tick::new(0),
+        Tick::new(0),
+    ));
     c.bench_function("TransformPositionLens", |b| {
-        b.iter(|| lens.lerp(&mut transform, black_box(0.3)))
+        b.iter(|| lens.lerp(&mut target, black_box(0.3)))
     });
 }
 
@@ -42,8 +64,17 @@ fn transform_rotation_lens(c: &mut Criterion) {
         end: Quat::from_rotation_x(72.0_f32.to_radians()),
     };
     let mut transform = Transform::IDENTITY;
+    let mut added = Tick::new(0);
+    let mut last_changed = Tick::new(0);
+    let mut target = ComponentTarget::new(Mut::new(
+        &mut transform,
+        &mut added,
+        &mut last_changed,
+        Tick::new(0),
+        Tick::new(0),
+    ));
     c.bench_function("TransformRotationLens", |b| {
-        b.iter(|| lens.lerp(&mut transform, black_box(0.3)))
+        b.iter(|| lens.lerp(&mut target, black_box(0.3)))
     });
 }
 
@@ -53,8 +84,17 @@ fn transform_scale_lens(c: &mut Criterion) {
         end: Vec3::new(1.5, 2.0, 3.0),
     };
     let mut transform = Transform::IDENTITY;
+    let mut added = Tick::new(0);
+    let mut last_changed = Tick::new(0);
+    let mut target = ComponentTarget::new(Mut::new(
+        &mut transform,
+        &mut added,
+        &mut last_changed,
+        Tick::new(0),
+        Tick::new(0),
+    ));
     c.bench_function("TransformScaleLens", |b| {
-        b.iter(|| lens.lerp(&mut transform, black_box(0.3)))
+        b.iter(|| lens.lerp(&mut target, black_box(0.3)))
     });
 }