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