/*
 * 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 hydrophobicity colour scheme based on
 * 
 * <pre>
 * Kyte, J., and Doolittle, R.F., J. Mol. Biol. 1157, 105-132, 1982
 * </pre>
 */
public class HydrophobicColourScheme extends ScoreColourScheme
{
  private static final Color minScoreColour = new Color(0, 0, 255);

  private static final Color maxScoreColour = new Color(255, 0, 0);

  /**
   * Constructor
   */
  public HydrophobicColourScheme()
  {
    super(JalviewColourScheme.Hydrophobic.toString(),
            ResidueProperties.aaIndex, ResidueProperties.hyd,
            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 HydrophobicColourScheme();
  }
}