GUI FX Applications improved (now easier to extend).

Author: RuedigerLunde

aimax-osm/src/main/java/aimax/osm/gui/fx/IntegratedAimaOsmFxApp.java

@@ -5,7 +5,7 @@
 import aimax.osm.gui.fx.applications.OsmLRTAStarAgentApp;
 import aimax.osm.gui.fx.applications.OsmRouteFindingAgentApp;
 import aimax.osm.gui.fx.applications.OsmRoutePlannerApp;
-import aimax.osm.gui.fx.applications.SimpleOsmAgentApp;
+import aimax.osm.gui.fx.applications.OsmAgentBaseApp;
 import javafx.application.Application;
 import javafx.scene.Scene;
 import javafx.scene.layout.BorderPane;
@@ -39,7 +39,7 @@ public static void defineContent(IntegratedAppPaneBuilder builder) {
 		IntegratedAimaFxApp.defineContent(builder);
 
 		builder.registerApp(OsmRoutePlannerApp.class);
-		builder.registerApp(SimpleOsmAgentApp.class);
+		builder.registerApp(OsmAgentBaseApp.class);
 		builder.registerApp(OsmRouteFindingAgentApp.class);
 		builder.registerApp(OsmLRTAStarAgentApp.class);
 	}

…i/fx/applications/SimpleOsmAgentApp.java …gui/fx/applications/OsmAgentBaseApp.javaaimax-osm/src/main/java/aimax/osm/gui/fx/applications/SimpleOsmAgentApp.java renamed to aimax-osm/src/main/java/aimax/osm/gui/fx/applications/OsmAgentBaseApp.java aimax-osm/src/main/java/aimax/osm/gui/fx/applications/SimpleOsmAgentApp.java renamed to aimax-osm/src/main/java/aimax/osm/gui/fx/applications/OsmAgentBaseApp.java

@@ -36,12 +36,14 @@
 
 /**
  * Simple OSM route finding agent application which can be used as base class
- * for more advanced OSM agent applications.
+ * for more advanced OSM agent applications. For example, by overriding some of
+ * the factory methods, it is easy to add parameters and change agent as well as
+ * environment implementations.
  *
  * @author Ruediger Lunde
  *
  */
-public class SimpleOsmAgentApp extends IntegrableApplication {
+public class OsmAgentBaseApp extends IntegrableApplication {
 
 	public static void main(String[] args) {
 		launch(args);
@@ -62,7 +64,7 @@ public static void main(String[] args) {
 
 	@Override
 	public String getTitle() {
-		return "Simple OSM Agent App";
+		return "OSM Agent Base App";
 	}
 
 	/** Loads a map of the city of Ulm, Germany. Override to change the map. */
@@ -110,6 +112,14 @@ protected Agent createAgent(SearchForActions search, List<String> locations) {
 		return new MapAgent(map, envViewCtrl::notify, search, new String[] { locations.get(1) });
 	}
 
+	/**
+	 * Factory method which creates a new environment based on the current
+	 * parameter settings.
+	 */
+	protected MapEnvironment createEnvironment() {
+		return new MapEnvironment(map);
+	}
+
 	/**
 	 * Defines state view, parameters, and call-back functions and calls the
 	 * simulation pane builder to create layout and controller objects.
@@ -176,7 +186,7 @@ public void simulate() {
 			}
 			SearchForActions search = createSearch(locations);
 			Agent agent = createAgent(search, locations);
-			env = new MapEnvironment(map);
+			env = createEnvironment();
 			env.addEnvironmentView(new TrackUpdater());
 			env.addAgent(agent, locations.get(0));
 			if (simPaneCtrl.getParam(PARAM_SEARCH).isPresent())

aimax-osm/src/main/java/aimax/osm/gui/fx/applications/OsmRouteFindingAgentApp.java

@@ -25,7 +25,7 @@
  * @author Ruediger Lunde
  *
  */
-public class OsmRouteFindingAgentApp extends SimpleOsmAgentApp {
+public class OsmRouteFindingAgentApp extends OsmAgentBaseApp {
 
 	public static void main(String[] args) {
 		launch(args);