Some changes in comments. Add hsbToRgbw

Signed-off-by: Marco Müller <marco@ms-mueller.ch>
openhab · Nov 9, 2023 · 84912d9 · 84912d9
1 parent 21bd49b
commit 84912d9
Showing 1 changed file with 27 additions and 9 deletions.
diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/util/ColorUtil.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/util/ColorUtil.java
@@ -63,7 +63,7 @@ private ColorUtil() {
      *
      * This function does rounding to integer valued components. It is the preferred way of doing HSB to RGB conversion.
      *
-     * See also: {@link #hsbToRgbPercent(HSBType)}, {@link #hsbTosRgb(HSBType)}
+     * See also: {@link #hsbToRgbPercent(HSBType)}, {@link #hsbToRgbw(HSBType)}, {@link #hsbTosRgb(HSBType)}
      *
      * @param hsb an {@link HSBType} value.
      * @return array of three int with the RGB values in the range 0 to 255.
@@ -74,6 +74,24 @@ public static int[] hsbToRgb(HSBType hsb) {
                 convertColorPercentToByte(rgbPercent[2]) };
     }
 
+    /**
+     * Transform <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType} to
+     * <a href="https://en.wikipedia.org/wiki/SRGB">sRGB</a>.
+     *
+     * This function does rounding to integer valued components. It is the preferred way of doing HSB to RGBW
+     * conversion.
+     *
+     * See also: {@link #hsbToRgbPercent(HSBType)}, {@link #hsbToRgbwPercent(HSBType)}, {@link #hsbTosRgb(HSBType)}
+     *
+     * @param hsb an {@link HSBType} value.
+     * @return array of four int with the RGBW values in the range 0 to 255.
+     */
+    public static int[] hsbToRgbw(HSBType hsb) {
+        final PercentType[] rgbPercent = hsbToRgbwPercent(hsb);
+        return new int[] { convertColorPercentToByte(rgbPercent[0]), convertColorPercentToByte(rgbPercent[1]),
+                convertColorPercentToByte(rgbPercent[2]), convertColorPercentToByte(rgbPercent[3]) };
+    }
+
     /**
      * Transform <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType} to
      * <a href="https://en.wikipedia.org/wiki/SRGB">sRGB</a>.
@@ -261,19 +279,19 @@ public static double[] hsbToXY(HSBType hsb, Gamut gamut) {
      * Transform <a href="https://en.wikipedia.org/wiki/SRGB">sRGB</a> color format to
      * <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType}.
      *
-     * @param rgb array of three int with the RGB values in the range 0 to 255.
+     * @param rgbw array of four int with the RGBW values in the range 0 to 255.
      * @return the corresponding {@link HSBType}.
      * @throws IllegalArgumentException when input array has wrong size or exceeds allowed value range.
      */
-    public static HSBType rgbToHsb(int[] rgb) throws IllegalArgumentException {
-        if (rgb.length == 4) {
-            return rgbwToHsb(rgb);
+    public static HSBType rgbToHsb(int[] rgbw) throws IllegalArgumentException {
+        if (rgbw.length == 4) {
+            return rgbwToHsb(rgbw);
         }
-        if (rgb.length != 3 || !inByteRange(rgb[0]) || !inByteRange(rgb[1]) || !inByteRange(rgb[2])) {
+        if (rgbw.length != 3 || !inByteRange(rgbw[0]) || !inByteRange(rgbw[1]) || !inByteRange(rgbw[2])) {
             throw new IllegalArgumentException("RGB array only allows values between 0 and 255");
         }
-        return rgbToHsb(new PercentType[] { convertByteToColorPercent(rgb[0]), convertByteToColorPercent(rgb[1]),
-                convertByteToColorPercent(rgb[2]) });
+        return rgbToHsb(new PercentType[] { convertByteToColorPercent(rgbw[0]), convertByteToColorPercent(rgbw[1]),
+                convertByteToColorPercent(rgbw[2]) });
     }
 
     /**
@@ -323,7 +341,7 @@ private static HSBType rgbwToHsb(int[] rgbw) {
      * Transform <a href="https://en.wikipedia.org/wiki/SRGB">sRGB</a> color format to
      * <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType}.
      *
-     * @param rgb array of three {@link PercentType] with the RGB values in the range 0 to 100 percent.
+     * @param rgb array of three {@link PercentType} with the RGB values in the range 0 to 100 percent.
      * @return the corresponding {@link HSBType}.
      * @throws IllegalArgumentException when input array has wrong size or exceeds allowed value range.
      */