src/jalview/gui/OverviewCanvas.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.renderer.OverviewRenderer;
  25 import jalview.viewmodel.OverviewDimensions;
  26
  27 import java.awt.AlphaComposite;
  28 import java.awt.Color;
  29 import java.awt.Graphics;
  30 import java.awt.Graphics2D;
  31 import java.awt.event.ActionEvent;
  32 import java.awt.event.ActionListener;
  33 import java.awt.image.BufferedImage;
  34
  35 import javax.swing.JComponent;
  36 import javax.swing.Timer;
  37
  38 public class OverviewCanvas extends JComponent
  39 {
  40   private static final long RUNNING_TIME = 2000;
  41
  42   private static final int SPEED = 40;
  43
  44   private static final Color TRANS_GREY = new Color(100, 100, 100, 25);
  45
  46   // This is set true if the alignment view changes whilst
  47   // the overview is being calculated
  48   private volatile boolean restart = false;
  49
  50   private volatile boolean updaterunning = false;
  51
  52   private BufferedImage miniMe;
  53
  54   private BufferedImage lastMiniMe = null;
  55
  56   private BufferedImage veryLastMiniMe = null;
  57
  58   // Can set different properties in this seqCanvas than
  59   // main visible SeqCanvas
  60   private SequenceRenderer sr;
  61
  62   private jalview.renderer.seqfeatures.FeatureRenderer fr;
  63
  64   private OverviewDimensions od;
  65
  66   private OverviewRenderer or = null;
  67
  68   private AlignViewportI av;
  69
  70   private float alpha = 0f;
  71
  72   private long startTime = -1;
  73
  74   private final Timer timer;
  75
  76   private ProgressPanel progressPanel;
  77
  78   public OverviewCanvas(OverviewDimensions overviewDims,
  79           AlignViewportI alignvp, ProgressPanel pp)
  80   {
  81     od = overviewDims;
  82     av = alignvp;
  83     progressPanel = pp;
  84
  85     sr = new SequenceRenderer(av);
  86     sr.renderGaps = false;
  87     sr.forOverview = true;
  88     fr = new jalview.renderer.seqfeatures.FeatureRenderer(av);
  89
  90     setSize(od.getWidth(), od.getHeight());
  91
  92     timer = new Timer(SPEED, new ActionListener()
  93     {
  94
  95       @Override
  96       public void actionPerformed(ActionEvent e)
  97       {
  98         if (startTime < 0)
  99         {
 100           startTime = System.currentTimeMillis();
 101         }
 102         else
 103         {
 104
 105           long time = System.currentTimeMillis();
 106           long duration = time - startTime;
 107           if (duration >= RUNNING_TIME)
 108           {
 109             startTime = -1;
 110             ((Timer) e.getSource()).stop();
 111             alpha = 0f;
 112           }
 113           else
 114           {
 115             alpha = 1f - ((float) duration / (float) RUNNING_TIME);
 116           }
 117           repaint();
 118         }
 119       }
 120     });
 121   }
 122
 123   /**
 124    * Update the overview dimensions object used by the canvas (e.g. if we change
 125    * from showing hidden columns to hiding them or vice versa)
 126    *
 127    * @param overviewDims
 128    */
 129   public void resetOviewDims(OverviewDimensions overviewDims)
 130   {
 131     od = overviewDims;
 132   }
 133
 134   /**
 135    * Signals to drawing code that the associated alignment viewport has changed
 136    * and a redraw will be required
 137    */
 138   public boolean restartDraw()
 139   {
 140     synchronized (this)
 141     {
 142       if (updaterunning)
 143       {
 144         restart = true;
 145         if (or != null)
 146         {
 147           or.setRedraw(true);
 148         }
 149       }
 150       else
 151       {
 152         updaterunning = true;
 153       }
 154       return restart;
 155     }
 156   }
 157
 158   /**
 159    * Draw the overview sequences
 160    *
 161    * @param showSequenceFeatures
 162    *          true if sequence features are to be shown
 163    * @param showAnnotation
 164    *          true if the annotation is to be shown
 165    * @param transferRenderer
 166    *          the renderer to transfer feature colouring from
 167    */
 168   public void draw(boolean showSequenceFeatures, boolean showAnnotation,
 169           FeatureRenderer transferRenderer)
 170   {
 171     miniMe = null;
 172     veryLastMiniMe = lastMiniMe;
 173
 174     if (showSequenceFeatures)
 175     {
 176       fr.transferSettings(transferRenderer);
 177     }
 178
 179     or = new OverviewRenderer(sr, fr, od);
 180     or.addPropertyChangeListener(progressPanel);
 181     miniMe = or.draw(od.getRows(av.getAlignment()),
 182             od.getColumns(av.getAlignment()));
 183
 184     Graphics mg = miniMe.getGraphics();
 185
 186     if (showAnnotation)
 187     {
 188       mg.translate(0, od.getSequencesHeight());
 189       or.drawGraph(mg, av.getAlignmentConservationAnnotation(),
 190               av.getCharWidth(), od.getGraphHeight(),
 191               od.getColumns(av.getAlignment()));
 192       mg.translate(0, -od.getSequencesHeight());
 193     }
 194     System.gc();
 195
 196     or.removePropertyChangeListener(progressPanel);
 197     if (restart)
 198     {
 199       restart = false;
 200       draw(showSequenceFeatures, showAnnotation, transferRenderer);
 201     }
 202     else
 203     {
 204       updaterunning = false;
 205       lastMiniMe = miniMe;
 206       alpha = 1f;
 207       timer.start();
 208     }
 209   }
 210
 211   @Override
 212   public void paintComponent(Graphics g)
 213   {
 214     if (restart)
 215     {
 216       if (lastMiniMe == null)
 217       {
 218         g.setColor(Color.white);
 219         g.fillRect(0, 0, getWidth(), getHeight());
 220       }
 221       else
 222       {
 223         g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 224       }
 225       g.setColor(TRANS_GREY);
 226       g.fillRect(0, 0, getWidth(), getHeight());
 227     }
 228     else if (lastMiniMe != null)
 229     {
 230       // is this a resize?
 231       if ((getWidth() > 0) && (getHeight() > 0)
 232               && ((getWidth() != od.getWidth())
 233                       || (getHeight() != od.getHeight())))
 234       {
 235         // if there is annotation, scale the alignment and annotation separately
 236         if (od.getGraphHeight() > 0)
 237         {
 238           BufferedImage topImage = lastMiniMe.getSubimage(0, 0,
 239                   od.getWidth(), od.getSequencesHeight());
 240           BufferedImage bottomImage = lastMiniMe.getSubimage(0,
 241                   od.getSequencesHeight(), od.getWidth(),
 242                   od.getGraphHeight());
 243
 244           // must be done at this point as we rely on using old width/height
 245           // above, and new width/height below
 246           od.setWidth(getWidth());
 247           od.setHeight(getHeight());
 248
 249           // stick the images back together so lastMiniMe is consistent in the
 250           // event of a repaint - BUT probably not thread safe
 251           lastMiniMe = new BufferedImage(od.getWidth(), od.getHeight(),
 252                   BufferedImage.TYPE_INT_RGB);
 253           Graphics lg = lastMiniMe.getGraphics();
 254           lg.drawImage(topImage, 0, 0, od.getWidth(),
 255                   od.getSequencesHeight(), null);
 256           lg.drawImage(bottomImage, 0, od.getSequencesHeight(),
 257                   od.getWidth(), od.getGraphHeight(), this);
 258           lg.dispose();
 259         }
 260         else
 261         {
 262           od.setWidth(getWidth());
 263           od.setHeight(getHeight());
 264         }
 265
 266         // scale lastMiniMe to the new size
 267         g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 268
 269         // make sure the box is in the right place
 270         od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 271                 av.getAlignment().getHiddenColumns());
 272       }
 273       else // not a resize
 274       {
 275         if (alpha != 0) // this is a timer triggered dissolve
 276         {
 277           Graphics2D g2d = (Graphics2D) g.create();
 278
 279           // draw the original image
 280           g2d.drawImage(veryLastMiniMe, 0, 0, getWidth(), getHeight(),
 281                   this);
 282
 283           // draw the new image on top with varying degrees of transparency
 284           g2d.setComposite(AlphaComposite.SrcOver.derive(1f - alpha));
 285           g2d.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 286
 287           g2d.dispose();
 288         }
 289         else
 290         {
 291           // fall back to normal behaviour
 292           g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 293         }
 294       }
 295     }
 296
 297     // draw the box
 298     g.setColor(Color.red);
 299     od.drawBox(g);
 300   }
 301 }