src/jalview/gui/OverviewPanel.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.datamodel.SequenceI;
  24 import jalview.renderer.AnnotationRenderer;
  25 import jalview.renderer.seqfeatures.FeatureColourFinder;
  26 import jalview.viewmodel.OverviewDimensions;
  27 import jalview.viewmodel.ViewportListenerI;
  28
  29 import java.awt.Color;
  30 import java.awt.Dimension;
  31 import java.awt.Graphics;
  32 import java.awt.event.ComponentAdapter;
  33 import java.awt.event.ComponentEvent;
  34 import java.awt.event.MouseAdapter;
  35 import java.awt.event.MouseEvent;
  36 import java.awt.event.MouseMotionAdapter;
  37 import java.awt.image.BufferedImage;
  38 import java.beans.PropertyChangeEvent;
  39
  40 import javax.swing.JPanel;
  41
  42 /**
  43  * Panel displaying an overview of the full alignment, with an interactive box
  44  * representing the viewport onto the alignment.
  45  *
  46  * @author $author$
  47  * @version $Revision$
  48  */
  49 public class OverviewPanel extends JPanel implements Runnable,
  50         ViewportListenerI
  51 {
  52   private static final Color TRANS_GREY = new Color(100, 100, 100, 25);
  53
  54   private final AnnotationRenderer renderer = new AnnotationRenderer();
  55
  56   private OverviewDimensions od;
  57
  58   private BufferedImage miniMe;
  59
  60   private BufferedImage lastMiniMe = null;
  61
  62   private AlignViewport av;
  63
  64   private AlignmentPanel ap;
  65
  66   //
  67   private boolean resizing = false;
  68
  69   // This is set true if the user resizes whilst
  70   // the overview is being calculated
  71   private boolean resizeAgain = false;
  72
  73   // Can set different properties in this seqCanvas than
  74   // main visible SeqCanvas
  75   private SequenceRenderer sr;
  76
  77   jalview.renderer.seqfeatures.FeatureRenderer fr;
  78
  79   /**
  80    * Creates a new OverviewPanel object.
  81    *
  82    * @param alPanel
  83    *          The alignment panel which is shown in the overview panel
  84    */
  85   public OverviewPanel(AlignmentPanel alPanel)
  86   {
  87     this.av = alPanel.av;
  88     this.ap = alPanel;
  89     setLayout(null);
  90
  91     sr = new SequenceRenderer(av);
  92     sr.renderGaps = false;
  93     sr.forOverview = true;
  94     fr = new FeatureRenderer(ap);
  95
  96     od = new OverviewDimensions(av.getRanges(),
  97             (av.isShowAnnotation() && av
  98                     .getAlignmentConservationAnnotation() != null));
  99
 100     av.getRanges().addPropertyChangeListener(this);
 101
 102     addComponentListener(new ComponentAdapter()
 103     {
 104       @Override
 105       public void componentResized(ComponentEvent evt)
 106       {
 107         if ((getWidth() != od.getWidth())
 108                 || (getHeight() != (od.getHeight())))
 109         {
 110           updateOverviewImage();
 111           setBoxPosition();
 112         }
 113       }
 114     });
 115
 116     addMouseMotionListener(new MouseMotionAdapter()
 117     {
 118       @Override
 119       public void mouseDragged(MouseEvent evt)
 120       {
 121         if (!av.getWrapAlignment())
 122         {
 123           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
 124                   .getAlignment().getHiddenSequences(), av
 125                   .getColumnSelection(), av.getRanges());
 126           // TODO set via ViewportRanges in overview dimensions once JAL-2388 is
 127           // merged
 128         }
 129       }
 130     });
 131
 132     addMouseListener(new MouseAdapter()
 133     {
 134       @Override
 135       public void mousePressed(MouseEvent evt)
 136       {
 137         if (!av.getWrapAlignment())
 138         {
 139           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
 140                   .getAlignment().getHiddenSequences(), av
 141                   .getColumnSelection(), av.getRanges());
 142           // TODO set via ViewportRanges in overview dimensions once JAL-2388 is
 143           // merged
 144         }
 145       }
 146     });
 147
 148     updateOverviewImage();
 149     setBoxPosition();
 150   }
 151
 152   /**
 153    * Updates the overview image when the related alignment panel is updated
 154    */
 155   public void updateOverviewImage()
 156   {
 157     if (resizing)
 158     {
 159       resizeAgain = true;
 160       return;
 161     }
 162
 163     resizing = true;
 164
 165     if ((getWidth() > 0) && (getHeight() > 0))
 166     {
 167       od.setWidth(getWidth());
 168       od.setHeight(getHeight());
 169     }
 170
 171     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 172
 173     Thread thread = new Thread(this);
 174     thread.start();
 175     repaint();
 176   }
 177
 178   @Override
 179   public void run()
 180   {
 181     miniMe = null;
 182
 183     if (av.isShowSequenceFeatures())
 184     {
 185       fr.transferSettings(ap.getSeqPanel().seqCanvas.getFeatureRenderer());
 186     }
 187
 188     // why do we need to set preferred size again? was set in
 189     // updateOverviewImage
 190     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 191
 192     miniMe = new BufferedImage(od.getWidth(), od.getHeight(),
 193             BufferedImage.TYPE_INT_RGB);
 194
 195     Graphics mg = miniMe.getGraphics();
 196     mg.setColor(Color.orange);
 197     mg.fillRect(0, 0, od.getWidth(), miniMe.getHeight());
 198
 199     // calculate sampleCol and sampleRow
 200     // alignment width is max number of residues/bases
 201     // alignment height is number of sequences
 202     int alwidth = av.getAlignment().getWidth();
 203     int alheight = av.getAlignment().getAbsoluteHeight();
 204
 205     // sampleCol or sampleRow is the width/height allocated to each residue
 206     // in particular, sometimes we may need more than one row/col of the
 207     // BufferedImage allocated
 208     // sampleCol is how much of a residue to assign to each pixel
 209     // sampleRow is how many sequences to assign to each pixel
 210     float sampleCol = alwidth / (float) od.getWidth();
 211     float sampleRow = alheight / (float) od.getSequencesHeight();
 212
 213     buildImage(sampleRow, sampleCol);
 214
 215     // check for conservation annotation to make sure overview works for DNA too
 216     if (av.isShowAnnotation()
 217             && (av.getAlignmentConservationAnnotation() != null))
 218     {
 219       renderer.updateFromAlignViewport(av);
 220       for (int col = 0; col < od.getWidth() && !resizeAgain; col++)
 221       {
 222         mg.translate(col, od.getSequencesHeight());
 223         renderer.drawGraph(mg, av.getAlignmentConservationAnnotation(),
 224                 av.getAlignmentConservationAnnotation().annotations,
 225                 (int) (sampleCol) + 1, od.getGraphHeight(),
 226                 (int) (col * sampleCol), (int) (col * sampleCol) + 1);
 227         mg.translate(-col, -od.getSequencesHeight());
 228
 229       }
 230     }
 231     System.gc();
 232
 233     resizing = false;
 234
 235     if (resizeAgain)
 236     {
 237       resizeAgain = false;
 238       updateOverviewImage();
 239     }
 240     else
 241     {
 242       lastMiniMe = miniMe;
 243     }
 244
 245     // setBoxPosition();
 246   }
 247
 248   /*
 249    * Build the overview panel image
 250    */
 251   private void buildImage(float sampleRow, float sampleCol)
 252   {
 253     int lastcol = -1;
 254     int lastrow = -1;
 255     int rgbColour = Color.white.getRGB();
 256
 257     SequenceI seq = null;
 258     FeatureColourFinder finder = new FeatureColourFinder(fr);
 259
 260     final boolean hasHiddenCols = av.hasHiddenColumns();
 261     boolean hiddenRow = false;
 262     // get hidden row and hidden column map once at beginning.
 263     // clone featureRenderer settings to avoid race conditions... if state is
 264     // updated just need to refresh again
 265     for (int row = 0; row < od.getSequencesHeight() && !resizeAgain; row++)
 266     {
 267       boolean doCopy = true;
 268       int currentrow = (int) (row * sampleRow);
 269       if (currentrow != lastrow)
 270       {
 271         doCopy = false;
 272
 273         lastrow = currentrow;
 274
 275         // get the sequence which would be at alignment index 'lastrow' if no
 276         // rows were hidden, and determine whether it is hidden or not
 277         hiddenRow = av.getAlignment().isHidden(lastrow);
 278         seq = av.getAlignment().getSequenceAtAbsoluteIndex(lastrow);
 279       }
 280
 281       for (int col = 0; col < od.getWidth() && !resizeAgain; col++)
 282       {
 283         if (doCopy)
 284         {
 285           rgbColour = miniMe.getRGB(col, row - 1);
 286         }
 287         else if ((int) (col * sampleCol) != lastcol
 288                 || (int) (row * sampleRow) != lastrow)
 289         {
 290           lastcol = (int) (col * sampleCol);
 291           rgbColour = getColumnColourFromSequence(seq, hiddenRow,
 292                   hasHiddenCols, lastcol, finder);
 293         }
 294         // else we just use the color we already have , so don't need to set it
 295
 296         miniMe.setRGB(col, row, rgbColour);
 297       }
 298     }
 299   }
 300
 301   /*
 302    * Find the colour of a sequence at a specified column position
 303    */
 304   private int getColumnColourFromSequence(
 305           jalview.datamodel.SequenceI seq,
 306           boolean hiddenRow, boolean hasHiddenCols, int lastcol,
 307           FeatureColourFinder finder)
 308   {
 309     Color color = Color.white;
 310
 311     if ((seq != null) && (seq.getLength() > lastcol))
 312     {
 313         color = sr.getResidueColour(seq, lastcol, finder);
 314     }
 315
 316     if (hiddenRow
 317             || (hasHiddenCols && !av.getColumnSelection()
 318                     .isVisible(lastcol)))
 319     {
 320       color = color.darker().darker();
 321     }
 322
 323     return color.getRGB();
 324   }
 325
 326   /**
 327    * Update the overview panel box when the associated alignment panel is
 328    * changed
 329    *
 330    */
 331   private void setBoxPosition()
 332   {
 333     od.setBoxPosition(av.getAlignment()
 334             .getHiddenSequences(), av.getColumnSelection(), av.getRanges());
 335     repaint();
 336   }
 337
 338
 339   @Override
 340   public void paintComponent(Graphics g)
 341   {
 342     if (resizing || resizeAgain)
 343     {
 344       if (lastMiniMe == null)
 345       {
 346         g.setColor(Color.white);
 347         g.fillRect(0, 0, getWidth(), getHeight());
 348       }
 349       else
 350       {
 351         g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 352       }
 353       g.setColor(TRANS_GREY);
 354       g.fillRect(0, 0, getWidth(), getHeight());
 355     }
 356     else if (lastMiniMe != null)
 357     {
 358       g.drawImage(lastMiniMe, 0, 0, this);
 359       if (lastMiniMe != miniMe)
 360       {
 361         g.setColor(TRANS_GREY);
 362         g.fillRect(0, 0, getWidth(), getHeight());
 363       }
 364     }
 365
 366     g.setColor(Color.red);
 367     od.drawBox(g);
 368   }
 369
 370   @Override
 371   public void propertyChange(PropertyChangeEvent evt)
 372   {
 373     setBoxPosition();
 374   }
 375 }