Ticket #154: additional parameters for CarController.poll and added CarController.getLastSignal.patch

src/de/jacavi/appl/racelogic/RaceEngine.java

@@ -36 +36 @@
 
     private int raceTimerInterval = 0;
 
-    boolean isTimerRunning = false;
+    private boolean isTimerRunning = false;
 
     private Track track;
 
     private List<Player> players;
 
-    private RaceEngine() {}
-
     public void setPlayers(List<Player> players) {
         this.players = players;
     }
@@ -144 +142 @@
                 // get players hal connector
                 SlotCarSystemConnector slotCarSystemConnector = player.getSlotCarSystemConnector();
                 // get players controller signal
-                ControllerSignal controllerSignal = carController.poll();
+                ControllerSignal controllerSignal = carController.poll(player, players, track);
                 // get the tda
                 TrackDataApproximator tda = player.getTda();
 

src/de/jacavi/appl/controller/device/impl/MouseDevice.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.device.impl;
 
+import java.util.List;
+
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
@@ -7 +9 @@
 
 import de.jacavi.appl.controller.ControllerSignal;
 import de.jacavi.appl.controller.device.DeviceController;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 
 
 
@@ -58 +62 @@
     }
 
     @Override
-    public ControllerSignal poll() {
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
         return currentControllerSignal;
     }
 

src/de/jacavi/appl/controller/device/impl/GameControllerDevice.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.device.impl;
 
+import java.util.List;
+
 import com.centralnexus.input.Joystick;
 
 import de.jacavi.appl.controller.ControllerSignal;
 import de.jacavi.appl.controller.device.DeviceController;
 import de.jacavi.appl.controller.device.impl.GameControllerDeviceManager.GameControllerDescriptor;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 
 
 
@@ -21 +25 @@
     }
 
     @Override
-    public ControllerSignal poll() {
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
         device.poll();
 
         int speed = normaliseSpeedSignal(device.getY());

src/de/jacavi/appl/controller/device/impl/WiimoteDevice.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.device.impl;
 
+import java.util.List;
+
 import org.apache.log4j.Logger;
 
 import wiiusej.Wiimote;
@@ -18 +20 @@
 import wiiusej.wiiusejevents.wiiuseapievents.StatusEvent;
 import de.jacavi.appl.controller.ControllerSignal;
 import de.jacavi.appl.controller.device.DeviceController;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 import de.jacavi.rcp.util.Check;
 
 
@@ -59 +63 @@
     }
 
     @Override
-    public ControllerSignal poll() {
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
         return currentControllerSignal;
     }
 

src/de/jacavi/appl/controller/device/impl/KeyboardDevice.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.device.impl;
 
+import java.util.List;
+
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
@@ -7 +9 @@
 
 import de.jacavi.appl.controller.ControllerSignal;
 import de.jacavi.appl.controller.device.DeviceController;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 
 
 
@@ -50 +54 @@
     }
 
     @Override
-    public ControllerSignal poll() {
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
         ControllerSignal retVal = currentControllerSignal;
         currentControllerSignal = new ControllerSignal(currentControllerSignal.getThrust(), currentControllerSignal
                 .isTrigger());

src/de/jacavi/appl/controller/device/impl/MouseKeyboardDeviceAdapter.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.device.impl;
 
+import java.util.List;
+
 import de.jacavi.appl.controller.ControllerSignal;
 import de.jacavi.appl.controller.device.DeviceController;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 
 
 
@@ -35 +39 @@
     }
 
     @Override
-    public ControllerSignal poll() {
-        ControllerSignal mouse = mouseDevice.poll();
-        ControllerSignal keyboard = keyboardDevice.poll();
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
+        ControllerSignal mouse = mouseDevice.poll(you, others, track);
+        ControllerSignal keyboard = keyboardDevice.poll(you, others, track);
         return new ControllerSignal(mouse.getThrust(), mouse.isTrigger(), keyboard.isSwitchFrontLight(), keyboard
                 .isSwitchBackLight(), mouse.isReset());
     }

src/de/jacavi/appl/controller/CarController.java

@@ -1 +1 @@
 package de.jacavi.appl.controller;
 
