src/jalview/api/FeatureRenderer.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.api;
  22
  23 import jalview.datamodel.SequenceFeature;
  24 import jalview.datamodel.SequenceI;
  25
  26 import java.awt.Color;
  27 import java.awt.Graphics;
  28 import java.util.List;
  29 import java.util.Map;
  30
  31 /**
  32  * Abstract feature renderer interface
  33  *
  34  * @author JimP
  35  *
  36  */
  37 public interface FeatureRenderer
  38 {
  39
  40   /**
  41    * compute the perceived colour for a given column position in sequenceI,
  42    * taking transparency and feature visibility into account.
  43    *
  44    * @param col
  45    *          - background colour (due to alignment/group shading schemes, etc).
  46    * @param sequenceI
  47    *          - sequence providing features
  48    * @param r
  49    *          - column position
  50    * @param g
  51    * @return
  52    */
  53   Color findFeatureColour(Color col, SequenceI sequenceI, int r, Graphics g);
  54
  55   /**
  56    * trigger the feature discovery process for a newly created feature renderer.
  57    */
  58   void featuresAdded();
  59
  60   /**
  61    *
  62    * @param ft
  63    * @return display style for a feature
  64    */
  65   FeatureColourI getFeatureStyle(String ft);
  66
  67   /**
  68    * update the feature style for a particular feature
  69    *
  70    * @param ft
  71    * @param ggc
  72    */
  73   void setColour(String ft, FeatureColourI ggc);
  74
  75   AlignViewportI getViewport();
  76
  77   /**
  78    *
  79    * @return container managing list of feature types and their visibility
  80    */
  81   FeaturesDisplayedI getFeaturesDisplayed();
  82
  83   /**
  84    * get display style for all features types - visible or invisible
  85    *
  86    * @return
  87    */
  88   Map<String, FeatureColourI> getFeatureColours();
  89
  90   /**
  91    * query the alignment view to find all features
  92    *
  93    * @param newMadeVisible
  94    *          - when true, automatically make newly discovered types visible
  95    */
  96   void findAllFeatures(boolean newMadeVisible);
  97
  98   /**
  99    * get display style for all features types currently visible
 100    *
 101    * @return
 102    */
 103   Map<String, FeatureColourI> getDisplayedFeatureCols();
 104
 105   /**
 106    * get all registered groups
 107    *
 108    * @return
 109    */
 110   List<String> getFeatureGroups();
 111
 112   /**
 113    * get groups that are visible/invisible
 114    *
 115    * @param visible
 116    * @return
 117    */
 118   List<String> getGroups(boolean visible);
 119
 120   /**
 121    * change visibility for a range of groups
 122    *
 123    * @param toset
 124    * @param visible
 125    */
 126   void setGroupVisibility(List<String> toset, boolean visible);
 127
 128   /**
 129    * change visibiilty of given group
 130    *
 131    * @param group
 132    * @param visible
 133    */
 134   void setGroupVisibility(String group, boolean visible);
 135
 136   /**
 137    * Returns features at the specified position on the given sequence.
 138    * Non-positional features are not included.
 139    *
 140    * @param sequence
 141    * @param res
 142    * @return
 143    */
 144   List<SequenceFeature> findFeaturesAtRes(SequenceI sequence, int res);
 145
 146   /**
 147    * get current displayed types, in ordering of rendering (on top last)
 148    *
 149    * @return a (possibly empty) list of feature types
 150    */
 151
 152   List<String> getDisplayedFeatureTypes();
 153
 154   /**
 155    * get current displayed groups
 156    *
 157    * @return a (possibly empty) list of feature groups
 158    */
 159   List<String> getDisplayedFeatureGroups();
 160
 161   /**
 162    * display all features of these types
 163    *
 164    * @param featureTypes
 165    */
 166   void setAllVisible(List<String> featureTypes);
 167
 168   /**
 169    * display featureType
 170    *
 171    * @param featureType
 172    */
 173   void setVisible(String featureType);
 174
 175   /**
 176    * Sets the transparency value, between 0 (full transparency) and 1 (no
 177    * transparency)
 178    *
 179    * @param value
 180    */
 181   void setTransparency(float value);
 182
 183   /**
 184    * Returns the transparency value, between 0 (full transparency) and 1 (no
 185    * transparency)
 186    *
 187    * @return
 188    */
 189   float getTransparency();
 190 }