Merge lp:~tapaal-contributor/tapaal/game-shortcuts into lp:tapaal

[Lena Said]

Added game shortcuts

When a transition is selected it is possible to toggle between a controlled/uncontrolled transition by pressing E and an urgent/non-urgent transition by pressing U

The shortcuts are only possible if the lens allows it

If the net is game, then it is possible to draw an uncontrollable transition by pressing L and clicking on the drawing surface

[lp:~tapaal-contributor/tapaal/game-shortcuts]

1109. By Lena Said on 2020-08-20

Added annotation to toolbar

1110. By Lena Said on 2020-08-20

Moved the transition toggle shortcuts to be a guiAction

1111. By Lena Said on 2020-08-21

guiModelManager handles the toggle functionality

1112. By Lena Said on 2020-08-21

Added undo to the toggle

[Kenneth Yrke Jørgensen (yrke)]

Looks good

review: Approve

[Jiri Srba (srba)]

Works very nice! Great usability addition.

review: Approve

=== modified file 'src/dk/aau/cs/gui/TabContent.java'
--- src/dk/aau/cs/gui/TabContent.java	2020-08-17 08:18:13 +0000
+++ src/dk/aau/cs/gui/TabContent.java	2020-08-21 08:37:32 +0000
@@ -16,9 +16,7 @@
 import dk.aau.cs.gui.components.BugHandledJXMultisplitPane;
 import dk.aau.cs.gui.components.StatisticsPanel;
 import dk.aau.cs.gui.components.TransitionFireingComponent;
-import dk.aau.cs.gui.undo.Command;
-import dk.aau.cs.gui.undo.DeleteQueriesCommand;
-import dk.aau.cs.gui.undo.TimedPlaceMarkingEdit;
+import dk.aau.cs.gui.undo.*;
 import dk.aau.cs.io.*;
 import dk.aau.cs.io.queries.SUMOQueryLoader;
 import dk.aau.cs.io.queries.XMLQueryLoader;
@@ -168,9 +166,10 @@
             return new Result<>(pnObject);
         }
 
-        public Result<TimedTransitionComponent, ModelViolation> addNewTimedTransitions(DataLayer c, Point p) {
+        public Result<TimedTransitionComponent, ModelViolation> addNewTimedTransitions(DataLayer c, Point p, boolean isUncontrollable) {
             dk.aau.cs.model.tapn.TimedTransition transition = new dk.aau.cs.model.tapn.TimedTransition(drawingSurface.getNameGenerator().getNewTransitionName(guiModelToModel.get(c)));
 
+            transition.setUncontrollable(isUncontrollable);
             TimedTransitionComponent pnObject = new TimedTransitionComponent(p.x, p.y, transition, lens);
 
             guiModelToModel.get(c).add(transition);
@@ -539,6 +538,40 @@
             }
         }
 
+        public void toggleUncontrollableTrans() {
+            ArrayList<PetriNetObject> selection = drawingSurface().getSelectionObject().getSelection();
+            TabContent currentTab = TabContent.this;
+            getUndoManager().newEdit();
+
+            for (PetriNetObject o : selection) {
+                if (o instanceof TimedTransitionComponent) {
+                    TimedTransitionComponent transition = (TimedTransitionComponent) o;
+                    Command cmd = new ToggleTransitionUncontrollable(transition.underlyingTransition(), currentTab);
+
+                    cmd.redo();
+                    getUndoManager().addEdit(cmd);
+                }
+            }
+            repaint();
+        }
+
+        public void toggleUrgentTrans() {
+            ArrayList<PetriNetObject> selection = drawingSurface().getSelectionObject().getSelection();
+            TabContent currentTab = TabContent.this;
+            getUndoManager().newEdit();
+
+            for (PetriNetObject o : selection) {
+                if (o instanceof TimedTransitionComponent) {
+                    TimedTransitionComponent transition = (TimedTransitionComponent) o;
+                    Command cmd = new ToggleTransitionUrgent(transition.underlyingTransition(), currentTab);
+
+                    cmd.redo();
+                    getUndoManager().addEdit(cmd);
+                }
+            }
+            repaint();
+        }
+
 
     }
 
@@ -1749,6 +1782,9 @@
             case TAPNTRANS:
                 setManager(new CanvasTransitionDrawController());
                 break;
+            case UNCONTROLLABLETRANS:
+                setManager(new CanvasUncontrollableTransitionDrawController());
+                break;
             case ANNOTATION:
                 setManager(new CanvasAnnotationNoteDrawController());
                 break;
