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