Merge pull request #265 from Nilirad/required-components

* Rename `Path` to `Shape` `Path` will be the "driving concept" component for Required Components. The name does not fit well, so I changed it to `Shape`. * Add required components for `Shape` * Make examples use Required Components * Update example in `README.md` * Make tests use Required Components * Deprecate ShapeBundle and remove it from prelude * Update doc comments * Include fill and stroke data (stub) into `Shape` component * Add `ShapeBuilder` * Make examples use ShapeBuilder * Remove `GeometryBuilder` * Document missing items * Update `PathBuilder` - Added `fill` and `stroke` fields - Added `fill` and `stroke` setters - Improved builder pattern by returning `Self` in methods * Remove `ShapePath` `ShapePath` is no longer functional after including fill and stroke data into `Shape`. Use `ShapeBuilder` or `PathBuilder` instead. * Remove `Component` impl for `Fill` and `Stroke` * Update `CHANGELOG.md` * Update `README.md` * Remove note from `dynamic_shape` example
Nilirad · Dec 11, 2024 · 7dd478c · 7dd478c
2 parents f16e09f + defbb12
commit 7dd478c
Show file tree

Hide file tree

Showing 14 changed files with 457 additions and 340 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,22 @@
 # Changelog
 
+## 0.14.0
+
+This version uses Bevy's **Required Components**,
+therefore many items have been changed.
+Examples may help migration.
+
+- `Path` component renamed to `Shape`. It is now the central component of a shape entity.
+- `Shape` now includes fill and stroke data.
+- `Fill` and `Stroke` are no longer `Component`s.
+- Deprecated `ShapeBundle` in favor of the `Shape` component.
+- `prelude` no longer exports `ShapeBundle`.
+- Added `ShapeBuilder`: works similarly to `GeometryBuilder`
+- Removed `GeometryBuilder` and `ShapePath`.
+- `PathBuilder` now allows chaining methods.
+
 ## 0.13.0
-- Support for Bevy 0.15.0-rc.3.
+- Support for Bevy 0.15.0.
 - `Rectangle` now supports border radii (see `rectangle.rs` example).
 - Removed deprecated `SpatialBundle` from `ShapeBundle`: `Transform` and `Visibility` are now added separately.
 

diff --git a/README.md b/README.md
@@ -44,14 +44,12 @@ fn setup_system(mut commands: Commands) {
     };
 
     commands.spawn((Camera2d, Msaa::Sample4));
