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