@@ -2109,7 +2145,22 @@
         public void drawingSurfaceMousePressed(MouseEvent e) {
             Point p = canvas.adjustPointToGridAndZoom(e.getPoint(), canvas.getZoom());
 
-            guiModelManager.addNewTimedTransitions(drawingSurface.getGuiModel(), p);
+            guiModelManager.addNewTimedTransitions(drawingSurface.getGuiModel(), p, false);
+        }
+
+        @Override
+        public void registerEvents() {
+
+        }
+    }
+
+    class CanvasUncontrollableTransitionDrawController extends AbstractDrawingSurfaceManager {
+
+        @Override
+        public void drawingSurfaceMousePressed(MouseEvent e) {
+            Point p = canvas.adjustPointToGridAndZoom(e.getPoint(), canvas.getZoom());
+
+            guiModelManager.addNewTimedTransitions(drawingSurface.getGuiModel(), p, true);
         }
 
         @Override
@@ -2246,7 +2297,7 @@
                         var r = guiModelManager.addNewTimedPlace(getModel(), p);
                         placeClicked(r.result, e);
                     } else { //Transition
-                        var r = guiModelManager.addNewTimedTransitions(getModel(), p);
+                        var r = guiModelManager.addNewTimedTransitions(getModel(), p, false);
                         transitionClicked(r.result, e);
                     }
                 }
@@ -2667,10 +2718,14 @@
         }
     }
     public List<GuiAction> getAvailableDrawActions(){
-        if(lens.isTimed()){
-            return new ArrayList<>(Arrays.asList(selectAction, timedPlaceAction,transAction, timedArcAction, transportArcAction, inhibarcAction, tokenAction, deleteTokenAction));
-        } else{
-            return new ArrayList<>(Arrays.asList(selectAction, timedPlaceAction,transAction, timedArcAction, inhibarcAction, tokenAction, deleteTokenAction));
+        if (lens.isTimed() && !lens.isGame()) {
+            return new ArrayList<>(Arrays.asList(selectAction, timedPlaceAction, transAction, timedArcAction, transportArcAction, inhibarcAction, tokenAction, deleteTokenAction, annotationAction, toggleUrgentAction));
+        } else if (lens.isTimed()) {
+            return new ArrayList<>(Arrays.asList(selectAction, timedPlaceAction, transAction, uncontrollableTransAction, timedArcAction, transportArcAction, inhibarcAction, tokenAction, deleteTokenAction, annotationAction, toggleUrgentAction, toggleUncontrollableAction));
+        } else if (lens.isGame()){
+            return new ArrayList<>(Arrays.asList(selectAction, timedPlaceAction, transAction, uncontrollableTransAction, timedArcAction, inhibarcAction, tokenAction, deleteTokenAction, annotationAction, toggleUncontrollableAction));
+        } else {
+            return new ArrayList<>(Arrays.asList(selectAction, timedPlaceAction, transAction, timedArcAction, inhibarcAction, tokenAction, deleteTokenAction, annotationAction));
         }
     }
 
@@ -2704,6 +2759,11 @@
             setMode(Pipe.ElementType.TAPNTRANS);
         }
     };
+    private final GuiAction uncontrollableTransAction = new GuiAction("Uncontrollable transition", "Add an uncontrollable transition (L)", "L", true) {
+        public void actionPerformed(ActionEvent e) {
+            setMode(Pipe.ElementType.UNCONTROLLABLETRANS);
+        }
+    };
     private final GuiAction tokenAction = new GuiAction("Add token", "Add a token (+)", "typed +", true) {
         public void actionPerformed(ActionEvent e) {
             setMode(Pipe.ElementType.ADDTOKEN);
@@ -2731,6 +2791,16 @@
             setMode(Pipe.ElementType.TRANSPORTARC);
         }
     };
