[Sofa.Types] Add RGBAColor binding & tests

Author: damienmarchal

bindings/Sofa/src/SofaPython3/Sofa/Types/Binding_RGBAColor.cpp

@@ -0,0 +1,77 @@
+/******************************************************************************
+*                 SOFA, Simulation Open-Framework Architecture                *
+*                    (c) 2021 INRIA, USTL, UJF, CNRS, MGH                     *
+*                                                                             *
+* This program is free software; you can redistribute it and/or modify it     *
+* under the terms of the GNU Lesser General Public License as published by    *
+* the Free Software Foundation; either version 2.1 of the License, or (at     *
+* your option) any later version.                                             *
+*                                                                             *
+* This program is distributed in the hope that it will be useful, but WITHOUT *
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
+* for more details.                                                           *
+*                                                                             *
+* You should have received a copy of the GNU Lesser General Public License    *
+* along with this program. If not, see <http://www.gnu.org/licenses/>.        *
+*******************************************************************************
+* Contact information: [email protected]                             *
+******************************************************************************/
+
+#include <SofaPython3/Sofa/Types/Binding_BoundingBox.h>
+
+#include <sofa/core/objectmodel/BaseData.h>
+#include <sofa/core/objectmodel/Data.h>
+#include <sofa/type/BoundingBox.h>
+#include <SofaPython3/PythonFactory.h>
+#include <pybind11/stl.h>
+#include <pybind11/operators.h>
+using sofa::type::RGBAColor;
+
+namespace py { using namespace pybind11; }
+
+namespace sofapython3 {
+
+void moduleAddRGBAColor(py::module& m)
+{
+    py::class_<sofa::type::RGBAColor> c(m, "RGBAColor");
+    c.doc() = R"doc(A color)doc";
+
+    c.def(py::init<>());                  // empty ctor
+    c.def(py::init<const RGBAColor &>()); // copy ctor
+    c.def(py::init([](double r, double g, double b, double a) {
+              return std::make_unique<sofa::type::RGBAColor>( r,g,b,a );
+          }));
+
+    c.def(py::init([](std::array<double,4>& v) {
+              return std::make_unique<sofa::type::RGBAColor>( v[0], v[1], v[2], v[3] );
+          }));
+
+    c.def("r", [](const RGBAColor& color) { return color.r(); });
+    c.def("g", [](const RGBAColor& color) { return color.g(); });
+    c.def("b", [](const RGBAColor& color) { return color.b(); });
+    c.def("a", [](const RGBAColor& color) { return color.a(); });
+
+    c.def("lighten", [](const RGBAColor& color, const SReal factor){
+        return RGBAColor::lighten(color, factor);
+    });
+
+    c.def("__str__", [](const RGBAColor& color){
+        std::stringstream tmp;
+        tmp << "RGBAColor(" << color.r() << "," << color.g() << "," << color.b() << "," << color.a() << ")";
+        return tmp.str();
+    });
+
+    c.def("__repr__", [](const RGBAColor& color){
+        std::stringstream tmp;
+        tmp << "RGBAColor(" << color.r() << "," << color.g() << "," << color.b() << "," << color.a() << ")";
+        return tmp.str();
+    });
+
+    // Dark magic to define comparison operator using the c++ == and != operator.
+    c.def(pybind11::self==pybind11::self);
+    c.def(pybind11::self!=pybind11::self);
+}
+
+}  // namespace sofapython3
+

bindings/Sofa/src/SofaPython3/Sofa/Types/Binding_RGBAColor.h

@@ -0,0 +1,29 @@
+/******************************************************************************
+*                 SOFA, Simulation Open-Framework Architecture                *
+*                    (c) 2021 INRIA, USTL, UJF, CNRS, MGH                     *
+*                                                                             *
+* This program is free software; you can redistribute it and/or modify it     *
+* under the terms of the GNU Lesser General Public License as published by    *
+* the Free Software Foundation; either version 2.1 of the License, or (at     *
+* your option) any later version.                                             *
+*                                                                             *
+* This program is distributed in the hope that it will be useful, but WITHOUT *
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
+* for more details.                                                           *
+*                                                                             *
+* You should have received a copy of the GNU Lesser General Public License    *
+* along with this program. If not, see <http://www.gnu.org/licenses/>.        *
+*******************************************************************************
+* Contact information: [email protected]                             *
+******************************************************************************/
+
+#pragma once
+
+#include <pybind11/pybind11.h>
+
+namespace sofapython3 {
+
+void moduleAddRGBAColor(pybind11::module& m);
+
+}  // namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Types/Submodule_Types.cpp

@@ -23,7 +23,7 @@
 
 #include <SofaPython3/Sofa/Types/Binding_BoundingBox.h>
 #include <SofaPython3/Sofa/Types/Binding_CompressedRowSparseMatrix.h>
-
+#include <SofaPython3/Sofa/Types/Binding_RGBAColor.h>
 
 namespace sofapython3 {
 /// The first parameter must be named the same as the module file to load.
@@ -37,6 +37,7 @@ PYBIND11_MODULE(Types, types)
             Defines SOFA types (BoundingBox)
        )doc";
 
+    moduleAddRGBAColor(types);
     moduleAddBoundingBox(types);
     moduleAddCompressedRowSparseMatrix(types);
 }

bindings/Sofa/tests/Types/RGBAColor.py

@@ -5,21 +5,30 @@
 
 class Test(unittest.TestCase):
     def test_constructor_default(self):
-        v0 = Sofa.PyTypes.RGBAColor()
-        self.assertEqual( v0.r(), 0 )
-        self.assertEqual( v0.g(), 0 )
-        self.assertEqual( v0.b(), 0 )
-        self.assertEqual( v0.a(), 0 )
+        v0 = Sofa.Types.RGBAColor()
+        self.assertEqual( v0.r(), 1 )
+        self.assertEqual( v0.g(), 1 )
+        self.assertEqual( v0.b(), 1 )
+        self.assertEqual( v0.a(), 1 )
 
     def test_constructor_fromList(self):
-        v0 = Sofa.PyTypes.RGBAColor([1.0,2.0,3.0,4.0])
+        v0 = Sofa.Types.RGBAColor([1.0,2.0,3.0,4.0])
         self.assertEqual( v0.r(), 1.0 )
         self.assertEqual( v0.g(), 2.0 )
         self.assertEqual( v0.b(), 3.0 )
         self.assertEqual( v0.a(), 4.0 )
 
     def test_constructor_fromInvalidList(self):
-        self.assertRaises(ValueError, Sofa.PyTypes.RGBAColor, [1.0,2.0,3.0])
-        self.assertRaises(ValueError, Sofa.PyTypes.RGBAColor, [1.0,2.0,3.0,10,100])
-        self.assertRaises(TypeError, Sofa.PyTypes.RGBAColor, [1.0,2.0,"three",4.0])
+        self.assertRaises(TypeError, Sofa.Types.RGBAColor, [1.0,2.0,3.0])
+        self.assertRaises(TypeError, Sofa.Types.RGBAColor, [1.0,2.0,3.0,10,100])
+        self.assertRaises(TypeError, Sofa.Types.RGBAColor, [1.0,2.0,"three",4.0])
+
+    def test_lighten(self):
+        color = Sofa.Types.RGBAColor(0,0,0,0)
+        lightcolor = color.lighten(0.5)
+        self.assertEqual( lightcolor, Sofa.Types.RGBAColor(0.5,0.5,0.5,1.0))
+        
+        whitecolor = color.lighten(1.0)
+        self.assertEqual( whitecolor, Sofa.Types.RGBAColor(1.0,1.0,1.0,1.0) )
+