Documentation improved.

Author: RuedigerLunde

aima-gui/README.md

@@ -2,10 +2,13 @@
 
 by Ruediger Lunde ([email protected])
 
-This project contains graphical applications and command line demos, which
-demonstrate the use of some of the aima-core project features. Currently, it
-focuses on search algorithms and agent concepts. Application class names end
-with "App" and command line demo class names end with "Demo".
+![WumpusAgentApp Demo Application](https://github.com/aimacode/aima-java/blob/AIMA3e/aima-gui/src/main/uml/WumpusDemoApp.png)
+
+This project contains graphical applications and command line demos. The command line demos show
+how to use selected parts of the aima-core API. The applications support interactive experiments with
+some of the core algorithms, especially from the search and logic area.
+ 
+Application class names end with "App" and command line demo class names end with "Demo".
 Simple demo command line applications can be found in package `aima.gui.demo`.
 Graphical demo applications are available based on JavaFX (package `aima.gui.fx.applications`) and
 Swing (package `aima.gui.swing.applications`). Each platform-specific root package contains an

aima-gui/src/main/java/aima/gui/fx/views/VacuumEnvironmentViewCtrl.java

@@ -7,9 +7,6 @@
 import aima.core.environment.vacuum.VacuumEnvironment;
 import aima.core.environment.vacuum.VacuumEnvironment.LocationState;
 import aima.core.environment.vacuum.VacuumEnvironmentState;
-import aima.core.environment.wumpusworld.Room;
-import aima.core.environment.wumpusworld.WumpusCave;
-import aima.core.environment.wumpusworld.WumpusEnvironment;
 import javafx.scene.Node;
 import javafx.scene.layout.StackPane;
 import javafx.scene.paint.Color;
@@ -71,7 +68,7 @@ protected void update() {
             Integer orientation = agentOrientations.get(agent);
             if (orientation == null)
                 orientation = 0;
-            btn.getPane().getChildren().add(createAgentRep(agentsInSuckState.contains(agent), orientation));
+            btn.getPane().getChildren().add(createAgentSymbol(agentsInSuckState.contains(agent), orientation));
         }
     }
 
@@ -91,7 +88,7 @@ protected void onEdit(int x, int y) {
 
 
 
-    protected Node createAgentRep(boolean suck, int orientation) {
+    protected Node createAgentSymbol(boolean suck, int orientation) {
         Arc arc = new Arc();
         arc.radiusXProperty().bind(squareSize.multiply(0.3));
         arc.radiusYProperty().bind(squareSize.multiply(0.3));

aima-gui/src/main/java/aima/gui/fx/views/WumpusEnvironmentViewCtrl.java

@@ -6,6 +6,7 @@
 import aima.core.environment.wumpusworld.Room;
 import aima.core.environment.wumpusworld.WumpusCave;
 import aima.core.environment.wumpusworld.WumpusEnvironment;
+import javafx.scene.Node;
 import javafx.scene.layout.Pane;
 import javafx.scene.layout.StackPane;
 import javafx.scene.paint.Color;
@@ -57,12 +58,12 @@ protected void update() {
             }
         }
 
-        // visualize agent position
-        List<Agent> agents = env.getAgents();
-        if (!agents.isEmpty()) {
-            AgentPosition pos = wEnv.getAgentPosition(agents.get(0));
+        // visualize agent positions
+        for (Agent agent : wEnv.getAgents()) {
+            AgentPosition pos = wEnv.getAgentPosition(agent);
             Pane pane = getSquareButton(pos.getX(), pos.getY()).getPane();
-            addAgentMarker(pane, agents.get(0).isAlive() ? Color.RED : Color.LIGHTGRAY, pos.getOrientation());
+            pane.getChildren().add(createAgentSymbol(pane, agent.isAlive() ? Color.RED : Color.LIGHTGRAY,
+                    pos.getOrientation()));
         }
     }
 
@@ -74,33 +75,32 @@ protected void onEdit(int x, int y) {
             actionLabel.setText("Cave can only be edited after initialization.");
         else if (!room.equals(cave.getStart().getRoom()) && !room.equals(cave.getGold())) {
             if (cave.isPit(room)) {
-                if (cave.getWumpus().equals(room)) {
+                if (cave.getWumpus().equals(room))
                     cave.setPit(room, false);
-                } else {
+                else
                     cave.setWumpus(room);
-                }
             } else {
                 cave.setPit(room, true);
             }
             update();
         }
     }
 
-    private void addAgentMarker(Pane pane, Color color, AgentPosition.Orientation orientation) {
+    private Node createAgentSymbol(Pane pane, Color color, AgentPosition.Orientation orientation) {
         int size = squareSize.get() / 2;
-        Polygon marker = new Polygon(-size / 3, size, size / 3, size, 0, 0);
-        marker.setFill(color);
+        Polygon result = new Polygon(-size / 3, size, size / 3, size, 0, 0);
+        result.setFill(color);
         switch (orientation) {
             case FACING_EAST:
-                marker.setRotate(90);
+                result.setRotate(90);
                 break;
             case FACING_SOUTH:
-                marker.setRotate(180);
+                result.setRotate(180);
                 break;
             case FACING_WEST:
-                marker.setRotate(270);
+                result.setRotate(270);
                 break;
         }
-        pane.getChildren().add(marker);
+        return result;
     }
 }