+    private final GuiAction toggleUncontrollableAction = new GuiAction("Toggle uncontrollable transition", "Toggle between control/environment transition", "E", true) {
+        public void actionPerformed(ActionEvent e) {
+            guiModelManager.toggleUncontrollableTrans();
+        }
+    };
+    private final GuiAction toggleUrgentAction = new GuiAction("Toggle urgent transition", "Toggle between urgent/non-urgent transition", "U", true) {
+        public void actionPerformed(ActionEvent e) {
+            guiModelManager.toggleUrgentTrans();
+        }
+    };
     private final GuiAction timeAction = new GuiAction("Delay one time unit", "Let time pass one time unit", "W") {
         public void actionPerformed(ActionEvent e) {
             timeDelay();
@@ -2746,6 +2816,7 @@
         // deselect other actions
         selectAction.setSelected(CreateGui.guiMode == Pipe.ElementType.SELECT);
         transAction.setSelected(editorMode == Pipe.ElementType.TAPNTRANS);
+        uncontrollableTransAction.setSelected(editorMode == Pipe.ElementType.UNCONTROLLABLETRANS);
         timedPlaceAction.setSelected(editorMode == Pipe.ElementType.TAPNPLACE);
         timedArcAction.setSelected(editorMode == Pipe.ElementType.TAPNARC);
         transportArcAction.setSelected(editorMode == Pipe.ElementType.TRANSPORTARC);
@@ -2760,6 +2831,7 @@
             case draw:
                 selectAction.setEnabled(true);
                 transAction.setEnabled(true);
+                uncontrollableTransAction.setEnabled(true);
                 timedPlaceAction.setEnabled(true);
                 timedArcAction.setEnabled(true);
                 transportArcAction.setEnabled(true);
@@ -2773,6 +2845,7 @@
             case noNet:
                 selectAction.setEnabled(false);
                 transAction.setEnabled(false);
+                uncontrollableTransAction.setEnabled(false);
                 timedPlaceAction.setEnabled(false);
                 timedArcAction.setEnabled(false);
                 transportArcAction.setEnabled(false);
@@ -2785,6 +2858,7 @@
             case animation:
                 selectAction.setEnabled(false);
                 transAction.setEnabled(false);
+                uncontrollableTransAction.setEnabled(false);
                 timedPlaceAction.setEnabled(false);
                 timedArcAction.setEnabled(false);
                 transportArcAction.setEnabled(false);
@@ -2805,6 +2879,7 @@
     public static final String textforTAPNPlace = "Place Mode: Right click on a place to see menu options ";
     public static final String textforTrans = "Transition Mode: Right click on a transition to see menu options [Mouse wheel -> rotate]";
     public static final String textforTimedTrans = "Timed Transition Mode: Right click on a transition to see menu options [Mouse wheel -> rotate]";
+    public static final String textforUncontrollableTrans = "Uncontrollable Transition Mode: Right click on a transition to see menu options [Mouse wheel -> rotate]";
     public static final String textforAddtoken = "Add Token Mode: Click on a place to add a token";
     public static final String textforDeltoken = "Delete Token Mode: Click on a place to delete a token ";
     public static final String textforAnimation = "Simulation Mode: Red transitions are enabled, click a transition to fire it";
@@ -2817,6 +2892,9 @@
 
     public void changeStatusbarText(Pipe.ElementType type) {
         switch (type) {
+            case UNCONTROLLABLETRANS:
+                app.ifPresent(o14 -> o14.setStatusBarText(textforUncontrollableTrans));
+
             case PLACE:
                 app.ifPresent(o13 -> o13.setStatusBarText(textforPlace));
                 break;
 
=== modified file 'src/net/tapaal/swinghelpers/ToggleButtonWithoutText.java'
--- src/net/tapaal/swinghelpers/ToggleButtonWithoutText.java	2019-11-05 12:19:17 +0000
+++ src/net/tapaal/swinghelpers/ToggleButtonWithoutText.java	2020-08-21 08:37:32 +0000
@@ -1,6 +1,7 @@
 package net.tapaal.swinghelpers;
 
 import javax.swing.*;
+import java.awt.*;
 
 /**
  * A JToggleButton that without any text
@@ -9,10 +10,11 @@
 
     public ToggleButtonWithoutText(Action a) {
         super(a);
-        if (a.getValue(Action.SMALL_ICON) != null) {
-            // toggle buttons like to have images *and* text, nasty
-            setText(null);
+        if (a.getValue(Action.SMALL_ICON) == null) {
+            setVisible(false);
         }
+        setText(null);
+
         this.setRequestFocusEnabled(false);
     }
 
 
=== modified file 'src/pipe/gui/GuiFrame.java'
--- src/pipe/gui/GuiFrame.java	2020-08-14 09:41:34 +0000
+++ src/pipe/gui/GuiFrame.java	2020-08-21 08:37:32 +0000
@@ -1167,7 +1167,6 @@
                 drawMenu.add(action);
             }
 
-            drawingToolBar.addSeparator();
             drawingToolBar.add(featureInfoText);
         } else {
             drawMenu.setEnabled(false);
 
=== modified file 'src/pipe/gui/Pipe.java'
--- src/pipe/gui/Pipe.java	2020-07-16 10:02:06 +0000
+++ src/pipe/gui/Pipe.java	2020-08-21 08:37:32 +0000
@@ -8,7 +8,7 @@
 	public enum ElementType {
 		PLACE, IMMTRANS, TIMEDTRANS, ANNOTATION, ARC, INHIBARC, 
 		//TAPN Elements
-		TAPNPLACE, TAPNTRANS, TAPNARC, TRANSPORTARC, TAPNINHIBITOR_ARC,
+		TAPNPLACE, TAPNTRANS, UNCONTROLLABLETRANS, TAPNARC, TRANSPORTARC, TAPNINHIBITOR_ARC,
 		//Others (might refactore)
 		ADDTOKEN, DELTOKEN, SELECT, DRAW, DRAG,
 	}
 
=== modified file 'src/pipe/gui/handler/TransitionHandler.java'
--- src/pipe/gui/handler/TransitionHandler.java	2020-07-20 07:19:51 +0000
+++ src/pipe/gui/handler/TransitionHandler.java	2020-08-21 08:37:32 +0000
@@ -11,8 +11,7 @@
 /**
  * Class used to implement methods corresponding to mouse events on transitions.
  */
-public class TransitionHandler extends PlaceTransitionObjectHandler implements
-		java.awt.event.MouseWheelListener {
+public class TransitionHandler extends PlaceTransitionObjectHandler implements java.awt.event.MouseWheelListener {
 
 	public TransitionHandler(Transition obj) {
 		super(obj);
@@ -42,6 +41,4 @@
 
 		return popup;
 	}
-
-
 }
 
=== added file 'src/resources/Images/Uncontrollable transition.png'
 Binary files src/resources/Images/Uncontrollable transition.png	1970-01-01 00:00:00 +0000 and src/resources/Images/Uncontrollable transition.png	2020-08-21 08:37:32 +0000 differ