src/jalview/schemes/BuriedColourScheme.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.schemes;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.datamodel.AnnotatedCollectionI;
  25
  26 import java.awt.Color;
  27
  28 /**
  29  * DOCUMENT ME!
  30  *
  31  * @author $author$
  32  * @version $Revision$
  33  */
  34 public class BuriedColourScheme extends ScoreColourScheme
  35 {
  36   /**
  37    * Creates a new BuriedColourScheme object.
  38    */
  39   public BuriedColourScheme()
  40   {
  41     super(ResidueProperties.aaIndex, ResidueProperties.buried,
  42             ResidueProperties.buriedmin, ResidueProperties.buriedmax);
  43   }
  44
  45   /**
  46    * DOCUMENT ME!
  47    *
  48    * @param c
  49    *          DOCUMENT ME!
  50    *
  51    * @return DOCUMENT ME!
  52    */
  53   @Override
  54   public Color makeColour(float c)
  55   {
  56     return new Color(0, (float) (1.0 - c), c);
  57   }
  58
  59   @Override
  60   public boolean isPeptideSpecific()
  61   {
  62     return true;
  63   }
  64
  65   @Override
  66   public String getSchemeName()
  67   {
  68     return JalviewColourScheme.Buried.toString();
  69   }
  70
  71   /**
  72    * Returns a new instance of this colour scheme with which the given data may
  73    * be coloured
  74    */
  75   @Override
  76   public ColourSchemeI getInstance(AlignViewportI view,
  77           AnnotatedCollectionI coll)
  78   {
  79     return new BuriedColourScheme();
  80   }
  81 }