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("USE_LEGACY_GAP", false);
  75     Color gapCol = Cache.getDefaultColour("GAP_COLOUR", Color.lightGray);
  76     Color hiddenCol = Cache.getDefaultColour("HIDDEN_COLOUR",
  77             Color.DARK_GRAY.darker());
  78     cf = new OverviewResColourFinder(useLegacy, gapCol, hiddenCol);
  79   }
  80
  81   /**
  82    * Update the overview dimensions object used by the canvas (e.g. if we change
  83    * from showing hidden columns to hiding them or vice versa)
  84    *
  85    * @param overviewDims
  86    */
  87   public void resetOviewDims(OverviewDimensions overviewDims)
  88   {
  89     od = overviewDims;
  90   }
  91
  92   /**
  93    * Signals to drawing code that the associated alignment viewport has changed
  94    * and a redraw will be required
  95    */
  96   public boolean restartDraw()
  97   {
  98     synchronized (this)
  99     {
 100       if (updaterunning)
 101       {
 102         restart = true;
 103         if (or != null)
 104         {
 105           or.setRedraw(true);
 106         }
 107       }
 108       else
 109       {
 110         updaterunning = true;
 111       }
 112       return restart;
 113     }
 114   }
 115
 116   /**
 117    * Draw the overview sequences
 118    *
 119    * @param showSequenceFeatures
 120    *          true if sequence features are to be shown
 121    * @param showAnnotation
 122    *          true if the annotation is to be shown
 123    * @param transferRenderer
 124    *          the renderer to transfer feature colouring from
 125    */
 126   public void draw(boolean showSequenceFeatures, boolean showAnnotation,
 127           FeatureRenderer transferRenderer)
 128   {
 129     miniMe = null;
 130
 131     if (showSequenceFeatures)
 132     {
 133       fr.transferSettings(transferRenderer);
 134     }
 135
 136     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 137
 138     or = new OverviewRenderer(fr, od, av.getAlignment(),
 139             av.getResidueShading(), cf);
 140     miniMe = or.draw(od.getRows(av.getAlignment()),
 141             od.getColumns(av.getAlignment()));
 142
 143     Graphics mg = miniMe.getGraphics();
 144
 145     if (showAnnotation)
 146     {
 147       mg.translate(0, od.getSequencesHeight());
 148       or.drawGraph(mg, av.getAlignmentConservationAnnotation(),
 149               av.getCharWidth(), od.getGraphHeight(),
 150               od.getColumns(av.getAlignment()));
 151       mg.translate(0, -od.getSequencesHeight());
 152     }
 153     System.gc();
 154
 155     if (restart)
 156     {
 157       restart = false;
 158       draw(showSequenceFeatures, showAnnotation, transferRenderer);
 159     }
 160     else
 161     {
 162       updaterunning = false;
 163       lastMiniMe = miniMe;
 164     }
 165   }
 166
 167   @Override
 168   public void paintComponent(Graphics g)
 169   {
 170     if (restart)
 171     {
 172       if (lastMiniMe == null)
 173       {
 174         g.setColor(Color.white);
 175         g.fillRect(0, 0, getWidth(), getHeight());
 176       }
 177       else
 178       {
 179         g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
 180       }
 181       g.setColor(TRANS_GREY);
 182       g.fillRect(0, 0, getWidth(), getHeight());
 183     }
 184     else if (lastMiniMe != null)
 185     {
 186       g.drawImage(lastMiniMe, 0, 0, this);
 187       if (lastMiniMe != miniMe)
 188       {
 189         g.setColor(TRANS_GREY);
 190         g.fillRect(0, 0, getWidth(), getHeight());
 191       }
 192     }
 193
 194     g.setColor(Color.red);
 195     od.drawBox(g);
 196   }
 197
 198 }