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