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.viewmodel.OverviewDimensions;
  25
  26 import java.awt.Color;
  27 import java.awt.Component;
  28 import java.awt.Dimension;
  29 import java.awt.Frame;
  30 import java.awt.Graphics;
  31 import java.awt.Image;
  32
  33 public class OverviewCanvas extends Component
  34 {
  35   // This is set true if the alignment view changes whilst
  36   // the overview is being calculated
  37   private volatile boolean restart = false;
  38
  39   private volatile boolean updaterunning = false;
  40
  41   private OverviewDimensions od;
  42
  43   private OverviewRenderer or = null;
  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         if (or != null)
  98         {
  99           or.setRedraw(true);
 100         }
 101       }
 102       else
 103       {
 104         updaterunning = true;
 105       }
 106       return restart;
 107     }
 108   }
 109
 110   public void draw(boolean showSequenceFeatures, boolean showAnnotation,
 111           FeatureRenderer transferRenderer)
 112   {
 113     miniMe = null;
 114
 115     if (showSequenceFeatures)
 116     {
 117       fr.transferSettings(transferRenderer);
 118     }
 119
 120     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 121
 122     or = new OverviewRenderer(sr, fr, od, av.getAlignment(),
 123             av.getResidueShading());
 124     miniMe = nullFrame.createImage(od.getWidth(), od.getHeight());
 125     offscreen = nullFrame.createImage(od.getWidth(), od.getHeight());
 126
 127     miniMe = or.draw(od.getRows(av.getAlignment()),
 128             od.getColumns(av.getAlignment()));
 129
 130     Graphics mg = miniMe.getGraphics();
 131
 132     // checks for conservation annotation to make sure overview works for DNA
 133     // too
 134     if (showAnnotation)
 135     {
 136       mg.translate(0, od.getSequencesHeight());
 137       or.drawGraph(mg, av.getAlignmentConservationAnnotation(),
 138               av.getCharWidth(), od.getGraphHeight(),
 139               od.getColumns(av.getAlignment()));
 140       mg.translate(0, -od.getSequencesHeight());
 141     }
 142     System.gc();
 143
 144     if (restart)
 145     {
 146       restart = false;
 147       draw(showSequenceFeatures, showAnnotation, transferRenderer);
 148     }
 149     else
 150     {
 151       updaterunning = false;
 152     }
 153   }
 154
 155   @Override
 156   public void update(Graphics g)
 157   {
 158     paint(g);
 159   }
 160
 161   @Override
 162   public void paint(Graphics g)
 163   {
 164     Graphics og = offscreen.getGraphics();
 165     if (miniMe != null)
 166     {
 167       og.drawImage(miniMe, 0, 0, this);
 168       og.setColor(Color.red);
 169       od.drawBox(og);
 170       g.drawImage(offscreen, 0, 0, this);
 171     }
 172   }
 173
 174 }