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