    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.imaging.color;
    018
    019/**
    020 * Represents a color in the CIE 1931 color space, also known as XYZ color space.
    021 *
    022 * <p>
    023 * Contains the constant values for black, white, red, green, and blue.
    024 * </p>
    025 *
    026 * @see <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">https://en.wikipedia.org/wiki/CIE_1931_color_space</a>
    027 * @since 1.0-alpha1
    028 */
    029public final class ColorXyz {
    030
    031    /**
    032     * A constant for color black. Color components are:
    033     *
    034     * <pre>
    035     *     X: 0
    036     *     Y: 0
    037     *     Z: 0
    038     * </pre>
    039     */
    040    public static final ColorXyz BLACK = new ColorXyz(0, 0, 0);
    041
    042    /**
    043     * A constant for color white. Color components are:
    044     *
    045     * <pre>
    046     *     X:  95.05
    047     *     Y: 100.00
    048     *     Z: 108.90
    049     * </pre>
    050     */
    051    public static final ColorXyz WHITE = new ColorXyz(95.05, 100, 108.9);
    052
    053    /**
    054     * A constant for color red. Color components are:
    055     *
    056     * <pre>
    057     *     X: 41.24
    058     *     Y: 21.26
    059     *     Z:  1.93
    060     * </pre>
    061     */
    062    public static final ColorXyz RED = new ColorXyz(41.24, 21.26, 1.93);
    063
    064    /**
    065     * A constant for color green. Color components are:
    066     *
    067     * <pre>
    068     *     X: 35.76
    069     *     Y: 71.52
    070     *     Z: 11.92
    071     * </pre>
    072     */
    073    public static final ColorXyz GREEN = new ColorXyz(35.76, 71.52, 11.92);
    074
    075    /**
    076     * A constant for color blue. Color components are:
    077     *
    078     * <pre>
    079     *     X: 18.05
    080     *     Y:  7.22
    081     *     Z: 95.05
    082     * </pre>
    083     */
    084    public static final ColorXyz BLUE = new ColorXyz(18.05, 7.22, 95.05);
    085
    086    public final double x;
    087    public final double y;
    088    public final double z;
    089
    090    public ColorXyz(final double x, final double y, final double z) {
    091        this.x = x;
    092        this.y = y;
    093        this.z = z;
    094    }
    095
    096    @Override
    097    public boolean equals(final Object o) {
    098        if (this == o) {
    099            return true;
    100        }
    101        if (o == null || getClass() != o.getClass()) {
    102            return false;
    103        }
    104
    105        final ColorXyz colorXyz = (ColorXyz) o;
    106        if (Double.compare(colorXyz.x, x) != 0) {
    107            return false;
    108        }
    109        if (Double.compare(colorXyz.y, y) != 0) {
    110            return false;
    111        }
    112        if (Double.compare(colorXyz.z, z) != 0) {
    113            return false;
    114        }
    115
    116        return true;
    117    }
    118
    119    @Override
    120    public int hashCode() {
    121        int result;
    122        long temp;
    123        temp = Double.doubleToLongBits(x);
    124        result = (int) (temp ^ temp >>> 32);
    125        temp = Double.doubleToLongBits(y);
    126        result = 31 * result + (int) (temp ^ temp >>> 32);
    127        temp = Double.doubleToLongBits(z);
    128        return 31 * result + (int) (temp ^ temp >>> 32);
    129    }
    130
    131    @Override
    132    public String toString() {
    133        return "{X: " + x + ", Y: " + y + ", Z: " + z + "}";
    134    }
    135}