JAL-3215 refactored ScoreColourScheme construction for scriptability

[jalview.git] / src / jalview / schemes / TurnColourScheme.java

diff --git a/src/jalview/schemes/TurnColourScheme.java b/src/jalview/schemes/TurnColourScheme.java
index 6d0f7aa..4f354a5 100755 (executable)
--- a/src/jalview/schemes/TurnColourScheme.java
+++ b/src/jalview/schemes/TurnColourScheme.java
@@ -1,33 +1,62 @@
-/* Jalview - a java multiple alignment editor\r
- * Copyright (C) 1998  Michele Clamp\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
- */\r
-\r
-package jalview.schemes;\r
-\r
-import java.awt.*;\r
-\r
-public class TurnColourScheme extends ScoreColourScheme {\r
-\r
-  public TurnColourScheme() {\r
-    super(ResidueProperties.turn,ResidueProperties.turnmin,ResidueProperties.turnmax);\r
-  }\r
-\r
-  public Color makeColour(float c) {\r
-    return new Color(c,1-c,1-c);\r
-  }\r
-}\r
-\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.schemes;
+
+import jalview.api.AlignViewportI;
+import jalview.datamodel.AnnotatedCollectionI;
+
+import java.awt.Color;
+
+/**
+ * A graduated colour scheme based on residue turn propensity
+ */
+public class TurnColourScheme extends ScoreColourScheme
+{
+  private static final Color minScoreColour = new Color(0, 255, 255);
+
+  private static final Color maxScoreColour = new Color(255, 0, 0);
+
+  /**
+   * Constructor
+   */
+  public TurnColourScheme()
+  {
+    super(JalviewColourScheme.Turn.toString(), ResidueProperties.aaIndex,
+            ResidueProperties.turn, minScoreColour, maxScoreColour);
+  }
+
+  @Override
+  public boolean isPeptideSpecific()
+  {
+    return true;
+  }
+
+  /**
+   * Returns a new instance of this colour scheme with which the given data may
+   * be coloured
+   */
+  @Override
+  public ColourSchemeI getInstance(AlignViewportI view,
+          AnnotatedCollectionI coll)
+  {
+    return new TurnColourScheme();
+  }
+}