|
5 | 5 | [](https://crates.io/crates/bevy_tweening) |
6 | 6 | [](https://github.com/djeedai/bevy_tweening/actions/workflows/ci.yaml) |
7 | 7 | [](https://coveralls.io/github/djeedai/bevy_tweening?branch=main) |
8 | | -[](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking) |
| 8 | +[](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking) |
9 | 9 |
|
10 | 10 | Tweening animation plugin for the Bevy game engine. |
11 | 11 |
|
@@ -133,20 +133,20 @@ The naming scheme for predefined lenses is `"<TargetName><FieldName>Lens"`, wher |
133 | 133 |
|
134 | 134 | | Target | Animated Field | Lens | Feature | |
135 | 135 | |---|---|---|---| |
136 | | -| [`Transform`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html) | [`translation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.translation) | [`TransformPositionLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformPositionLens.html) | (builtin) | |
137 | | -| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (`Quat`)¹ | [`TransformRotationLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformRotationLens.html) | (builtin) | |
138 | | -| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateXLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformRotateXLens.html) | (builtin) | |
139 | | -| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateYLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformRotateYLens.html) | (builtin) | |
140 | | -| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateZLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformRotateZLens.html) | (builtin) | |
141 | | -| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateAxisLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformRotateAxisLens.html) | (builtin) | |
142 | | -| | [`scale`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.scale) | [`TransformScaleLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TransformScaleLens.html) | (builtin) | |
143 | | -| [`Sprite`](https://docs.rs/bevy/0.17/bevy/sprite/struct.Sprite.html) | [`color`](https://docs.rs/bevy/0.17/bevy/sprite/struct.Sprite.html#structfield.color) | [`SpriteColorLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.SpriteColorLens.html) | `bevy_sprite` | |
144 | | -| [`Node`](https://docs.rs/bevy/0.17/bevy/ui/struct.Node.html) | [`position`](https://docs.rs/bevy/0.17/bevy/ui/struct.Node.html) | [`UiPositionLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.UiPositionLens.html) | `bevy_ui` | |
145 | | -| [`BackgroundColor`](https://docs.rs/bevy/0.17/bevy/ui/struct.BackgroundColor.html) | | [`UiBackgroundColorLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.UiBackgroundColorLens.html) | `bevy_ui` | |
146 | | -| [`TextColor`](https://docs.rs/bevy/0.17/bevy/text/struct.TextColor.html) | | [`TextColorLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.TextColorLens.html) | `bevy_text` | |
147 | | -| [`ColorMaterial`](https://docs.rs/bevy/0.17/bevy/sprite/struct.ColorMaterial.html) | [`color`](https://docs.rs/bevy/0.17/bevy/sprite/struct.ColorMaterial.html#structfield.color) | [`ColorMaterialColorLens`](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/struct.ColorMaterialColorLens.html) | `bevy_sprite` | |
148 | | - |
149 | | -There are two ways to interpolate rotations. See the [comparison of rotation lenses](https://docs.rs/bevy_tweening/048a8b6b08ce62dfe1b2692d293dad2661a0027c/bevy_tweening/lens/index.html#rotations) for details: |
| 136 | +| [`Transform`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html) | [`translation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.translation) | [`TransformPositionLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformPositionLens.html) | (builtin) | |
| 137 | +| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (`Quat`)¹ | [`TransformRotationLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformRotationLens.html) | (builtin) | |
| 138 | +| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateXLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformRotateXLens.html) | (builtin) | |
| 139 | +| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateYLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformRotateYLens.html) | (builtin) | |
| 140 | +| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateZLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformRotateZLens.html) | (builtin) | |
| 141 | +| | [`rotation`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.rotation) (angle)² | [`TransformRotateAxisLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformRotateAxisLens.html) | (builtin) | |
| 142 | +| | [`scale`](https://docs.rs/bevy/0.17/bevy/transform/components/struct.Transform.html#structfield.scale) | [`TransformScaleLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TransformScaleLens.html) | (builtin) | |
| 143 | +| [`Sprite`](https://docs.rs/bevy/0.17/bevy/sprite/struct.Sprite.html) | [`color`](https://docs.rs/bevy/0.17/bevy/sprite/struct.Sprite.html#structfield.color) | [`SpriteColorLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.SpriteColorLens.html) | `bevy_sprite` | |
| 144 | +| [`Node`](https://docs.rs/bevy/0.17/bevy/ui/struct.Node.html) | [`position`](https://docs.rs/bevy/0.17/bevy/ui/struct.Node.html) | [`UiPositionLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.UiPositionLens.html) | `bevy_ui` | |
| 145 | +| [`BackgroundColor`](https://docs.rs/bevy/0.17/bevy/ui/struct.BackgroundColor.html) | | [`UiBackgroundColorLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.UiBackgroundColorLens.html) | `bevy_ui` | |
| 146 | +| [`TextColor`](https://docs.rs/bevy/0.17/bevy/text/struct.TextColor.html) | | [`TextColorLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.TextColorLens.html) | `bevy_text` | |
| 147 | +| [`ColorMaterial`](https://docs.rs/bevy/0.17/bevy/sprite/struct.ColorMaterial.html) | [`color`](https://docs.rs/bevy/0.17/bevy/sprite/struct.ColorMaterial.html#structfield.color) | [`ColorMaterialColorLens`](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/struct.ColorMaterialColorLens.html) | `bevy_sprite` | |
| 148 | + |
| 149 | +There are two ways to interpolate rotations. See the [comparison of rotation lenses](https://docs.rs/bevy_tweening/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/bevy_tweening/lens/index.html#rotations) for details: |
150 | 150 |
|
151 | 151 | - ¹ Shortest-path interpolation between two rotations, using `Quat::slerp()`. |
152 | 152 | - ² Angle-based interpolation, valid for rotations over ½ turn. |
@@ -205,63 +205,63 @@ Unlike previous versions of 🍃 Bevy Tweening, there's no other setup to animat |
205 | 205 |
|
206 | 206 | ## Examples |
207 | 207 |
|
208 | | -See the [`examples/`](https://github.com/djeedai/bevy_tweening/tree/048a8b6b08ce62dfe1b2692d293dad2661a0027c/examples) folder. |
| 208 | +See the [`examples/`](https://github.com/djeedai/bevy_tweening/tree/a6712d5a7886d7d3b2e71ebff8ad37f8f9311524/examples) folder. |
209 | 209 |
|
210 | 210 | ### [`menu`](examples/menu.rs) |
211 | 211 |
|
212 | 212 | ```rust |
213 | 213 | cargo run --example menu --features="bevy/bevy_winit" |
214 | 214 | ``` |
215 | 215 |
|
216 | | - |
| 216 | + |
217 | 217 |
|
218 | 218 | ### [`sprite_color`](examples/sprite_color.rs) |
219 | 219 |
|
220 | 220 | ```rust |
221 | 221 | cargo run --example sprite_color --features="bevy/bevy_winit" |
222 | 222 | ``` |
223 | 223 |
|
224 | | - |
| 224 | + |
225 | 225 |
|
226 | 226 | ### [`transform_rotation`](examples/transform_rotation.rs) |
227 | 227 |
|
228 | 228 | ```rust |
229 | 229 | cargo run --example transform_rotation --features="bevy/bevy_winit" |
230 | 230 | ``` |
231 | 231 |
|
232 | | - |
| 232 | + |
233 | 233 |
|
234 | 234 | ### [`transform_translation`](examples/transform_translation.rs) |
235 | 235 |
|
236 | 236 | ```rust |
237 | 237 | cargo run --example transform_translation --features="bevy/bevy_winit" |
238 | 238 | ``` |
239 | 239 |
|
240 | | - |
| 240 | + |
241 | 241 |
|
242 | 242 | ### [`colormaterial_color`](examples/colormaterial_color.rs) |
243 | 243 |
|
244 | 244 | ```rust |
245 | 245 | cargo run --example colormaterial_color --features="bevy/bevy_winit" |
246 | 246 | ``` |
247 | 247 |
|
248 | | - |
| 248 | + |
249 | 249 |
|
250 | 250 | ### [`ui_position`](examples/ui_position.rs) |
251 | 251 |
|
252 | 252 | ```rust |
253 | 253 | cargo run --example ui_position --features="bevy/bevy_winit" |
254 | 254 | ``` |
255 | 255 |
|
256 | | - |
| 256 | + |
257 | 257 |
|
258 | 258 | ### [`sequence`](examples/sequence.rs) |
259 | 259 |
|
260 | 260 | ```rust |
261 | 261 | cargo run --example sequence --features="bevy/bevy_winit" |
262 | 262 | ``` |
263 | 263 |
|
264 | | - |
| 264 | + |
265 | 265 |
|
266 | 266 | ## Compatible Bevy versions |
267 | 267 |
|
|
0 commit comments