Refactor Transform in the book

xkchen1992 · Apr 18, 2019 · a65703b · a65703b
1 parent 39b0202
commit a65703b
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 36 deletions.
diff --git a/book/src/assets/how_to_use_assets.md b/book/src/assets/how_to_use_assets.md
@@ -75,7 +75,7 @@ This guide covers the basic usage of assets into Amethyst for existing supported
         let game_data = GameDataBuilder::default()
             .with_bundle(UiBundle::<String, String>::new())?
             .with_bundle(
-                RenderBundle::new(pipeline, Some(display_config))
+                RenderBundle::<'_, _, _, f32>::new(pipeline, Some(display_config))
                     .with_sprite_sheet_processor()
             )?;
 

diff --git a/book/src/concepts/system.md b/book/src/concepts/system.md
@@ -75,7 +75,7 @@ struct WalkPlayerUp {
 }
 
 impl<'a> System<'a> for WalkPlayerUp {
-    type SystemData = WriteStorage<'a, Transform>;
+    type SystemData = WriteStorage<'a, Transform<f32>>;
 
     fn run(&mut self, mut transforms: Self::SystemData) {
         transforms.get_mut(self.player).unwrap().translate_y(0.1);
@@ -116,7 +116,7 @@ struct MakeObjectsFall;
 
 impl<'a> System<'a> for MakeObjectsFall {
     type SystemData = (
-        WriteStorage<'a, Transform>,
+        WriteStorage<'a, Transform<f32>>,
         ReadStorage<'a, FallingObject>,
     );
 
@@ -154,7 +154,7 @@ struct NotFallingObjects;
 
 impl<'a> System<'a> for NotFallingObjects {
     type SystemData = (
-        WriteStorage<'a, Transform>,
+        WriteStorage<'a, Transform<f32>>,
         ReadStorage<'a, FallingObject>,
     );
 
@@ -191,7 +191,7 @@ struct SpawnEnemies {
 
 impl<'a> System<'a> for SpawnEnemies {
     type SystemData = (
-        WriteStorage<'a, Transform>,
+        WriteStorage<'a, Transform<f32>>,
         WriteStorage<'a, Enemy>,
         Entities<'a>,
     );
@@ -244,7 +244,7 @@ struct MakeObjectsFall;
 impl<'a> System<'a> for MakeObjectsFall {
     type SystemData = (
         Entities<'a>,
-        WriteStorage<'a, Transform>,
+        WriteStorage<'a, Transform<f32>>,
         ReadStorage<'a, FallingObject>,
     );
 

diff --git a/book/src/pong-tutorial/pong-tutorial-01.md b/book/src/pong-tutorial/pong-tutorial-01.md
@@ -145,7 +145,7 @@ let pipe = Pipeline::build()
     .with_stage(
         Stage::with_backbuffer()
             .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-            .with_pass(DrawFlat2D::new()),
+            .with_pass(DrawFlat2D::<f32>::new()),
     );
 # }
 ```
@@ -172,13 +172,13 @@ let pipe = Pipeline::build()
     .with_stage(
 #        Stage::with_backbuffer()
 #          .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-#          .with_pass(DrawFlat2D::new()),
+#          .with_pass(DrawFlat2D::<f32>::new()),
     // --snip--
     );
 
 let game_data = GameDataBuilder::default()
     .with_bundle(
-      RenderBundle::new(pipe, Some(config))
+      RenderBundle::<'_, _, _, f32>::new(pipe, Some(config))
         .with_sprite_sheet_processor()
     )?;
 

diff --git a/book/src/pong-tutorial/pong-tutorial-02.md b/book/src/pong-tutorial/pong-tutorial-02.md
@@ -378,16 +378,18 @@ fn main() -> amethyst::Result<()> {
 # let config = DisplayConfig::load(&path);
 # let pipe = Pipeline::build().with_stage(Stage::with_backbuffer()
 #       .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-#       .with_pass(DrawFlat2D::new()),
+#       .with_pass(DrawFlat2D::<f32>::new()),
 # );
 # struct Pong;
 # impl SimpleState for Pong { }
     let game_data = GameDataBuilder::default()
         .with_bundle(
-          RenderBundle::new(pipe, Some(config))
+          RenderBundle::<'_, _, _, f32>::new(pipe, Some(config))
             .with_sprite_sheet_processor()
         )?
         .with_bundle(TransformBundle::new())?;
+# let assets_dir = "/";
+# let mut game = Application::new(assets_dir, Pong, game_data)?;
 # Ok(())
 }
 ```

diff --git a/book/src/pong-tutorial/pong-tutorial-03.md b/book/src/pong-tutorial/pong-tutorial-03.md
@@ -70,12 +70,12 @@ let input_bundle = InputBundle::<String, String>::new()
 # let config = DisplayConfig::load(&path);
 # let pipe = Pipeline::build().with_stage(Stage::with_backbuffer()
 #       .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-#       .with_pass(DrawFlat::<PosTex>::new()),
+#       .with_pass(DrawFlat::<PosTex, f32>::new()),
 # );
 # struct Pong;
 # impl SimpleState for Pong { }
 let game_data = GameDataBuilder::default()
-    .with_bundle(RenderBundle::new(pipe, Some(config)).with_sprite_sheet_processor())?
+    .with_bundle(RenderBundle::<'_, _, _, f32>::new(pipe, Some(config)).with_sprite_sheet_processor())?
     .with_bundle(TransformBundle::new())?
     .with_bundle(input_bundle)?;
 let mut game = Application::new("./", Pong, game_data)?;
@@ -134,7 +134,7 @@ pub struct PaddleSystem;
 
 impl<'s> System<'s> for PaddleSystem {
   type SystemData = (
-    WriteStorage<'s, Transform>,
+    WriteStorage<'s, Transform<f32>>,
     ReadStorage<'s, Paddle>,
     Read<'s, InputHandler<String, String>>,
   );
@@ -210,7 +210,7 @@ fn main() -> amethyst::Result<()> {
 # let config = DisplayConfig::load(&path);
 # let pipe = Pipeline::build().with_stage(Stage::with_backbuffer()
 #       .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-#       .with_pass(DrawFlat::<PosTex>::new()),
+#       .with_pass(DrawFlat::<PosTex, f32>::new()),
 # );
 # mod systems {
 # use amethyst;
@@ -222,10 +222,14 @@ fn main() -> amethyst::Result<()> {
 # }
 # let input_bundle = amethyst::input::InputBundle::<String, String>::new();
   let game_data = GameDataBuilder::default()
-      .with_bundle(RenderBundle::new(pipe, Some(config)).with_sprite_sheet_processor())?
+      .with_bundle(RenderBundle::<'_, _, _, f32>::new(pipe, Some(config)).with_sprite_sheet_processor())?
       .with_bundle(TransformBundle::new())?
       .with_bundle(input_bundle)?
       .with(systems::PaddleSystem, "paddle_system", &["input_system"]); // Add this line
+# let assets_dir = "/";
+# struct Pong;
+# impl SimpleState for Pong { }
+# let mut game = Application::new(assets_dir, Pong, game_data)?;
 # Ok(())
 }
 ```
@@ -261,7 +265,7 @@ component of the transform's translation.
 # pub struct PaddleSystem;
 # impl<'s> System<'s> for PaddleSystem {
 #  type SystemData = (
-#    WriteStorage<'s, Transform>,
+#    WriteStorage<'s, Transform<f32>>,
 #    ReadStorage<'s, Paddle>,
 #    Read<'s, InputHandler<String, String>>,
 #  );
@@ -321,7 +325,7 @@ Our run function should now look something like this:
 # pub struct PaddleSystem;
 # impl<'s> System<'s> for PaddleSystem {
 #  type SystemData = (
-#    WriteStorage<'s, Transform>,
+#    WriteStorage<'s, Transform<f32>>,
 #    ReadStorage<'s, Paddle>,
 #    Read<'s, InputHandler<String, String>>,
 #  );

diff --git a/book/src/pong-tutorial/pong-tutorial-04.md b/book/src/pong-tutorial/pong-tutorial-04.md
@@ -168,7 +168,7 @@ pub struct MoveBallsSystem;
 impl<'s> System<'s> for MoveBallsSystem {
     type SystemData = (
         ReadStorage<'s, Ball>,
-        WriteStorage<'s, Transform>,
+        WriteStorage<'s, Transform<f32>>,
         Read<'s, Time>,
     );
 
@@ -249,7 +249,7 @@ impl<'s> System<'s> for BounceSystem {
     type SystemData = (
         WriteStorage<'s, Ball>,
         ReadStorage<'s, Paddle>,
-        ReadStorage<'s, Transform>,
+        ReadStorage<'s, Transform<f32>>,
     );
 
     fn run(&mut self, (mut balls, paddles, transforms): Self::SystemData) {
@@ -324,7 +324,7 @@ as well as adding our new systems to the game data:
 # let config = DisplayConfig::load(&path);
 # let pipe = Pipeline::build().with_stage(Stage::with_backbuffer()
 #       .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-#       .with_pass(DrawFlat::<PosTex>::new()),
+#       .with_pass(DrawFlat::<PosTex, f32>::new()),
 # );
 # mod systems {
 # use amethyst;
@@ -346,7 +346,7 @@ as well as adding our new systems to the game data:
 # }
 # let input_bundle = amethyst::input::InputBundle::<String, String>::new();
 let game_data = GameDataBuilder::default()
-#    .with_bundle(RenderBundle::new(pipe, Some(config)).with_sprite_sheet_processor())?
+#    .with_bundle(RenderBundle::<'_, _, _, f32>::new(pipe, Some(config)).with_sprite_sheet_processor())?
 #    .with_bundle(TransformBundle::new())?
 #    .with_bundle(input_bundle)?
 #    .with(systems::PaddleSystem, "paddle_system", &["input_system"])
@@ -357,6 +357,10 @@ let game_data = GameDataBuilder::default()
         "collision_system",
         &["paddle_system", "ball_system"],
     );
+# let assets_dir = "/";
+# struct Pong;
+# impl SimpleState for Pong { }
+# let mut game = Application::new(assets_dir, Pong, game_data)?;
 # Ok(())
 # }
 ```

diff --git a/book/src/pong-tutorial/pong-tutorial-05.md b/book/src/pong-tutorial/pong-tutorial-05.md
@@ -53,7 +53,7 @@ pub struct WinnerSystem;
 impl<'s> System<'s> for WinnerSystem {
     type SystemData = (
         WriteStorage<'s, Ball>,
-        WriteStorage<'s, Transform>,
+        WriteStorage<'s, Transform<f32>>,
     );
 
     fn run(&mut self, (mut balls, mut locals): Self::SystemData) {
@@ -136,12 +136,12 @@ keep playing after someone scores and log who got the point.
 # let config = DisplayConfig::load(&path);
 # let pipe = Pipeline::build().with_stage(Stage::with_backbuffer()
 #       .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-#       .with_pass(DrawFlat2D::new()),
+#       .with_pass(DrawFlat2D::<f32>::new()),
 # );
 # let input_bundle = amethyst::input::InputBundle::<String, String>::new();
 #
 let game_data = GameDataBuilder::default()
-#    .with_bundle(RenderBundle::new(pipe, Some(config)).with_sprite_sheet_processor())?
+#    .with_bundle(RenderBundle::<'_, _, _, f32>::new(pipe, Some(config)).with_sprite_sheet_processor())?
 #    .with_bundle(TransformBundle::new())?
 #    .with_bundle(input_bundle)?
 #    .with(systems::PaddleSystem, "paddle_system", &["input_system"])
@@ -154,6 +154,10 @@ let game_data = GameDataBuilder::default()
     // --snip--
     .with(systems::WinnerSystem, "winner_system", &["ball_system"]);
 #
+# let assets_dir = "/";
+# struct Pong;
+# impl SimpleState for Pong { }
+# let mut game = Application::new(assets_dir, Pong, game_data)?;
 # Ok(())
 # }
 ```
@@ -218,13 +222,13 @@ fn main() -> amethyst::Result<()> {
 #     let config = DisplayConfig::load(&path);
     let pipe = Pipeline::build().with_stage(Stage::with_backbuffer()
           .clear_target([0.0, 0.0, 0.0, 1.0], 1.0)
-          .with_pass(DrawFlat2D::new())
+          .with_pass(DrawFlat2D::<f32>::new())
           .with_pass(DrawUi::new()), // <-- Add me
     );
 #     let input_bundle = amethyst::input::InputBundle::<String, String>::new();
 #
     let game_data = GameDataBuilder::default()
-        .with_bundle(RenderBundle::new(pipe, Some(config))
+        .with_bundle(RenderBundle::<'_, _, _, f32>::new(pipe, Some(config))
         .with_sprite_sheet_processor())?
         .with_bundle(TransformBundle::new())?
         .with_bundle(input_bundle)?
@@ -239,8 +243,12 @@ fn main() -> amethyst::Result<()> {
 #             &["paddle_system", "ball_system"],
 #         )
 #         .with(systems::WinnerSystem, "winner_system", &["ball_system"]);
-# 
-#     Ok(())
+#
+# let assets_dir = "/";
+# struct Pong;
+# impl SimpleState for Pong { }
+# let mut game = Application::new(assets_dir, Pong, game_data)?;
+# Ok(())
 }
 ```
 
@@ -777,7 +785,7 @@ pub struct WinnerSystem;
 impl<'s> System<'s> for WinnerSystem {
     type SystemData = (
         WriteStorage<'s, Ball>,
-        WriteStorage<'s, Transform>,
+        WriteStorage<'s, Transform<f32>>,
         WriteStorage<'s, UiText>,
         Write<'s, ScoreBoard>,
         ReadExpect<'s, ScoreText>,

diff --git a/book/src/prefabs/how_to_define_prefabs_prelude.md b/book/src/prefabs/how_to_define_prefabs_prelude.md
@@ -49,7 +49,7 @@ Component     | Serialized representation             | Example(s)            |
     # use specs_derive::Component;
     #
     # #[derive(Component, Debug, Deserialize, Serialize /* .. */)]
-    # pub struct Position(pub f32, pub f32, pub f32);
+    # pub struct Position{pub x: f32, pub y: f32, pub z:f32};
     #
     impl From<(i32, i32, i32)> for Position {
         fn from((x, y, z): (i32, i32, i32)) -> Position {

diff --git a/book/src/prefabs/prefabs_technical_explanation.md b/book/src/prefabs/prefabs_technical_explanation.md
@@ -255,7 +255,7 @@ Lets look at an example of an aggregate struct:
 #[derive(PrefabData)]
 pub struct MyScenePrefab {
     mesh: AssetPrefab<Mesh, ObjFormat>,
-    transform: Transform,
+    transform: Transform<f32>,
 }
 ```
 
@@ -275,7 +275,7 @@ One last example that also adds a custom pure data `Component` into the aggregat
 #[derive(PrefabData)]
 pub struct MyScenePrefab {
     mesh: AssetPrefab<Mesh, ObjFormat>,
-    transform: Transform,
+    transform: Transform<f32>,
 
     #[prefab(Component)]
     some: SomeComponent,

diff --git a/book/src/sprites/set_up_the_render_pass.md b/book/src/sprites/set_up_the_render_pass.md
@@ -33,14 +33,14 @@ fn main() -> amethyst::Result<()> {
         Stage::with_backbuffer()
             .clear_target([0., 0., 0., 1.], 1.)
             .with_pass(
-                DrawFlat2D::new()
-                    .with_transparency(ColorMask::all(), ALPHA, None)),
+                DrawFlat2D::<f32>::new()
+                    .with_transparency_settings(ColorMask::all(), ALPHA, None)),
     );
 
     let game_data = GameDataBuilder::default()
 #         .with_bundle(TransformBundle::new())?
         .with_bundle(
-            RenderBundle::new(pipe, Some(display_config))
+            RenderBundle::<'_, _, _, f32>::new(pipe, Some(display_config))
                 .with_sprite_sheet_processor())?
 
 #         .with_bundle(InputBundle::<String, String>::new())?