AbstractCIEColor.java

/*

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 */
package org.apache.batik.css.engine.value.svg12;

import org.apache.batik.css.engine.value.AbstractValue;
import org.w3c.dom.css.CSSValue;

/**
 * This is a base class for CIE Lab/LCH color values.
 *
 * @version $Id$
 */
public abstract class AbstractCIEColor extends AbstractValue {
    //CIE XYZ tristimulus values of the reference white point: Illuminant= D50
    private static final float REF_X_D50 = 96.42f;
    private static final float REF_Y_D50 = 100.00f;
    private static final float REF_Z_D50 = 82.49f;

    /** The three color values. */
    protected float[] values = new float[3];

    /** The white point, initialized to D50. */
    protected float[] whitepoint = new float[] {REF_X_D50, REF_Y_D50, REF_Z_D50};

    /**
     * Creates a new CIE-based color.
     * @param components the color components
     * @param whitepoint the white point in CIE XYZ coordinates
     */
    protected AbstractCIEColor(float[] components, float[] whitepoint) {
        System.arraycopy(components, 0, this.values, 0, this.values.length);
        if (whitepoint != null) {
            System.arraycopy(whitepoint, 0, this.whitepoint, 0, this.whitepoint.length);
        }
    }

    /**
     * Returns the color values.
     * @return the color values
     */
    public float[] getColorValues() {
        float[] copy = new float[3];
        System.arraycopy(this.values, 0, copy, 0, copy.length);
        return copy;
    }

    /**
     * Returns the white point in CIE XYZ coordinates.
     * @return the white point in CIE XYZ coordinates
     */
    public float[] getWhitePoint() {
        float[] copy = new float[3];
        System.arraycopy(this.whitepoint, 0, copy, 0, copy.length);
        return copy;
    }

    public abstract String getFunctionName();

    /**
     * Implements {@link
     * org.apache.batik.css.engine.value.Value#getCssValueType()}.
     */
    public short getCssValueType() {
        return CSSValue.CSS_CUSTOM;
    }

    /**
     *  A string representation of the current value.
     */
    public String getCssText() {
        StringBuffer sb = new StringBuffer(getFunctionName());
        sb.append('(');
        sb.append(values[0]);
        sb.append(", ");
        sb.append(values[1]);
        sb.append(", ");
        sb.append(values[2]);
        sb.append( ')' );
        return sb.toString();
    }

    /** {@inheritDoc} */
    public String toString() {
        return getCssText();
    }
}