Expose HSV and HSL color values to QML

[ChangeLog][QtQuick] Added properties to access color values for the HSV
and HSL color models to the basic QML color type.

Task-number: QTBUG-48723
Change-Id: I45fa52f9f3878553e1b3d0a34b47804ede7794f8
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

7 files changed, 153 insertions, 5 deletions

diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc
index 6e6e66e026..2406722dbc 100644
--- a/src/quick/doc/src/qmltypereference.qdoc
+++ b/src/quick/doc/src/qmltypereference.qdoc
@@ -100,9 +100,9 @@ available when you import \c QtQuick.
     \li By a hexadecimal triplet or quad in the form \c "#RRGGBB" and \c "#AARRGGBB"
         respectively. For example, the color red corresponds to a triplet of \c "#FF0000"
         and a slightly transparent blue to a quad of \c "#800000FF".
-    \li Using the \l{QtQml::Qt::rgba()}{Qt.rgba()}, \l{QtQml::Qt::hsla()}{Qt.hsla()},
-        \l{QtQml::Qt::darker()}{Qt.darker()}, \l{QtQml::Qt::lighter()}{Qt.lighter()} or
-        \l{QtQml::Qt::tint()}{Qt.tint()} functions.
+    \li Using the \l{QtQml::Qt::rgba()}{Qt.rgba()}, \l{QtQml::Qt::hsva()}{Qt.hsva()},
+        \l{QtQml::Qt::hsla()}{Qt.hsla()}, \l{QtQml::Qt::darker()}{Qt.darker()},
+        \l{QtQml::Qt::lighter()}{Qt.lighter()} or \l{QtQml::Qt::tint()}{Qt.tint()} functions.
     \endlist
 
     Example:
@@ -112,8 +112,11 @@ available when you import \c QtQuick.
     \enddiv
     \snippet qml/colors.qml colors
 
-    Additionally, a color type has \c r, \c g, \c b and \c a properties that refer to the
-    red, green, blue and alpha values of the color, respectively:
+    A color type has \c r, \c g, \c b and \c a properties that refer to the red,
+    green, blue and alpha values of the color, respectively. Additionally it has
+    \c hsvHue, \c hsvSaturation, \c hsvValue and \c hslHue, \c hslSaturation,
+    \c hslLightness properties, which allow access to color values in HSV and HSL
+    color models accordingly:
 
     \qml
     Text {
diff --git a/src/quick/util/qquickvaluetypes.cpp b/src/quick/util/qquickvaluetypes.cpp
index 7b9b6068bd..e673df0451 100644
--- a/src/quick/util/qquickvaluetypes.cpp
+++ b/src/quick/util/qquickvaluetypes.cpp
@@ -80,6 +80,36 @@ qreal QQuickColorValueType::a() const
     return v.alphaF();
 }
 
+qreal QQuickColorValueType::hsvHue() const
+{
+    return v.hsvHueF();
+}
+
+qreal QQuickColorValueType::hsvSaturation() const
+{
+    return v.hsvSaturationF();
+}
+
+qreal QQuickColorValueType::hsvValue() const
+{
+    return v.valueF();
+}
+
+qreal QQuickColorValueType::hslHue() const
+{
+    return v.hslHueF();
+}
+
+qreal QQuickColorValueType::hslSaturation() const
+{
+    return v.hslSaturationF();
+}
+
+qreal QQuickColorValueType::hslLightness() const
+{
+    return v.lightnessF();
+}
+
 void QQuickColorValueType::setR(qreal r)
 {
     v.setRedF(r);
@@ -100,6 +130,48 @@ void QQuickColorValueType::setA(qreal a)
     v.setAlphaF(a);
 }
 
