View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.imaging.color;
18  
19  /**
20   * Represents a color in the CIE 1931 color space, also known as XYZ color space.
21   *
22   * <p>
23   * Contains the constant values for black, white, red, green, and blue.
24   * </p>
25   *
26   * @see <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">https://en.wikipedia.org/wiki/CIE_1931_color_space</a>
27   * @since 1.0-alpha1
28   */
29  public final class ColorXyz {
30  
31      /**
32       * A constant for color black. Color components are:
33       *
34       * <pre>
35       *     X: 0
36       *     Y: 0
37       *     Z: 0
38       * </pre>
39       */
40      public static final ColorXyz BLACK = new ColorXyz(0, 0, 0);
41  
42      /**
43       * A constant for color white. Color components are:
44       *
45       * <pre>
46       *     X:  95.05
47       *     Y: 100.00
48       *     Z: 108.90
49       * </pre>
50       */
51      public static final ColorXyz WHITE = new ColorXyz(95.05, 100, 108.9);
52  
53      /**
54       * A constant for color red. Color components are:
55       *
56       * <pre>
57       *     X: 41.24
58       *     Y: 21.26
59       *     Z:  1.93
60       * </pre>
61       */
62      public static final ColorXyz RED = new ColorXyz(41.24, 21.26, 1.93);
63  
64      /**
65       * A constant for color green. Color components are:
66       *
67       * <pre>
68       *     X: 35.76
69       *     Y: 71.52
70       *     Z: 11.92
71       * </pre>
72       */
73      public static final ColorXyz GREEN = new ColorXyz(35.76, 71.52, 11.92);
74  
75      /**
76       * A constant for color blue. Color components are:
77       *
78       * <pre>
79       *     X: 18.05
80       *     Y:  7.22
81       *     Z: 95.05
82       * </pre>
83       */
84      public static final ColorXyz BLUE = new ColorXyz(18.05, 7.22, 95.05);
85  
86      public final double x;
87      public final double y;
88      public final double z;
89  
90      public ColorXyz(final double x, final double y, final double z) {
91          this.x = x;
92          this.y = y;
93          this.z = z;
94      }
95  
96      @Override
97      public boolean equals(final Object o) {
98          if (this == o) {
99              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 }