+import java.util.List;
 import java.util.UUID;
 
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
+
 
 
 public abstract class CarController implements Comparable<CarController> {
@@ -14 +18 @@
         this.name = name;
     }
 
-    abstract public ControllerSignal poll();
+    abstract public ControllerSignal poll(Player you, List<Player> others, Track track);
 
     public void cleanup() {
         deactivate();
@@ -54 +58 @@
     public void deactivate() {}
 
     /**
-     * Reset resets the state of a Controller without deactivating its listeners. Currently it is called in the RaceEngine
-     * if ControllerSignal.isReset() to make sure the Controller has the same state as a freshly activated one.
+     * Reset resets the state of a Controller without deactivating its listeners. Currently it is called in the
+     * RaceEngine if ControllerSignal.isReset() to make sure the Controller has the same state as a freshly activated
+     * one.
      * <p>
      * We need the reset because some Controllers save their thrust in state.
      */
     public void reset() {}
 
+    /**
+     * Returns the last signal that was poll()ed.
+     * <p>
+     * The difference to poll() is that this should not actually communicate in any way with the hardware. It's
+     * primarily used by the TrackWidget to draw the thrust gauges.
+     * <p>
+     * The default implementation just returns the result of poll() with null arguments. When in doubt, overwrite it!
+     * <p>
+     * IMPORTANT NOTE: This might actually be called *before* the first poll()!
+     */
+    public ControllerSignal getLastSignal() {
+        return poll(null, null, null);
+    }
+
 }

src/de/jacavi/appl/controller/agent/DrivingAgent.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.agent;
 
+import java.util.List;
+
 import de.jacavi.appl.controller.ControllerSignal;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.CarPosition;
+import de.jacavi.appl.track.Track;
 
 
 
 public interface DrivingAgent {
-    ControllerSignal poll(/*CarPosition you, CarPosition[] others, Track track*/);
+    ControllerSignal poll(CarPosition you, List<Player> others, Track track);
 }

src/de/jacavi/appl/controller/agent/ScriptController.java

