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