Team Thermometers final merge

puzzles files/thermometer/therm_test.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<Legup version="5.1.0">
+    <puzzle name="Thermometer">
+        <board height="4" width="4">
+            <vials>
+                <vial headx="0" heady="0" tailx="2" taily="0"/>
+                <vial headx="3" heady="0" tailx="3" taily="3"/>
+                <vial headx="0" heady="1" tailx="1" taily="1"/>
+                <vial headx="2" heady="1" tailx="2" taily="3"/>
+                <vial headx="0" heady="3" tailx="0" taily="2"/>
+                <vial headx="1" heady="2" tailx="1" taily="3"/>
+            </vials>
+            <rowNumbers>
+                <row value="2"/>
+                <row value="4"/>
+                <row value="2"/>
+                <row value="1"/>
+            </rowNumbers>
+            <colNumbers>
+                <col value="3"/>
+                <col value="2"/>
+                <col value="2"/>
+                <col value="2"/>
+            </colNumbers>
+        </board>
+    </puzzle>
+</Legup>

src/main/java/edu/rpi/legup/puzzle/thermometer/Thermometer.java

@@ -0,0 +1,56 @@
+package edu.rpi.legup.puzzle.thermometer;
+
+import edu.rpi.legup.model.Puzzle;
+import edu.rpi.legup.model.gameboard.Board;
+
+// basically just copy-pasted from dev guide on wiki
+public class Thermometer extends Puzzle {
+    public Thermometer() {
+        super();
+
+        this.name = "Thermometer";
+
+        this.importer = new ThermometerImporter(this);
+        this.exporter = new ThermometerExporter(this);
+        // we do not have a thermometerCellFactory class as
+        // thermometerVial has its own thermometerCell factory method
+    }
+
+    /** Initializes the game board. Called by the invoker of the class */
+    @Override
+    public void initializeView() {
+        boardView = new ThermometerView((ThermometerBoard) currentBoard);
+        boardView.setBoard(currentBoard);
+        addBoardListener(boardView);
+    }
+
+    /**
+     * Generates a random edu.rpi.legup.puzzle based on the difficulty
+     *
+     * @param difficulty level of difficulty (1-10)
+     * @return board of the random edu.rpi.legup.puzzle
+     */
+    @Override
+    public Board generatePuzzle(int difficulty) {
+        return null;
+    }
+
+    /**
+     * Determines if the current board is a valid state
+     *
+     * @param board board to check for validity
+     * @return true if board is valid, false otherwise
+     */
+    @Override
+    public boolean isBoardComplete(Board board) {
+        return true;
+    }
+
+    /**
+     * Callback for when the board puzzleElement changes
+     *
+     * @param board the board that has changed
+     */
+    @Override
+    public void onBoardChange(Board board) {}
+}

src/main/java/edu/rpi/legup/puzzle/thermometer/ThermometerBoard.java

@@ -0,0 +1,139 @@
+package edu.rpi.legup.puzzle.thermometer;
+
+import edu.rpi.legup.model.gameboard.GridBoard;
+import java.awt.*;
+import java.util.ArrayList;
+
+public class ThermometerBoard extends GridBoard {
+
+    // an array containing all of our vials on the board
+    private ArrayList<ThermometerVial> thermometerVials;
+
+    // representations of the number requirements along rows and columns of the board
+    // we use rotation to store the number
+    private ArrayList<ThermometerCell> colNumbers;
+    private ArrayList<ThermometerCell> rowNumbers;
+
+    private ThermometerCell dummyCell;
+
+    // constructors for the boards and variables
+    public ThermometerBoard(int width, int height) {
+        super(width, height);
+
+        // initializing the row/col number arrays with zeros, so they can be
+        // easily updated using the setRow/ColNumber functions
+        colNumbers = new ArrayList<>();
+        for (int i = 0; i < width - 1; i++) {
+            ThermometerCell cell =
+                    new ThermometerCell(
+                            new Point(i, height - 1),
+                            ThermometerType.UNKNOWN,
+                            ThermometerFill.UNKNOWN,
+                            0);
+            cell.setIndex((height - 1) * height + i);
+            colNumbers.add(cell);
+            this.setCell(i, height - 1, cell);
+        }
+        rowNumbers = new ArrayList<>();
+        for (int i = 0; i < height - 1; i++) {
+            ThermometerCell cell =
+                    new ThermometerCell(
+                            new Point(width - 1, i),
+                            ThermometerType.UNKNOWN,
+                            ThermometerFill.UNKNOWN,
+                            0);
+            cell.setIndex(i * height + (width - 1));
+            rowNumbers.add(cell);
+            this.setCell(width - 1, i, cell);
+        }
+
+        // setting a dummy cell so board doesn't have null cells
+        dummyCell =
+                new ThermometerCell(
+                        new Point(width - 1, height - 1),
+                        ThermometerType.UNKNOWN,
+                        ThermometerFill.UNKNOWN,
+                        -1);
+        dummyCell.setIndex((height - 1) * height + width);
+        this.setCell(width - 1, height - 1, dummyCell);
+
+        // creating our empty vial of thermometers to add to
+        thermometerVials = new ArrayList<>();
+    }
+
+    // setters and accessors for our array of vials
+    public void addVial(ThermometerVial v) {
+        thermometerVials.add(v);
+    }
+
+    public ArrayList<ThermometerVial> getVials() {
+        return thermometerVials;
+    }
+
+    // our setters for row/col numbers with simple input verification
+    public boolean setRowNumber(int row, int num) {
+        // first check is to verify we are updating an element in range
+        // second check is to verify the new number can be achieved by the puzzle
+        if (row < rowNumbers.size() && num <= colNumbers.size()) {
+            rowNumbers.get(row).setRotation(num);
+            return true;
+        }
+        return false;
+    }
+
+    public boolean setColNumber(int col, int num) {
+        // first check is to verify we are updating an element in range
+        // second check is to verify the new number can be achieved by the puzzle
+        if (col < colNumbers.size() && num <= rowNumbers.size()) {
+            colNumbers.get(col).setRotation(num);
+            return true;
+        }
+        return false;
+    }
+
+    // basic accessors for row/col numbers
+    public int getRowNumber(int row) {
+        if (row < 0 || row >= rowNumbers.size()) return -1;
+        return rowNumbers.get(row).getRotation();
+    }
+
+    public int getColNumber(int col) {
+        if (col < 0 || col >= rowNumbers.size()) return -1;
+        return colNumbers.get(col).getRotation();
+    }
+
+    // Accessors for saving row/column
+    public ArrayList<ThermometerCell> getRowNumbers() {
+        return rowNumbers;
+    }
+
+    public ArrayList<ThermometerCell> getColNumbers() {
+        return colNumbers;
+    }
+
+    // we all suck at programming so instead of using provided array list
+    // we use our own array lists to keep track of the vials
+    // marginally useful because it means we are guaranteed to get a
+    // thermometer cell when calling get cell, but using some type casting
+    // this override function could very likely be refactored out
+    @Override
+    public ThermometerCell getCell(int x, int y) {
+        for (ThermometerVial vial : this.thermometerVials) {
+            for (ThermometerCell cell : vial.getCells()) {
+                if (cell.getLocation().x == x && cell.getLocation().y == y) return cell;
+            }
+        }
+
+        for (ThermometerCell cell : rowNumbers) {
+            if (cell.getLocation().x == x && cell.getLocation().y == y) return cell;
+        }
+
+        for (ThermometerCell cell : colNumbers) {
+            if (cell.getLocation().x == x && cell.getLocation().y == y) return cell;
+        }
+
+        if (x == this.getWidth() - 1 && y == this.getHeight() - 1) return dummyCell;
+
+        return null;
+    }
+}

