JAL-3215 remove redundant min/max constants, refactor ctr, add tests
[jalview.git] / src / jalview / schemes / TurnColourScheme.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 TurnColourScheme extends ScoreColourScheme
35 {
36   /**
37    * Creates a new TurnColourScheme object.
38    */
39   public TurnColourScheme()
40   {
41     super(ResidueProperties.aaIndex, ResidueProperties.turn);
42   }
43
44   /**
45    * DOCUMENT ME!
46    * 
47    * @param c
48    *          DOCUMENT ME!
49    * 
50    * @return DOCUMENT ME!
51    */
52   @Override
53   public Color makeColour(float c)
54   {
55     return new Color(c, 1 - c, 1 - c);
56   }
57
58   @Override
59   public boolean isPeptideSpecific()
60   {
61     return true;
62   }
63
64   @Override
65   public String getSchemeName()
66   {
67     return JalviewColourScheme.Turn.toString();
68   }
69
70   /**
71    * Returns a new instance of this colour scheme with which the given data may
72    * be coloured
73    */
74   @Override
75   public ColourSchemeI getInstance(AlignViewportI view,
76           AnnotatedCollectionI coll)
77   {
78     return new TurnColourScheme();
79   }
80 }