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