src/main/java/edu/rpi/legup/puzzle/thermometer/ThermometerCell.java

@@ -0,0 +1,67 @@
+package edu.rpi.legup.puzzle.thermometer;
+
+import edu.rpi.legup.model.gameboard.GridCell;
+import java.awt.Point;
+
+public class ThermometerCell extends GridCell<Integer> {
+
+    // information about the cell needed to display it
+    private ThermometerType type;
+    private ThermometerFill fill;
+    private int rotation;
+
+    public ThermometerCell(Point location, ThermometerType t, ThermometerFill f, int r) {
+        // since we do not use get/set data value int can be any value
+        super(1, location);
+        type = t;
+        fill = f;
+        rotation = r;
+    }
+
+    // Note: setdata does not work for our purposes
+    public void setType(ThermometerType t) {
+        type = t;
+    }
+
+    public ThermometerType getType() {
+        return type;
+    }
+
+    public void setFill(ThermometerFill f) {
+        fill = f;
+    }
+
+    public ThermometerFill getFill() {
+        return fill;
+    }
+
+    public void setRotation(int r) {
+        rotation = r;
+    }
+
+    public int getRotation() {
+        return rotation;
+    }
+
+    @Override
+    public ThermometerCell copy() {
+        ThermometerCell copy =
+                new ThermometerCell((Point) location.clone(), this.type, this.fill, this.rotation);
+        copy.setIndex(index);
+        copy.setModifiable(isModifiable);
+        copy.setGiven(isGiven);
+        return copy;
+    }
+
+    @Override
+    public String toString() {
+        return "("
+                + location.getX()
+                + ", "
+                + location.getY()
+                + ") TYPE = "
+                + getType()
+                + " FILL = "
+                + getFill();
+    }
+}

src/main/java/edu/rpi/legup/puzzle/thermometer/ThermometerController.java

@@ -0,0 +1,44 @@
+package edu.rpi.legup.puzzle.thermometer;
+
+import edu.rpi.legup.controller.ElementController;
+import edu.rpi.legup.model.gameboard.PuzzleElement;
+import java.awt.event.MouseEvent;
+
+public class ThermometerController extends ElementController {
+
+    // method for updating thermometer cells since number cells have unknown for
+    // their fill type we don't need to worry about end user modifying them with this
+    @Override
+    public void changeCell(MouseEvent e, PuzzleElement data) {
+        ThermometerCell cell = (ThermometerCell) data;
+
+        if (e.getButton() == MouseEvent.BUTTON1) {
+            if (e.isControlDown()) {
+                this.boardView
+                        .getSelectionPopupMenu()
+                        .show(
+                                boardView,
+                                this.boardView.getCanvas().getX() + e.getX(),
+                                this.boardView.getCanvas().getY() + e.getY());
+            } else {
+                if (cell.getFill() == ThermometerFill.EMPTY) {
+                    cell.setFill(ThermometerFill.FILLED);
+                } else if (cell.getFill() == ThermometerFill.FILLED) {
+                    cell.setFill(ThermometerFill.BLOCKED);
+                } else {
+                    cell.setFill(ThermometerFill.EMPTY);
+                }
+            }
+        } else if (e.getButton() == MouseEvent.BUTTON3) {
+            if (cell.getFill() == ThermometerFill.EMPTY) {
+                cell.setFill(ThermometerFill.BLOCKED);
+            } else if (cell.getFill() == ThermometerFill.BLOCKED) {
+                cell.setFill(ThermometerFill.FILLED);
+            } else {
+                cell.setFill(ThermometerFill.EMPTY);
+            }
+        } else if (e.getButton() == MouseEvent.BUTTON2) {
+            System.out.println("[DEBUG] " + cell);
+        }
+    }
+}