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