+void QQuickColorValueType::setHsvHue(qreal hsvHue)
+{
+    qreal hue, saturation, value, alpha;
+    v.getHsvF(&hue, &saturation, &value, &alpha);
+    v.setHsvF(hsvHue, saturation, value, alpha);
+}
+
+void QQuickColorValueType::setHsvSaturation(qreal hsvSaturation)
+{
+    qreal hue, saturation, value, alpha;
+    v.getHsvF(&hue, &saturation, &value, &alpha);
+    v.setHsvF(hue, hsvSaturation, value, alpha);
+}
+
+void QQuickColorValueType::setHsvValue(qreal hsvValue)
+{
+    qreal hue, saturation, value, alpha;
+    v.getHsvF(&hue, &saturation, &value, &alpha);
+    v.setHsvF(hue, saturation, hsvValue, alpha);
+}
+
+void QQuickColorValueType::setHslHue(qreal hslHue)
+{
+    qreal hue, saturation, lightness, alpha;
+    v.getHslF(&hue, &saturation, &lightness, &alpha);
+    v.setHslF(hslHue, saturation, lightness, alpha);
+}
+
+void QQuickColorValueType::setHslSaturation(qreal hslSaturation)
+{
+    qreal hue, saturation, lightness, alpha;
+    v.getHslF(&hue, &saturation, &lightness, &alpha);
+    v.setHslF(hue, hslSaturation, lightness, alpha);
+}
+
+void QQuickColorValueType::setHslLightness(qreal hslLightness)
+{
+    qreal hue, saturation, lightness, alpha;
+    v.getHslF(&hue, &saturation, &lightness, &alpha);
+    v.setHslF(hue, saturation, hslLightness, alpha);
+}
+
 QString QQuickVector2DValueType::toString() const
 {
     return QString(QLatin1String("QVector2D(%1, %2)")).arg(v.x()).arg(v.y());
diff --git a/src/quick/util/qquickvaluetypes_p.h b/src/quick/util/qquickvaluetypes_p.h
index 05e954f915..4a1598ec5c 100644
--- a/src/quick/util/qquickvaluetypes_p.h
+++ b/src/quick/util/qquickvaluetypes_p.h
@@ -78,6 +78,12 @@ class QQuickColorValueType
     Q_PROPERTY(qreal g READ g WRITE setG FINAL)
     Q_PROPERTY(qreal b READ b WRITE setB FINAL)
     Q_PROPERTY(qreal a READ a WRITE setA FINAL)
+    Q_PROPERTY(qreal hsvHue READ hsvHue WRITE setHsvHue FINAL)
+    Q_PROPERTY(qreal hsvSaturation READ hsvSaturation WRITE setHsvSaturation FINAL)
+    Q_PROPERTY(qreal hsvValue READ hsvValue WRITE setHsvValue FINAL)
+    Q_PROPERTY(qreal hslHue READ hslHue WRITE setHslHue FINAL)
+    Q_PROPERTY(qreal hslSaturation READ hslSaturation WRITE setHslSaturation FINAL)
+    Q_PROPERTY(qreal hslLightness READ hslLightness WRITE setHslLightness FINAL)
     Q_GADGET
 public:
     Q_INVOKABLE QString toString() const;
@@ -86,10 +92,22 @@ public:
     qreal g() const;
     qreal b() const;
     qreal a() const;
+    qreal hsvHue() const;
+    qreal hsvSaturation() const;
+    qreal hsvValue() const;
+    qreal hslHue() const;
+    qreal hslSaturation() const;
+    qreal hslLightness() const;
     void setR(qreal);
     void setG(qreal);
     void setB(qreal);
     void setA(qreal);
+    void setHsvHue(qreal);
+    void setHsvSaturation(qreal);
+    void setHsvValue(qreal);
+    void setHslHue(qreal);
+    void setHslSaturation(qreal);
+    void setHslLightness(qreal);
 };
 
 class QQuickVector2DValueType
diff --git a/tests/auto/qml/qqmlvaluetypes/data/color_read.qml b/tests/auto/qml/qqmlvaluetypes/data/color_read.qml
index bc92b1e5f9..73d2b921a7 100644
--- a/tests/auto/qml/qqmlvaluetypes/data/color_read.qml
+++ b/tests/auto/qml/qqmlvaluetypes/data/color_read.qml
@@ -5,5 +5,11 @@ MyTypeObject {
     property real v_g: color.g
     property real v_b: color.b
     property real v_a: color.a
+    property real hsv_h: color.hsvHue
+    property real hsv_s: color.hsvSaturation
+    property real hsv_v: color.hsvValue
+    property real hsl_h: color.hslHue
+    property real hsl_s: color.hslSaturation
+    property real hsl_l: color.hslLightness
     property variant copy: color
 }
