001/*
002 * $RCSfile: TIFFColorConverter.java,v $
003 *
004 * 
005 * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
006 * 
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met: 
010 * 
011 * - Redistribution of source code must retain the above copyright 
012 *   notice, this  list of conditions and the following disclaimer.
013 * 
014 * - Redistribution in binary form must reproduce the above copyright
015 *   notice, this list of conditions and the following disclaimer in 
016 *   the documentation and/or other materials provided with the
017 *   distribution.
018 * 
019 * Neither the name of Sun Microsystems, Inc. or the names of 
020 * contributors may be used to endorse or promote products derived 
021 * from this software without specific prior written permission.
022 * 
023 * This software is provided "AS IS," without a warranty of any 
024 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
025 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
026 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
027 * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
028 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
029 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
030 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
031 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
032 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
033 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
034 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
035 * POSSIBILITY OF SUCH DAMAGES. 
036 * 
037 * You acknowledge that this software is not designed or intended for 
038 * use in the design, construction, operation or maintenance of any 
039 * nuclear facility. 
040 *
041 * $Revision: 1.2 $
042 * $Date: 2006/04/28 01:01:59 $
043 * $State: Exp $
044 */
045package com.github.jaiimageio.plugins.tiff;
046
047/**
048 * An abstract class that performs simple color conversion on 3-banded source
049 * images, for use with the TIFF Image I/O plug-in.
050 */
051public abstract class TIFFColorConverter {
052
053    /**
054     * Constructs an instance of a <code>TIFFColorConverter</code>.
055     */
056    public TIFFColorConverter() {}
057
058    /**
059     * Converts an RGB triple into the native color space of this
060     * TIFFColorConverter, and stores the result in the first three
061     * entries of the <code>result</code> array.
062     *
063     * @param r the red value.
064     * @param g the green value.
065     * @param b the blue value.
066     * @param result an array of <code>float</code>s containing three elements.
067     * @throws NullPointerException if <code>result</code> is
068     * <code>null</code>.
069     * @throws ArrayIndexOutOfBoundsException if
070     * <code>result.length&nbsp;<&nbsp;3</code>.
071     */
072    public abstract void fromRGB(float r, float g, float b, float[] result);
073
074    /**
075     * Converts  a   triple  in  the   native  color  space   of  this
076     * TIFFColorConverter into an RGB triple, and stores the result in
077     * the first three entries of the <code>rgb</code> array.
078     *
079     * @param x0 the value of channel 0.
080     * @param x1 the value of channel 1.
081     * @param x2 the value of channel 2.
082     * @param rgb an array of <code>float</code>s containing three elements.
083     * @throws NullPointerException if <code>rgb</code> is
084     * <code>null</code>.
085     * @throws ArrayIndexOutOfBoundsException if
086     * <code>rgb.length&nbsp;<&nbsp;3</code>.
087     */
088    public abstract void toRGB(float x0, float x1, float x2, float[] rgb);
089}