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.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.image.BufferedImage;
  32
  33 import javax.swing.JComponent;
  34
  35 public class OverviewCanvas extends JComponent
  36 {
  37   private static final Color TRANS_GREY = new Color(100, 100, 100, 25);
  38
  39   // This is set true if the alignment view changes whilst
  40   // the overview is being calculated
  41   private volatile boolean restart = false;
  42
  43   private volatile boolean updaterunning = false;
  44
  45   private BufferedImage miniMe;
  46
  47   private BufferedImage lastMiniMe = null;
  48
  49   // Can set different properties in this seqCanvas than
  50   // main visible SeqCanvas
  51   private SequenceRenderer sr;
  52
  53   private jalview.renderer.seqfeatures.FeatureRenderer fr;
  54
  55   private OverviewDimensions od;
  56
  57   private AlignViewportI av;
  58
  59   public OverviewCanvas(OverviewDimensions overviewDims,
  60           AlignViewportI alignvp)
  61   {
  62     od = overviewDims;
  63     av = alignvp;
  64
  65     sr = new SequenceRenderer(av);
  66     sr.renderGaps = false;
  67     sr.forOverview = true;
  68     fr = new jalview.renderer.seqfeatures.FeatureRenderer(av);
  69   }
  70
  71   /**
  72    * Update the overview dimensions object used by the canvas (e.g. if we change
  73    * from showing hidden columns to hiding them or vice versa)
  74    *
  75    * @param overviewDims
  76    */
  77   public void resetOviewDims(OverviewDimensions overviewDims)
  78   {
  79     od = overviewDims;
  80   }
  81
  82   /**
  83    * Signals to drawing code that the associated alignment viewport has changed
  84    * and a redraw will be required
  85    */
  86   public boolean restartDraw()
  87   {
  88     synchronized (this)
  89     {
  90       if (updaterunning)
  91       {
  92         restart = true;
  93       }
  94       else
  95       {
  96         updaterunning = true;
  97       }
  98       return restart;
  99     }
 100   }
 101
 102   /**
 103    * Draw the overview sequences
 104    *
 105    * @param showSequenceFeatures
 106    *          true if sequence features are to be shown
 107    * @param showAnnotation
 108    *          true if the annotation is to be shown
 109    * @param transferRenderer
 110    *          the renderer to transfer feature colouring from
 111    */
 112   public void draw(boolean showSequenceFeatures, boolean showAnnotation,
 113           FeatureRenderer transferRenderer)
 114   {
 115     miniMe = null;
 116
 117     if (showSequenceFeatures)
 118     {
 119       fr.transferSettings(transferRenderer);
 120     }
 121     FeatureColourFinder finder = new FeatureColourFinder(fr);
 122
 123     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 124
 125     OverviewRenderer or = new OverviewRenderer(sr, finder, od);
 126     miniMe = or.draw(od.getRows(av.getAlignment()),
 127             od.getColumns(av.getAlignment().getHiddenColumns()));
 128
 129     Graphics mg = miniMe.getGraphics();
 130
 131     if (showAnnotation)
 132     {
 133       mg.translate(0, od.getSequencesHeight());
 134       or.drawGraph(mg, av.getAlignmentConservationAnnotation(),
 135               av.getCharWidth(), od.getGraphHeight(),
 136               od.getColumns(av.getAlignment().getHiddenColumns()));
 137       mg.translate(0, -od.getSequencesHeight());
 138     }
 139     System.gc();
 140
 141     if (restart)
 142     {
 143       restart = false;
 144       draw(showSequenceFeatures, showAnnotation, transferRenderer);
 145     }
 146     else
 147     {
 148       updaterunning = false;
 149       lastMiniMe = miniMe;
 150     }
 151   }
 152
 153   @Override
 154   public void paintComponent(Graphics g)
 155   {
 156     if (restart)
 157     {
 158       if (lastMiniMe == null)
 159       {
 160         g.setColor(Color.white);
 161         g.fillRect(0, 0, getWidth(), getHeight());
 162       }
 163       else
 164       {
 165         g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 166       }
 167       g.setColor(TRANS_GREY);
 168       g.fillRect(0, 0, getWidth(), getHeight());
 169     }
 170     else if (lastMiniMe != null)
 171     {
 172       g.drawImage(lastMiniMe, 0, 0, this);
 173       if (lastMiniMe != miniMe)
 174       {
 175         g.setColor(TRANS_GREY);
 176         g.fillRect(0, 0, getWidth(), getHeight());
 177       }
 178     }
 179
 180     g.setColor(Color.red);
 181     od.drawBox(g);
 182   }
 183
 184 }