diff --git a/tests/auto/qml/qqmlvaluetypes/data/color_write_HSL.qml b/tests/auto/qml/qqmlvaluetypes/data/color_write_HSL.qml
new file mode 100644
index 0000000000..0034163bbe
--- /dev/null
+++ b/tests/auto/qml/qqmlvaluetypes/data/color_write_HSL.qml
@@ -0,0 +1,8 @@
+import Test 1.0
+
+MyTypeObject {
+    color.hslHue: if (true) 0.43
+    color.hslSaturation: if (true) 0.74
+    color.hslLightness: if (true) 0.54
+    color.a: if (true) 0.7
+}
diff --git a/tests/auto/qml/qqmlvaluetypes/data/color_write_HSV.qml b/tests/auto/qml/qqmlvaluetypes/data/color_write_HSV.qml
new file mode 100644
index 0000000000..1fc47d460e
--- /dev/null
+++ b/tests/auto/qml/qqmlvaluetypes/data/color_write_HSV.qml
@@ -0,0 +1,8 @@
+import Test 1.0
+
+MyTypeObject {
+    color.hsvHue: if (true) 0.43
+    color.hsvSaturation: if (true) 0.77
+    color.hsvValue: if (true) 0.88
+    color.a: if (true) 0.7
+}
diff --git a/tests/auto/qml/qqmlvaluetypes/tst_qqmlvaluetypes.cpp b/tests/auto/qml/qqmlvaluetypes/tst_qqmlvaluetypes.cpp
index f506d0f53a..803bad197a 100644
--- a/tests/auto/qml/qqmlvaluetypes/tst_qqmlvaluetypes.cpp
+++ b/tests/auto/qml/qqmlvaluetypes/tst_qqmlvaluetypes.cpp
@@ -907,6 +907,15 @@ void tst_qqmlvaluetypes::color()
         QCOMPARE((float)object->property("v_g").toDouble(), (float)0.88);
         QCOMPARE((float)object->property("v_b").toDouble(), (float)0.6);
         QCOMPARE((float)object->property("v_a").toDouble(), (float)0.34);
+
+        QCOMPARE(qRound(object->property("hsv_h").toDouble() * 100), 43);
+        QCOMPARE(qRound(object->property("hsv_s").toDouble() * 100), 77);
+        QCOMPARE(qRound(object->property("hsv_v").toDouble() * 100), 88);
+
+        QCOMPARE(qRound(object->property("hsl_h").toDouble() * 100), 43);
+        QCOMPARE(qRound(object->property("hsl_s").toDouble() * 100), 74);
+        QCOMPARE(qRound(object->property("hsl_l").toDouble() * 100), 54);
+
         QColor comparison;
         comparison.setRedF(0.2);
         comparison.setGreenF(0.88);
@@ -933,6 +942,30 @@ void tst_qqmlvaluetypes::color()
     }
 
     {
+        QQmlComponent component(&engine, testFileUrl("color_write_HSV.qml"));
+        MyTypeObject *object = qobject_cast<MyTypeObject *>(component.create());
+        QVERIFY(object != 0);
+
+        QColor newColor;
+        newColor.setHsvF(0.43, 0.77, 0.88, 0.7);
+        QCOMPARE(object->color(), newColor);
+
+        delete object;
+    }
+
+    {
+        QQmlComponent component(&engine, testFileUrl("color_write_HSL.qml"));
+        MyTypeObject *object = qobject_cast<MyTypeObject *>(component.create());
+        QVERIFY(object != 0);
+
+        QColor newColor;
+        newColor.setHslF(0.43, 0.74, 0.54, 0.7);
+        QCOMPARE(object->color(), newColor);
+
+        delete object;
+    }
+
+    {
         QQmlComponent component(&engine, testFileUrl("color_compare.qml"));
         MyTypeObject *object = qobject_cast<MyTypeObject *>(component.create());
         QVERIFY(object != 0);