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