Merge pull request #502 from ThomasJClark/palette-gui

JLLeitschuh · JLLeitschuh · commit 42004a47c71d · 2016-02-18T00:32:08.000-05:00
Add palette categories
diff --git a/buildSrc/src/main/java/edu/wpi/gripgenerator/templates/Operation.java b/buildSrc/src/main/java/edu/wpi/gripgenerator/templates/Operation.java
@@ -126,6 +126,21 @@ private MethodDeclaration getDescriptionMethod() {
         return getDescription;
     }
 
+    private MethodDeclaration getCategoryMethod() {
+        MethodDeclaration getCategory = new MethodDeclaration(
+                ModifierSet.PUBLIC,
+                Collections.singletonList(OVERRIDE_ANNOTATION),
+                null,
+                createReferenceType("Category", 0),
+                "getCategory",
+                null, 0,
+                null,
+                null
+        );
+        getCategory.setBody(new BlockStmt(Collections.singletonList(new ReturnStmt(new NameExpr("Category.OPENCV")))));
+        return getCategory;
+    }
+
     /**
      * Creates the method that returns the input socket of this operation.
      *
@@ -280,6 +295,7 @@ private ClassOrInterfaceDeclaration getClassDeclaration() {
                 .collect(Collectors.toList()));
         ASTHelper.addMember(operation, getNameMethod());
         ASTHelper.addMember(operation, getDescriptionMethod());
+        ASTHelper.addMember(operation, getCategoryMethod());
         ASTHelper.addMember(operation, getCreateInputSocketsMethod());
         ASTHelper.addMember(operation, getCreateOutputSocketsMethod());
         ASTHelper.addMember(operation, getPerformMethod());
diff --git a/core/src/main/java/edu/wpi/grip/core/Operation.java b/core/src/main/java/edu/wpi/grip/core/Operation.java
@@ -11,6 +11,14 @@
  */
 public interface Operation {
 
+    enum Category {
+        IMAGE_PROCESSING,
+        FEATURE_DETECTION,
+        NETWORK,
+        OPENCV,
+        MISCELLANEOUS,
+    }
+
     /**
      * @return The unique user-facing name of the operation, such as "Gaussian Blur"
      */
@@ -22,6 +30,13 @@ public interface Operation {
      */
     String getDescription();
 
+    /**
+     * @return What category the operation falls under.  This is used to organize them in the GUI
+     */
+    default Category getCategory() {
+        return Category.MISCELLANEOUS;
+    }
+
     /**
      * @return An {@link InputStream} of a 128x128 image to show the user as a representation of the operation.
      */
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/Operations.java b/core/src/main/java/edu/wpi/grip/core/operations/Operations.java
@@ -33,9 +33,9 @@ public static void addOperations(EventBus eventBus) {
         eventBus.post(new OperationAddedEvent(new FilterLinesOperation()));
         eventBus.post(new OperationAddedEvent(new MaskOperation()));
         eventBus.post(new OperationAddedEvent(new MinMaxLoc()));
+        eventBus.post(new OperationAddedEvent(new MatFieldAccessor()));
         eventBus.post(new OperationAddedEvent(new NewPointOperation()));
         eventBus.post(new OperationAddedEvent(new NewSizeOperation()));
-        eventBus.post(new OperationAddedEvent(new MatFieldAccessor()));
         eventBus.post(new OperationAddedEvent(new NTPublishOperation<>(Number.class, NTNumber.class, NTNumber::new)));
         eventBus.post(new OperationAddedEvent(new NTPublishOperation<>(Point.class, NTVector2D.class, NTVector2D::new)));
         eventBus.post(new OperationAddedEvent(new NTPublishOperation<>(Size.class, NTVector2D.class, NTVector2D::new)));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/BlurOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/BlurOperation.java
@@ -46,6 +46,11 @@ public String getDescription() {
         return "Soften the details of an image to remove noise.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.IMAGE_PROCESSING;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/blur.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/ConvexHullsOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/ConvexHullsOperation.java
@@ -31,6 +31,11 @@ public String getDescription() {
         return "Compute the convex hulls of contours.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.FEATURE_DETECTION;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/convex-hulls.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/DesaturateOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/DesaturateOperation.java
@@ -27,6 +27,11 @@ public String getDescription() {
         return "Convert a color image into shades of gray.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.IMAGE_PROCESSING;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/desaturate.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/FilterContoursOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/FilterContoursOperation.java
@@ -55,6 +55,11 @@ public String getDescription() {
         return "Find contours matching certain criteria.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.FEATURE_DETECTION;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/find-contours.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/FilterLinesOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/FilterLinesOperation.java
@@ -34,6 +34,11 @@ public String getDescription() {
         return "Filter only lines from a Find Lines operation that fit certain criteria.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.FEATURE_DETECTION;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/filter-lines.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/FindBlobsOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/FindBlobsOperation.java
@@ -36,6 +36,11 @@ public String getDescription() {
         return "Detect groups of pixels in an image.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.FEATURE_DETECTION;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/find-blobs.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/FindContoursOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/FindContoursOperation.java
@@ -33,6 +33,11 @@ public String getDescription() {
         return "Detect contours in a binary image.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.FEATURE_DETECTION;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/find-contours.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/FindLinesOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/FindLinesOperation.java
@@ -31,6 +31,11 @@ public String getDescription() {
         return "Detect line segments in an image.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.FEATURE_DETECTION;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/find-lines.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/MaskOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/MaskOperation.java
@@ -29,6 +29,11 @@ public String getDescription() {
         return "Filter out an area of interest in an image using a binary mask.";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.IMAGE_PROCESSING;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/mask.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/PublishVideoOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/PublishVideoOperation.java
@@ -123,6 +123,11 @@ public String getDescription() {
         return "Publish an M-JPEG stream to the dashboard";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.NETWORK;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/publish-video.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/ResizeOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/ResizeOperation.java
@@ -52,6 +52,11 @@ public String getDescription() {
         return "Scale an image to an exact size";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.IMAGE_PROCESSING;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/resize.png"));
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/composite/ThresholdOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/composite/ThresholdOperation.java
@@ -14,6 +14,11 @@ public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/threshold.png"));
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.IMAGE_PROCESSING;
+    }
+
     @Override
     public Optional<Mat[]> createData() {
         return Optional.of(new Mat[]{new Mat(), new Mat(), new Mat()});
diff --git a/core/src/main/java/edu/wpi/grip/core/operations/networktables/NTPublishOperation.java b/core/src/main/java/edu/wpi/grip/core/operations/networktables/NTPublishOperation.java
@@ -85,6 +85,11 @@ public String getDescription() {
         return "Publish a " + type.getSimpleName() + " to NetworkTables";
     }
 
+    @Override
+    public Category getCategory() {
+        return Category.NETWORK;
+    }
+
     @Override
     public Optional<InputStream> getIcon() {
         return Optional.of(getClass().getResourceAsStream("/edu/wpi/grip/ui/icons/first.png"));
diff --git a/ui/src/main/java/edu/wpi/grip/ui/OperationListController.java b/ui/src/main/java/edu/wpi/grip/ui/OperationListController.java
@@ -0,0 +1,101 @@
+package edu.wpi.grip.ui;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.eventbus.Subscribe;
+import com.sun.javafx.application.PlatformImpl;
+import edu.wpi.grip.core.Operation;
+import edu.wpi.grip.core.events.OperationAddedEvent;
+import edu.wpi.grip.ui.annotations.ParametrizedController;
+import edu.wpi.grip.ui.util.ControllerMap;
+import edu.wpi.grip.ui.util.SearchUtility;
+import javafx.beans.InvalidationListener;
+import javafx.beans.property.SimpleStringProperty;
+import javafx.beans.property.StringProperty;
+import javafx.collections.MapChangeListener;
+import javafx.fxml.FXML;
+import javafx.scene.Node;
+import javafx.scene.control.Tab;
+import javafx.scene.layout.VBox;
+
+import javax.inject.Inject;
+
+/**
+ * Controller for a VBox of {@link OperationController}s.  The user data for this should be what category it shows,
+ * and the filterText property allows for fuzzy searching the operations.
+ *
+ * @see edu.wpi.grip.core.Operation.Category
+ */
+@ParametrizedController(url = "OperationList.fxml")
+public class OperationListController {
+
+    protected final static String FILTER_TEXT = "filterText";
+
+    @FXML private Tab root;
+    @FXML private VBox operations;
+
+    @Inject private OperationController.Factory operationControllerFactory;
+
+    private final StringProperty filterText = new SimpleStringProperty(this, FILTER_TEXT, "");
+    private String baseText = null;
+    private ControllerMap<OperationController, Node> operationsMapManager;
+
+    @FXML
+    public void initialize() {
+        operationsMapManager = new ControllerMap<>(operations.getChildren());
+        baseText = root.getText();
+
+        InvalidationListener filterOperations = observable -> {
+            if (baseText == null) {
+                baseText = root.getText();
+            }
+
+            // Show only operations matching the current filter text
+            String filter = filterText.getValue();
+            long numMatches = operationsMapManager.keySet().stream()
+                    .filter(key -> {
+                        boolean visible = SearchUtility.fuzzyContains(key.getOperation().getName(), filter)
+                                || SearchUtility.fuzzyContains(key.getOperation().getDescription(), filter);
+                        operationsMapManager.get(key).setVisible(visible);
+                        return visible;
+                    }).count();
+
+            if (!filter.isEmpty() && numMatches > 0) {
+                // If we're filtering some operations and there's at least one match, set the title to bold and show the
+                // number of matches.  This lets the user quickly see which tabs have matching operations when
+                // searching.
+                root.setText(baseText + " (" + numMatches + ")");
+                root.styleProperty().setValue("-fx-font-weight: bold");
+            } else {
+                root.setText(baseText);
+                root.styleProperty().setValue("");
+            }
+        };
+
+        operations.getChildren().addListener(filterOperations);
+        filterText.addListener(filterOperations);
+
+        root.getProperties().addListener((MapChangeListener<? super Object, ? super Object>) change -> {
+            if (change.getKey().equals(filterText.getName())) {
+                filterText.setValue((String) root.getProperties().get(filterText.getName()));
+            }
+        });
+    }
+
+    @Subscribe
+    public void onOperationAdded(OperationAddedEvent event) {
+        Operation operation = event.getOperation();
+
+        if (root.getUserData() == null || operation.getCategory() == root.getUserData()) {
+            PlatformImpl.runAndWait(() ->
+                    operationsMapManager.add(operationControllerFactory.create(event.getOperation())));
+        }
+    }
+
+    /**
+     * Remove all operations.  Used for tests.
+     */
+    @VisibleForTesting
+    void clearOperations() {
+        operationsMapManager.clear();
+    }
+}
diff --git a/ui/src/main/java/edu/wpi/grip/ui/PaletteController.java b/ui/src/main/java/edu/wpi/grip/ui/PaletteController.java
diff --git a/ui/src/main/resources/edu/wpi/grip/ui/GRIP.css b/ui/src/main/resources/edu/wpi/grip/ui/GRIP.css
diff --git a/ui/src/main/resources/edu/wpi/grip/ui/MainWindow.fxml.orig b/ui/src/main/resources/edu/wpi/grip/ui/MainWindow.fxml.orig
diff --git a/ui/src/main/resources/edu/wpi/grip/ui/OperationList.fxml b/ui/src/main/resources/edu/wpi/grip/ui/OperationList.fxml
diff --git a/ui/src/main/resources/edu/wpi/grip/ui/Palette.fxml b/ui/src/main/resources/edu/wpi/grip/ui/Palette.fxml
diff --git a/ui/src/test/java/edu/wpi/grip/ui/MainWindowTest.java b/ui/src/test/java/edu/wpi/grip/ui/MainWindowTest.java
diff --git a/ui/src/test/java/edu/wpi/grip/ui/PaletteTest.java b/ui/src/test/java/edu/wpi/grip/ui/PaletteTest.java
