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 HSV color space.
21 *
22 * <p>
23 * Contains the constant values for black, white, red, green, blue, cyan, magenta, and yellow.
24 * </p>
25 *
26 * @see <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">https://en.wikipedia.org/wiki/HSL_and_HSV</a>
27 * @since 1.0-alpha1
28 */
29 public final class ColorHsv {
30
31 /**
32 * A constant for color black. Color components are:
33 *
34 * <pre>
35 * Hue: 0
36 * Saturation: 0
37 * Value: 0
38 * </pre>
39 */
40 public static final ColorHsv BLACK = new ColorHsv(0, 0, 0);
41
42 /**
43 * A constant for color white. Color components are:
44 *
45 * <pre>
46 * Hue: 0
47 * Saturation: 0
48 * Value: 100
49 * </pre>
50 */
51 public static final ColorHsv WHITE = new ColorHsv(0, 0, 100);
52
53 /**
54 * A constant for color red. Color components are:
55 *
56 * <pre>
57 * Hue: 0
58 * Saturation: 100
59 * Value: 100
60 * </pre>
61 */
62 public static final ColorHsv RED = new ColorHsv(0, 100, 100);
63
64 /**
65 * A constant for color green. Color components are:
66 *
67 * <pre>
68 * Hue: 120
69 * Saturation: 100
70 * Value: 100
71 * </pre>
72 */
73 public static final ColorHsv GREEN = new ColorHsv(120, 100, 100);
74
75 /**
76 * A constant for color blue. Color components are:
77 *
78 * <pre>
79 * Hue: 240
80 * Saturation: 100
81 * Value: 100
82 * </pre>
83 */
84 public static final ColorHsv BLUE = new ColorHsv(240, 100, 100);
85
86 public final double h;
87 public final double s;
88 public final double v;
89
90 public ColorHsv(final double h, final double s, final double v) {
91 this.h = h;
92 this.s = s;
93 this.v = v;
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 ColorHsv colorHsv = (ColorHsv) o;
106 if (Double.compare(colorHsv.h, h) != 0) {
107 return false;
108 }
109 if (Double.compare(colorHsv.s, s) != 0) {
110 return false;
111 }
112 if (Double.compare(colorHsv.v, v) != 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(h);
124 result = (int) (temp ^ temp >>> 32);
125 temp = Double.doubleToLongBits(s);
126 result = 31 * result + (int) (temp ^ temp >>> 32);
127 temp = Double.doubleToLongBits(v);
128 return 31 * result + (int) (temp ^ temp >>> 32);
129 }
130
131 @Override
132 public String toString() {
133 return "{H: " + h + ", S: " + s + ", V: " + v + "}";
134 }
135 }