Simplify the usage of sprites by remove the usage of super

Author: Mike Barkmin

README.md

@@ -23,8 +23,11 @@ initialize the ScratchStage. You only need to place this statement
 ```java
 import eu.barkmin.processing.scratch.*;
 
+ScratchStage stage;
+
 void setup() {
   ScratchStage.init(this);
+  stage = ScratchStage.getInstance();
 }
 
 void draw() {
@@ -64,8 +67,16 @@ To add a new backdrop call `stage.addBackdrop("newBackdrop",
 
 | Scratch | Processing |
 | :-: | :-: |
-| ![stage when key pressed](web/assets/sprite_when_keypressed.png) | Overwrite `stage.keyEvent(KeyEvent e)`. The method will be called everytime a new KeyEvent is fired. For example when pressing or releasing a key. See [KeyEvent](https://processing.github.io/processing-javadocs/core/processing/event/KeyEvent.html) for more Information. |
-| ![stage when move moved](web/assets/sprite_when_mouse_moved.png) | Overwrite `stage.mouseEvent(MouseEvent e)`. The method will be called everytime a new MouseEvent is fired. For example when pressing, releasing or moving the mouse. See [MouseEvent](https://processing.github.io/processing-javadocs/core/processing/event/MouseEvent.html) for more Information. |
+| ![stage when key pressed](web/assets/sprite_when_keypressed.png) | Overwrite `stage.whenKeyPressed(int keycode)`. This method is called everytime a key is pressed. See [http://keycode.info](http://keycode.info) for keycode information |
+| ![stage when move moved](web/assets/sprite_when_mouse_moved.png) | Overwrite `stage.whenMouseMoved(float x, float y)`. This method is called everytime the mouse is moved. |
+
+
+### Other methods
+
+| Processing | Description |
+| :-: | :-: |
+| `stage.addSprite(sprite)` | Adds a sprite to stage |
+| `stage.removeSprite(sprite)` | Removes a sprite from the stage |
 
 #### Sound
 
@@ -95,33 +106,34 @@ Source Code: https://github.com/mikebarkmin/processing-library-scratch/blob/mast
 In Scratch sprites are the main actors. Every sprite has a custom set of
 costumes and sounds, which could be dynamically changed. Most of the
 functionality which sprites in Scratch have were tried to reimplement in
-processing.
+processing. When added to the stage, the run method of a sprite will be called continuously.
 
 #### Creation
 
 ```java
 import eu.barkmin.processing.scratch.*;
 
+ScratchStage stage;
 CatSprite myCat;
 
 void setup() {
   size(800, 600);
   ScratchStage.init(this);
+  stage = ScratchStage.getInstance();
   myCat = new CatSprite();
+  stage.addSprite(myCat);
 }
 
 void draw() {
-  myCat.draw();
 }
 
 // Define a class Cat 
 class CatSprite extends ScratchSprite {
   CatSprite() {
-    super("cat", "sprites/cat.png");  
+    this.addCostume("cat", "sprites/cat.png");
     this.setOnEdgeBounce(true);
   }
-  void draw() {
-    super.draw();
+  void run() {
     this.move(2);
   }
 }
@@ -186,6 +198,41 @@ To add a new costume call `sprite.addCostume("newCostume",
 | ![sprite when key pressed](web/assets/sprite_when_keypressed.png) | Overwrite `sprite.keyEvent(KeyEvent e)`. The method will be called everytime a new KeyEvent is fired. For example when pressing or releasing a key. See [KeyEvent](https://processing.github.io/processing-javadocs/core/processing/event/KeyEvent.html) for more Information. |
 | ![sprite when move moved](web/assets/sprite_when_mouse_moved.png) | Overwrite `sprite.mouseEvent(MouseEvent e)`. The method will be called everytime a new MouseEvent is fired. For example when pressing, releasing or moving the mouse. See [MouseEvent](https://processing.github.io/processing-javadocs/core/processing/event/MouseEvent.html) for more Information. |
 
+### Other methods
+
+| Processing | Description |
+| :-: | :-: |
+| `sprite.run()` | Will be called continuously, when the sprite is added to the stage. |
+| `sprite.draw()` | Overwrite this methode to gain more controll over the sprite and draw it without added it to the stage. |
+
+
+The following code will show the same result. The normal sprite is handled by the ScratchStage, the custom sprite is handled by us.
+```
+Custom custom;
+
+void setup () {
+  ScratchStage.init(this);
+  ScratchStage.getInstance().addSprite(new Normal());
+}
+
+void draw() {
+  custom.draw();
+}
+
+class Normal extends ScratchSprite {
+  run() {
+    this.move(10);
+  }
+}
+
+class Custom extends ScratchSprite {
+  draw() {
+    super.draw();
+    this.move(10);
+  }
+}
+```
+
 #### Sound
 
 When you work with sound you need to install

examples/Cat/Cat.pde

@@ -1,25 +1,25 @@
 import eu.barkmin.processing.scratch.*;
 
+ScratchStage stage;
 CatSprite myCat;
 
 void setup() {
   size(800, 600);
   ScratchStage.init(this);
+  stage = ScratchStage.getInstance();
   myCat = new CatSprite();
+  stage.addSprite(myCat);
 }
 
-void draw() {
-  myCat.draw();
-}
+void draw() {}
 
 // Define a class Cat 
 class CatSprite extends ScratchSprite {
   CatSprite() {
-    super("cat", "sprites/cat.png");  
+    this.addCostume("cat", "sprites/cat.png");  
     this.setOnEdgeBounce(true);
   }
-  void draw() {
-    super.draw();
+  void run() {
     this.move(2);
   }
 }

examples/Clock/Clock.pde

@@ -8,9 +8,8 @@ void setup() {
   ScratchStage.init(this);
   stage = ScratchStage.getInstance();
   clock = new ClockSprite();
+  stage.addSprite(clock);
 }
 
 void draw() {
-  //stage.eraseAll();
-  clock.draw();
 }

examples/Clock/ClockSprite.pde

@@ -5,16 +5,15 @@ class ClockSprite extends ScratchSprite {
   HourHandSprite hour;
 
   ClockSprite() {
-    super("clock", "sprites/clock.png");
+    this.addCostume("clock", "sprites/clock.png");
     second = new SecondHandSprite();
     minute = new MinuteHandSprite();
     hour = new HourHandSprite();
   }
 
-  void draw() {
+  void run() {
     second.draw();
     minute.draw();
     hour.draw();
-    super.draw();
   }
 }

examples/Clock/HourHandSprite.pde

@@ -1,10 +1,9 @@
 class HourHandSprite extends ScratchSprite {
   HourHandSprite() {
-    super("hand", "sprites/hour.png");
+    this.addCostume("hand", "sprites/hour.png");
   }
 
-  void draw() {
-    super.draw();
+  void run() {
     int hour = this.getCurrentHour();
     this.setRotation(hour / 12.0 * 360);
   }

examples/Clock/MinuteHandSprite.pde

@@ -1,10 +1,9 @@
 class MinuteHandSprite extends ScratchSprite {
   MinuteHandSprite() {
-    super("hand", "sprites/minute.png");
+    this.addCostume("hand", "sprites/minute.png");
   }
 
-  void draw() {
-    super.draw();
+  void run() {
     int minute = this.getCurrentMinute();
     this.setRotation(minute / 60.0 * 360);
   }

examples/Clock/SecondHandSprite.pde

@@ -1,11 +1,10 @@
 class SecondHandSprite extends ScratchSprite {
 
   SecondHandSprite() {
-    super("hand", "sprites/second.png");
+    this.addCostume("hand", "sprites/second.png");
   }
 
-  void draw() {
-    super.draw();
+  void run() {
     int second = this.getCurrentSecond();
     if (isKeyPressed(32)) {
       int millisecond = this.getCurrentMillisecond();

examples/RainbowVine/RainbowVine.pde

@@ -11,26 +11,24 @@ void setup() {
   stage.setColor(0, 0, 0);
 
   vine = new VineSprite();
+  stage.addSprite(vine);
 }
 
-void draw() {
-  vine.draw(); 
-}
+void draw() {}
 
 class VineSprite extends ScratchSprite {
 
   ArrayList<LeafSprite> leafs = new ArrayList();
 
   VineSprite() {
-    super("vine", "sprites/vine.png");
+    this.addCostume("vine", "sprites/vine.png");
     this.getPen().down();
     this.getPen().setSize(3);
     this.getPen().setColor(120);
     this.hide();
   }
 
-  void draw() {
-    super.draw();
+  void run() {
     this.setPosition(ScratchStage.parent.mouseX, ScratchStage.parent.mouseY);
     this.turnRight(5);
 

examples/RandomDot/RandomDot.pde

@@ -1,21 +1,20 @@
 import eu.barkmin.processing.scratch.*;
 
+ScratchStage stage;
 RandomDotSprite dot;
 
 void setup() {
   size(800, 600);
   ScratchStage.init(this);
+  stage = ScratchStage.getInstance();
   dot = new RandomDotSprite();
-  
+  stage.addSprite(dot);
 }
 
-void draw() {
-  dot.draw();
-}
+void draw() {}
 
 class RandomDotSprite extends ScratchSprite {
-  void draw() {
-    super.draw();
+  void run() {
     if(this.getTimer().everyMillis(100)) {
       this.getPen().down();
       this.getPen().setSize(10);

examples/Robot/Robot.pde

@@ -1,13 +1,14 @@
 import eu.barkmin.processing.scratch.*;
 
+ScratchStage stage;
 RobotSprite robot;
 
 void setup() {
   size(800, 600);
   ScratchStage.init(this);
   robot = new RobotSprite();
+  stage = ScratchStage.getInstance();
+  stage.addSprite(robot);
 }
 
-void draw() {
-  robot.draw();
-}
+void draw() {}