/*
 * Some classes in this package have been partly inspired by & bits ported from
 * Python code written by Tom De Smedt & Frederik De Bleser for the "colors" library
 * of Nodebox.net.
 * 
 * http://nodebox.net/code/index.php/Colors
 *
 * Copyright (c) 2006-2011 Karsten Schmidt
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * http://creativecommons.org/licenses/LGPL/2.1/
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

package toxi.color.theory;

import toxi.color.ColorList;
import toxi.color.ReadonlyTColor;

/**
 * A simple interface for implementing rules used to create color palettes. The
 * library currently comes with 10 default implementations realising different
 * color theory approaches.
 */
public interface ColorTheoryStrategy {

    /**
     * Creates a new {@link ColorList} of colors for the supplied source color
     * based on the strategy. The number of colors returned is unspecified and
     * depends on the strategy.
     * 
     * @param src
     *            source color
     * @return list of matching colors created by the strategy.
     */
    ColorList createListFromColor(ReadonlyTColor src);

    /**
     * Returns the unique name of the strategy.
     * 
     * @return name
     */
    String getName();
}