-    commands.spawn((
-        ShapeBundle {
-            path: GeometryBuilder::build_as(&shape),
-            ..default()
-        },
-        Fill::color(DARK_CYAN),
-        Stroke::new(BLACK, 10.0),
-    ));
+    commands.spawn(
+        ShapeBuilder::with(&shape)
+            .fill(DARK_CYAN)
+            .stroke((BLACK, 10.0))
+            .build(),
+    );
 }
 ```
 

diff --git a/examples/dynamic_shape.rs b/examples/dynamic_shape.rs
@@ -7,8 +7,7 @@ fn main() {
     App::new()
         .add_plugins((DefaultPlugins, ShapePlugin))
         .add_systems(Startup, setup_system)
-        .add_systems(Update, change_draw_mode_system)
-        .add_systems(Update, change_number_of_sides)
+        .add_systems(Update, redraw_shape)
         .add_systems(Update, rotate_shape_system)
         .run();
 }
@@ -24,28 +23,22 @@ fn rotate_shape_system(mut query: Query<&mut Transform, With<ExampleShape>>, tim
     }
 }
 
-fn change_draw_mode_system(mut query: Query<(&mut Fill, &mut Stroke)>, time: Res<Time>) {
+fn redraw_shape(mut query: Query<&mut Shape, With<ExampleShape>>, time: Res<Time>) {
     let hue = (time.elapsed_secs_f64() * 50.0) % 360.0;
+    let color = Color::hsl(hue as f32, 1.0, 0.5);
     let outline_width = 2.0 + time.elapsed_secs_f64().sin().abs() * 10.0;
-
-    for (mut fill_mode, mut stroke_mode) in query.iter_mut() {
-        fill_mode.color = Color::hsl(hue as f32, 1.0, 0.5);
-        stroke_mode.options.line_width = outline_width as f32;
-    }
-}
-
-fn change_number_of_sides(mut query: Query<&mut Path>, time: Res<Time>) {
     let sides = ((time.elapsed_secs_f64() - PI * 2.5).sin() * 2.5 + 5.5).round() as usize;
+    let polygon = shapes::RegularPolygon {
+        sides,
+        feature: shapes::RegularPolygonFeature::Radius(200.0),
+        ..shapes::RegularPolygon::default()
+    };
 
-    for mut path in query.iter_mut() {
-        let polygon = shapes::RegularPolygon {
-            sides,
-            feature: shapes::RegularPolygonFeature::Radius(200.0),
-            ..shapes::RegularPolygon::default()
-        };
-
-        *path = ShapePath::build_as(&polygon);
-    }
+    let mut shape = query.single_mut();
+    *shape = ShapeBuilder::with(&polygon)
+        .fill(color)
+        .stroke((BLACK, outline_width as f32))
+        .build();
 }
 
 fn setup_system(mut commands: Commands) {
@@ -57,12 +50,10 @@ fn setup_system(mut commands: Commands) {
 
     commands.spawn((Camera2d, Msaa::Sample4));
     commands.spawn((
-        ShapeBundle {
-            path: GeometryBuilder::build_as(&shape),
-            ..default()
-        },
-        Fill::color(DARK_CYAN),
-        Stroke::new(BLACK, 10.0),
+        ShapeBuilder::with(&shape)
+            .fill(DARK_CYAN)
+            .stroke((BLACK, 10.0))
+            .build(),
         ExampleShape,
     ));
 }
diff --git a/examples/path.rs b/examples/path.rs
@@ -9,30 +9,23 @@ fn main() {
 }
 
 fn setup_system(mut commands: Commands) {
-    let mut path_builder = PathBuilder::new();
-    path_builder.move_to(Vec2::new(0., 0.));
-    path_builder.cubic_bezier_to(
-        Vec2::new(70., 70.),
-        Vec2::new(175., -35.),
-        Vec2::new(0., -140.),
-    );
-    path_builder.cubic_bezier_to(
-        Vec2::new(-175., -35.),
-        Vec2::new(-70., 70.),
-        Vec2::new(0., 0.),
-    );
-    path_builder.close();
-    let path = path_builder.build();
+    let shape = PathBuilder::new()
+        .fill(RED)
+        .stroke((BLACK, 10.0))
+        .move_to(Vec2::new(0., 0.))
+        .cubic_bezier_to(
+            Vec2::new(70., 70.),
+            Vec2::new(175., -35.),
+            Vec2::new(0., -140.),
+        )
+        .cubic_bezier_to(
+            Vec2::new(-175., -35.),
+            Vec2::new(-70., 70.),
+            Vec2::new(0., 0.),
+        )
+        .close()
+        .build();
 
     commands.spawn((Camera2d, Msaa::Sample4));
-    commands.spawn((
-        ShapeBundle {
-            path,
-            transform: Transform::from_xyz(0., 75., 0.),
-            visibility: default(),
-            ..default()
-        },
-        Stroke::new(BLACK, 10.0),
-        Fill::color(RED),
-    ));
+    commands.spawn((shape, Transform::from_xyz(0., 75., 0.)));
 }
diff --git a/examples/readme.rs b/examples/readme.rs
@@ -19,12 +19,10 @@ fn setup_system(mut commands: Commands) {
     };
 
     commands.spawn((Camera2d, Msaa::Sample4));
-    commands.spawn((
-        ShapeBundle {
-            path: GeometryBuilder::build_as(&shape),
-            ..default()
-        },
-        Fill::color(DARK_CYAN),
-        Stroke::new(BLACK, 10.0),
-    ));
+    commands.spawn(
+        ShapeBuilder::with(&shape)
+            .fill(DARK_CYAN)
+            .stroke((BLACK, 10.0))
+            .build(),
+    );
 }
diff --git a/examples/rectangle.rs b/examples/rectangle.rs
@@ -16,12 +16,10 @@ fn setup_system(mut commands: Commands) {
     };
 
     commands.spawn((Camera2d, Msaa::Sample4));
-    commands.spawn((
-        ShapeBundle {
-            path: GeometryBuilder::build_as(&rect),
-            ..default()
-        },
-        Stroke::new(BLACK, 10.0),
-        Fill::color(RED),
-    ));
+    commands.spawn(
+        ShapeBuilder::with(&rect)
+            .stroke((BLACK, 10.0))
+            .fill(RED)
+            .build(),
+    );
 }
diff --git a/examples/rounded_polygon.rs b/examples/rounded_polygon.rs
@@ -27,11 +27,5 @@ fn setup_system(mut commands: Commands) {
     };
 
     commands.spawn((Camera2d, Msaa::Sample4));
-    commands.spawn((
-        ShapeBundle {
-            path: GeometryBuilder::build_as(&shape),
-            ..default()
-        },
-        Fill::color(DARK_CYAN),
-    ));
+    commands.spawn(ShapeBuilder::with(&shape).fill(DARK_CYAN).build());
 }
diff --git a/examples/svg.rs b/examples/svg.rs
@@ -30,26 +30,18 @@ fn setup_system(mut commands: Commands) {
         //the art style was approximated from https://www.kenney.nl/assets/cartography-pack
         .with_children(|parent| {
             let svg_doc_size = Vec2::new(512., 512.);
-            parent.spawn((
-                ShapeBundle {
-                    path: GeometryBuilder::build_as(&shapes::SvgPathShape {
-                        svg_path_string: BLACKSMITH_OUTLINE.to_owned(),
-                        svg_doc_size_in_px: svg_doc_size.to_owned(),
-                    }),
-                    ..default()
-                },
-                Stroke::new(Color::BLACK, 4.0),
-            ));
-            parent.spawn((
-                ShapeBundle {
-                    path: GeometryBuilder::build_as(&shapes::SvgPathShape {
-                        svg_path_string: BLACKSMITH_DETAIL.to_owned(),
-                        svg_doc_size_in_px: svg_doc_size.to_owned(),
-                    }),
-                    ..default()
-                },
-                Stroke::new(Color::BLACK, 2.5),
-            ));
+
+            let svg = shapes::SvgPathShape {
+                svg_path_string: BLACKSMITH_OUTLINE.to_owned(),
+                svg_doc_size_in_px: svg_doc_size.to_owned(),
+            };
+            parent.spawn(ShapeBuilder::with(&svg).stroke((Color::BLACK, 4.0)).build());
+
+            let svg = shapes::SvgPathShape {
+                svg_path_string: BLACKSMITH_DETAIL.to_owned(),
+                svg_doc_size_in_px: svg_doc_size.to_owned(),
+            };
+            parent.spawn(ShapeBuilder::with(&svg).stroke((Color::BLACK, 2.5)).build());
         });
 
     commands
@@ -69,28 +61,27 @@ fn setup_system(mut commands: Commands) {
         //the art style was approximated from https://www.kenney.nl/assets/cartography-pack
         .with_children(|parent| {
             let svg_doc_size = Vec2::new(1000., 1000.);
-            parent.spawn((
-                ShapeBundle {
-                    path: GeometryBuilder::build_as(&shapes::SvgPathShape {
-                        svg_path_string: SHACK.to_owned(),
-                        svg_doc_size_in_px: svg_doc_size.to_owned(),
-                    }),
-                    ..default()
-                },
-                Stroke::new(Color::BLACK, 20.0),
-            ));
+
+            let svg = shapes::SvgPathShape {
+                svg_path_string: SHACK.to_owned(),
+                svg_doc_size_in_px: svg_doc_size.to_owned(),
+            };
+            parent.spawn(
+                ShapeBuilder::with(&svg)
+                    .stroke((Color::BLACK, 20.0))
+                    .build(),
+            );
 
             // shack walls
-            parent.spawn((
-                ShapeBundle {
-                    path: GeometryBuilder::build_as(&shapes::SvgPathShape {
-                        svg_path_string: SHACK_WALLS.to_owned(),
-                        svg_doc_size_in_px: svg_doc_size.to_owned(),
-                    }),
-                    ..default()
-                },
-                Stroke::new(Color::BLACK, 17.5),
-            ));
+            let svg = shapes::SvgPathShape {
+                svg_path_string: SHACK_WALLS.to_owned(),
+                svg_doc_size_in_px: svg_doc_size.to_owned(),
+            };
+            parent.spawn(
+                ShapeBuilder::with(&svg)
+                    .stroke((Color::BLACK, 17.5))
+                    .build(),
+            );
         });
 }