@@ -4 +4 @@
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.io.Writer;
+import java.util.List;
 
 import de.jacavi.appl.controller.ControllerSignal;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 import de.jacavi.rcp.util.ExceptionHandler;
 
 
 
 abstract public class ScriptController extends DrivingAgentController {
+
     @SuppressWarnings("serial")
     public class ScriptExecutionException extends Exception {
         public ScriptExecutionException(String message) {
@@ -22 +26 @@
 
     private DrivingAgent scriptObject;
 
+    private ControllerSignal lastSignal = new ControllerSignal();
+
     public ScriptController(String name, File agentFile) {
         super(name);
         this.agentFile = agentFile;
@@ -31 +37 @@
         return agentFile;
     }
 
+    // @SuppressWarnings("unchecked")
     @Override
-    public ControllerSignal poll() {
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
         if(scriptObject == null)
             return null;
-        else
-            return scriptObject.poll(/*null, null, null*/);
+        else {
+            // determine the arguments to pass to the script
+            /*List<Player> players = (List<Player>) ContextLoader.getBean("playersBean");
+            Player you = null;
+            List<Player> others = new ArrayList<Player>();
+            for(Player p: players) {
+                if(p.getController() == this) {
+                    assert you == null: "Error: this controller was apparently assigned to multiple players";
+                    you = p;
+                } else
+                    others.add(p);
+            }*/
+            lastSignal = scriptObject.poll(you.getPosition(), others, track);
+            return lastSignal;
+        }
+    }
+
+    @Override
+    public ControllerSignal getLastSignal() {
+        return lastSignal;
     }
 
     @Override
@@ -61 +86 @@
 
     public ControllerSignal dryRun() throws ScriptExecutionException {
         try {
-            return parseScript().poll();
+            return parseScript().poll(null, null, null);
         } catch(Exception exc) {
             final Writer writer = new StringWriter();
             exc.printStackTrace(new PrintWriter(writer));

src/de/jacavi/appl/controller/agent/impl/XmlRpcController.java

@@ -1 +1 @@
 package de.jacavi.appl.controller.agent.impl;
 
+import java.util.List;
+
 import org.apache.xmlrpc.XmlRpcException;
 import org.apache.xmlrpc.XmlRpcRequest;
 import org.apache.xmlrpc.server.PropertyHandlerMapping;
@@ -10 +12 @@
 
 import de.jacavi.appl.controller.ControllerSignal;
 import de.jacavi.appl.controller.agent.ExternalController;
+import de.jacavi.appl.racelogic.Player;
+import de.jacavi.appl.track.Track;
 import de.jacavi.rcp.util.ExceptionHandler;
 
 
@@ -149 +153 @@
     }
 
     @Override
-    public ControllerSignal poll() {
+    public ControllerSignal poll(Player you, List<Player> others, Track track) {
         return controllerSignal;
     }
 

src/de/jacavi/rcp/dlg/InputDeviceSettingsDialog.java

@@ -93 +93 @@
                 @Override
                 public void run() {
                     if(!progressBar.isDisposed() && carControllerManager.isIdValid(deviceID)) {
-                        ControllerSignal signal = carControllerManager.getDevice(deviceID).poll();
+                        ControllerSignal signal = carControllerManager.getDevice(deviceID).poll(null, null, null);
                         progressBar.setSelection(signal.getThrust());
                         progressBar.setForeground(signal.isTrigger() ? Display.getDefault().getSystemColor(
                                 SWT.COLOR_DARK_MAGENTA) : null);

src/de/jacavi/rcp/widgets/TrackWidget.java

@@ -1046 +1046 @@
             boolean isOnTrack = p.getPosition().isOnTrack;
             CarController dc = p.getController();
             String name = p.getName();
-            ControllerSignal signal = dc.poll();
+            ControllerSignal signal = dc.getLastSignal();
             if(signal != null) {
                 int thrust = isOnTrack ? signal.getThrust() : 100;
                 boolean isTriggered = isOnTrack ? signal.isTrigger() : false;

agents/SampleAgent.groovy

@@ +1 @@
+// SampleAgent:
+//   A very simple Groovy driving agent that alternates
+//   between a faster and a slower mode every 100 gameticks.
+
+
+import java.util.List
 import de.jacavi.appl.controller.agent.DrivingAgent
 import de.jacavi.appl.controller.ControllerSignal
+import de.jacavi.appl.track.CarPosition
+import de.jacavi.appl.track.Track
 
 public class SampleAgent implements DrivingAgent {
         private int counter = 0
 
-    public ControllerSignal poll() {
+    public ControllerSignal poll(CarPosition you, List others, Track track) {
         counter++
         if(((counter / 100) as int) % 2 == 1) {
             return new ControllerSignal(35, true)

agents/TrackAwareAgent.py

@@ +1 @@
+# TrackAwareAgent:
+#   A Jython driving agent that detects the tile he's
+#   currently on and goes 60% thrust on straight tiles
+#   and 30% thrust on curvy tiles.
+
+class MyAgent(DrivingAgent):
+    def __init__(self):
+        self.counter = 0
+
+    def poll(self, you, others, track):
+        if you and track: # during a race
+
+            # determine the section I'm on
+            section = you.trackSectionIndex
+
+            # which tile is that?
+            tile = track.getSections().get(section).getTile()
+
+            # if the entry-to-exit angle is 0, full speed
+            if tile.getEntryToExitAngle().angle == 0:
+                return ControllerSignal(60, False)
+
+            # if it's a turn tile, slow down
+            else:
+                return ControllerSignal(30, False)
+
+        else: # for the dry run
+            return ControllerSignal(10, True)

agents/SampleAgent.py

@@ -1 @@
-#import de.jacavi.appl.controller.agent.DrivingAgent
-#import de.jacavi.appl.controller.ControllerSignal
+# SampleAgent:
+#   A very simple Jython driving agent that alternates
+#   between a faster and a slower mode every 100 gameticks.
 
 class MyAgent(DrivingAgent):
     def __init__(self):
         self.counter = 0
 
-    def poll(self):
+    def poll(self, you, others, track):
         self.counter += 1
         if self.counter / 100 % 2:
             return ControllerSignal(35, True)