src/net/sourceforge/desert/ui/DesertPanel.java

   1 /*
   2  * Copyright (c) 2010 The Desert team
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use,
   8  * copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following
  11  * conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  18  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  20  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  21  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  *
  25  */
  26 package net.sourceforge.desert.ui;
  27
  28 import java.awt.BorderLayout;
  29 import java.awt.Button;
  30 import java.awt.Checkbox;
  31 import java.awt.Choice;
  32 import java.awt.Component;
  33 import java.awt.Label;
  34 import java.awt.Panel;
  35 import java.awt.event.ActionEvent;
  36 import java.awt.event.ActionListener;
  37 import java.awt.event.ItemEvent;
  38 import java.awt.event.ItemListener;
  39 import java.awt.event.MouseMotionListener;
  40 import java.awt.event.MouseEvent;
  41 import java.util.List;
  42 import java.util.ResourceBundle;
  43 import java.util.logging.Level;
  44 import java.util.logging.Logger;
  45
  46 import javax.swing.Box;
  47
  48 import net.sourceforge.desert.ImageFilter;
  49 import net.sourceforge.desert.ImageFilterClearImplementation;
  50 import net.sourceforge.desert.ImageFilterFadeImplementation;
  51 import net.sourceforge.desert.Particle;
  52 import net.sourceforge.desert.ParticleEngine;
  53 import net.sourceforge.desert.Utilities;
  54
  55 /**
  56  *
  57  * @author codistmonk (creation 2010-04-15)
  58  */
  59 @SuppressWarnings("serial")
  60 public class DesertPanel extends Panel {
  61
  62     private final Timer timer;
  63
  64     private final DrawingBoard drawingBoard;
  65
  66     public DesertPanel() {
  67         super(new BorderLayout());
  68         this.timer = new Timer(FRAMERATE);
  69         this.drawingBoard = new DrawingBoard();
  70
  71         final CursorPositionLabel xyMouse = new CursorPositionLabel();
  72         final FramerateLabel framerateLabel = new FramerateLabel();
  73         final ParticleCountLabel particleCountLabel = this.new ParticleCountLabel();
  74         final Checkbox pauseButton = new Checkbox("Pause");
  75         final Button resetButton = new Button("Reset");
  76
  77         this.add(this.getDrawingBoard(), BorderLayout.CENTER);
  78         this.add(verticalBox(
  79                 horizontalBox(framerateLabel, particleCountLabel, xyMouse),
  80                 horizontalBox(resetButton, pauseButton),
  81                 horizontalBox(new Label("Particle type: "), this.new ParticleTypeChoice()),
  82                 horizontalBox(new Label("Image filter: "), this.new ImageFilterChoice()),
  83                 horizontalBox(new Label("Brush mode: "), this.new BrushModeChoice(), new Label("Brush shape: "), this.new BrushChoice())
  84         ), BorderLayout.SOUTH);
  85
  86         pauseButton.addItemListener(this.new Pause());
  87         resetButton.addActionListener(this.new Reset());
  88
  89         this.getTimer().addActionListener(this.getDrawingBoard());
  90         this.getDrawingBoard().addMouseMotionListener(xyMouse);
  91         this.getDrawingBoard().setParticleEngine(new ParticleEngine());
  92         this.getTimer().addActionListener(framerateLabel);
  93         this.getTimer().addActionListener(particleCountLabel);
  94     }
  95
  96     /**
  97      *
  98      * @return
  99      * <br>A non-null value
 100      * <br>A reference
 101      */
 102     public final Timer getTimer() {
 103         return this.timer;
 104     }
 105
 106     /**
 107      *
 108      * @return
 109      * <br>A non-null value
 110      * <br>A reference
 111      */
 112     public final DrawingBoard getDrawingBoard() {
 113         return this.drawingBoard;
 114     }
 115
 116     /**
 117      *
 118      * @author codistmonk (creation 2010-04-20)
 119      */
 120     private final class Reset implements ActionListener {
 121
 122         @Override
 123         public final void actionPerformed(final ActionEvent event) {
 124             DesertPanel.this.getDrawingBoard().getParticleEngine().removeAllParticles();
 125         }
 126
 127     }
 128
 129     /**
 130      *
 131      * @author codistmonk (creation 2010-04-20)
 132      */
 133     private final class Pause implements ItemListener {
 134
 135         @Override
 136         public final void itemStateChanged(final ItemEvent event) {
 137             DesertPanel.this.getDrawingBoard().setPaused(event.getStateChange() == ItemEvent.SELECTED);
 138         }
 139
 140     }
 141
 142     /**
 143      *
 144      * @author codistmonk (creation 2010-04-21)
 145      */
 146     @SuppressWarnings("serial")
 147     private final class ImageFilterChoice extends Choice {
 148
 149         public ImageFilterChoice() {
 150             this.add("Clear");
 151             this.add("Fade");
 152
 153             this.addItemListener(this.new ItemHandler());
 154         }
 155
 156         /**
 157          *
 158          * @author codistmonk (creation 2010-04-17)
 159          */
 160         private final class ItemHandler implements ItemListener {
 161
 162             @Override
 163             public final void itemStateChanged(final ItemEvent event) {
 164                 if (event.getStateChange() == ItemEvent.SELECTED) {
 165                     try {
 166                         DesertPanel.this.getDrawingBoard().setImageFilter(this.createImageFilter());
 167                     } catch (final InstantiationException exception) {
 168                         Logger.getLogger(DesertPanel.class.getName()).log(Level.SEVERE, null, exception);
 169                     } catch (final IllegalAccessException exception) {
 170                         Logger.getLogger(DesertPanel.class.getName()).log(Level.SEVERE, null, exception);
 171                     }
 172                 }
 173             }
 174
 175             /**
 176             * @return
 177             * <br>A new value
 178             * <br>A non-null value
 179             * @throws InstantiationException
 180             * @throws IllegalAccessException
 181             */
 182             private final ImageFilter createImageFilter() throws InstantiationException, IllegalAccessException {
 183                 return (ImageFilter) new Class<?>[] {
 184                             ImageFilterClearImplementation.class,
 185                             ImageFilterFadeImplementation.class
 186                 }[ImageFilterChoice.this.getSelectedIndex()].newInstance();
 187             }
 188
 189         }
 190
 191     }
 192
 193     /**
 194      *
 195      * @author andrew (creation 2010-04-17)
 196      */
 197     @SuppressWarnings("serial")
 198     private final class ParticleTypeChoice extends Choice {
 199
 200         public ParticleTypeChoice() {
 201             final ResourceBundle resourceBundle = ResourceBundle.getBundle(Utilities.RESOURCE_BASE + "messages");
 202
 203             for (final Particle.Type type : Particle.Type.values()) {
 204                 this.addItem(resourceBundle.getString(type.toString()));
 205             }
 206
 207             this.updateDrawingBoardParticleType();
 208
 209             this.addItemListener(this.new ItemHandler());
 210         }
 211
 212         final void updateDrawingBoardParticleType() {
 213             DesertPanel.this.getDrawingBoard().setParticleType(
 214                     Particle.Type.values()[ParticleTypeChoice.this.getSelectedIndex()]);
 215         }
 216
 217         /**
 218          *
 219          * @author andrew (creation 2010-04-17)
 220          */
 221         private final class ItemHandler implements ItemListener {
 222
 223             @Override
 224             public final void itemStateChanged(final ItemEvent event) {
 225                 if (event.getStateChange() == ItemEvent.SELECTED) {
 226                     ParticleTypeChoice.this.updateDrawingBoardParticleType();
 227                 }
 228             }
 229
 230         }
 231
 232     }
 233
 234     /**
 235      *
 236      * @author codistmonk (creation 2010-04-28)
 237      */
 238     @SuppressWarnings("serial")
 239     private final class BrushModeChoice extends Choice {
 240
 241         public BrushModeChoice() {
 242             this.addItem("Add");
 243             this.addItem("Erase");
 244
 245             this.updateDrawingBoardBrushMode();
 246
 247             this.addItemListener(this.new ItemHandler());
 248         }
 249
 250         final void updateDrawingBoardBrushMode() {
 251             DesertPanel.this.getDrawingBoard().setBrushMode(
 252                     DrawingBoard.BrushMode.values()[BrushModeChoice.this.getSelectedIndex()]);
 253         }
 254
 255         /**
 256          *
 257          * @author andrew (creation 2010-04-17)
 258          */
 259         private final class ItemHandler implements ItemListener {
 260
 261             @Override
 262             public final void itemStateChanged(final ItemEvent event) {
 263                 if (event.getStateChange() == ItemEvent.SELECTED) {
 264                     BrushModeChoice.this.updateDrawingBoardBrushMode();
 265                 }
 266             }
 267
 268         }
 269
 270     }
 271
 272     /**
 273      *
 274      * @author codistmonk (creation 2010-04-25)
 275      */
 276     @SuppressWarnings("serial")
 277     private final class BrushChoice extends Choice {
 278
 279         private final List<String> brushPaths;
 280
 281         public BrushChoice() {
 282             this.brushPaths = Utilities.listBrushPaths();
 283
 284             for (final String brushPath : this.brushPaths) {
 285                 this.addItem(getUserReadableBrushName(brushPath));
 286             }
 287
 288             this.updateDrawingBoardBrush();
 289
 290             this.addItemListener(this.new ItemHandler());
 291         }
 292
 293         final void updateDrawingBoardBrush() {
 294             DesertPanel.this.getDrawingBoard().setBrush(
 295                     Utilities.getBrush(this.brushPaths.get(BrushChoice.this.getSelectedIndex())));
 296         }
 297
 298         /**
 299          *
 300          * @author condistmonk (creation 2010-04-25)
 301          */
 302         private final class ItemHandler implements ItemListener {
 303
 304             @Override
 305             public final void itemStateChanged(final ItemEvent event) {
 306                 if (event.getStateChange() == ItemEvent.SELECTED) {
 307                     BrushChoice.this.updateDrawingBoardBrush();
 308                 }
 309             }
 310
 311         }
 312
 313     }
 314
 315     /**
 316      *
 317      * @author codistmonk (creation 2010-04-15)
 318      */
 319     @SuppressWarnings("serial")
 320     private final class ParticleCountLabel extends Label implements ActionListener {
 321
 322         @Override
 323         public final void actionPerformed(final ActionEvent event) {
 324             this.setText("Particle count: " + DesertPanel.this.getDrawingBoard().getParticleCount());
 325         }
 326
 327     }
 328
 329     /**
 330      *
 331      * @author andrew (creation 2010-04-19)
 332      */
 333     @SuppressWarnings("serial")
 334     private final class CursorPositionLabel extends Label implements MouseMotionListener {
 335
 336         @Override
 337         public final void mouseMoved(final MouseEvent event) {
 338             this.updateText(event);
 339         }
 340
 341         @Override
 342         public final void mouseDragged(final MouseEvent event) {
 343             this.updateText(event);
 344         }
 345
 346         /**
 347          *
 348          * @param event
 349          * <br>Should not be null
 350          */
 351         private final void updateText(final MouseEvent event) {
 352             this.setText("(" + event.getX() + ", " +
 353                     (DesertPanel.this.getDrawingBoard().getHeight() - event.getY() - 1) + ")");
 354         }
 355
 356     }
 357
 358     public static final int FRAMERATE = 25;
 359
 360     /**
 361      *
 362      * @param components
 363      * <br> Should not be null
 364      * @return
 365      * <br>A new value
 366      * <br>A non-null value
 367      */
 368     private static final Box horizontalBox(final Component... components) {
 369         // TODO do not use Swing
 370         final Box result = Box.createHorizontalBox();
 371
 372         for (final Component component : components) {
 373             result.add(component);
 374         }
 375
 376         return result;
 377     }
 378
 379     /**
 380      *
 381      * @param components
 382      * <br> Should not be null
 383      * @return
 384      * <br>A new value
 385      * <br>A non-null value
 386      */
 387     private static final Box verticalBox(final Component... components) {
 388         // TODO do not use Swing
 389         final Box result = Box.createVerticalBox();
 390
 391         for (final Component component : components) {
 392             result.add(component);
 393         }
 394
 395         return result;
 396     }
 397
 398     /**
 399      * Transforms the brush resource path into a user-readable form.
 400      * <br>Eg: "org/sourceforge/desert/resources/images/dot_1x1.png" becomes "Dot 1x1"
 401      * @param brushPath
 402      * <br>Should not be null
 403      * @return
 404      * <br>A non-null value
 405      * <br>A new value
 406      */
 407     static final String getUserReadableBrushName(final String brushPath) {
 408         final String result = Utilities.getResourceName(brushPath).split("brush_")[1].split("\\.")[0].replaceAll("_", " ");
 409
 410         return Character.toUpperCase(result.charAt(0)) + result.substring(1);
 411     }
 412
 413     /**
 414      *
 415      * @author codistmonk (creation 2010-04-15)
 416      */
 417     @SuppressWarnings("serial")
 418     private static final class FramerateLabel extends Label implements ActionListener {
 419
 420         private double meanFramerate;
 421
 422         @Override
 423         public final void actionPerformed(final ActionEvent event) {
 424             this.meanFramerate = 0.9F * this.meanFramerate + 0.1F * 1.0 / ((Timer.Event) event).getDeltaTime();
 425             this.setText("Framerate: " + String.format("%.1f", this.meanFramerate));
 426         }
 427
 428     }
 429 }