From 6a3d75135258f07fc725d6b3cb9e81328daf0342 Mon Sep 17 00:00:00 2001
From: Abdullah Tahiri <abdullah.tahiri.yo@gmail.com>
Date: Mon, 27 Feb 2023 19:19:24 +0100
Subject: [PATCH] Sketcher: PropertyVisualLayerList

=================================

This is a property (intended for ViewProviderSketch), containing a list of visual layer configurations.

This property enables to define and serialise the configuration of visual layers, as well as reacting to
changes to it.
---
 src/Mod/Sketcher/Gui/CMakeLists.txt           |   2 +
 .../Sketcher/Gui/PropertyVisualLayerList.cpp  | 108 ++++++++++++++++++
 .../Sketcher/Gui/PropertyVisualLayerList.h    |  76 ++++++++++++
 3 files changed, 186 insertions(+)
 create mode 100644 src/Mod/Sketcher/Gui/PropertyVisualLayerList.cpp
 create mode 100644 src/Mod/Sketcher/Gui/PropertyVisualLayerList.h

diff --git a/src/Mod/Sketcher/Gui/CMakeLists.txt b/src/Mod/Sketcher/Gui/CMakeLists.txt
index 08d0d155af..e9168eba33 100644
--- a/src/Mod/Sketcher/Gui/CMakeLists.txt
+++ b/src/Mod/Sketcher/Gui/CMakeLists.txt
@@ -136,6 +136,8 @@ SET(SketcherGui_SRCS
     Workbench.h
     EditDatumDialog.cpp
     EditDatumDialog.h
+    PropertyVisualLayerList.cpp
+    PropertyVisualLayerList.h
     SketchOrientationDialog.cpp
     SketchOrientationDialog.h
     SketchMirrorDialog.cpp
diff --git a/src/Mod/Sketcher/Gui/PropertyVisualLayerList.cpp b/src/Mod/Sketcher/Gui/PropertyVisualLayerList.cpp
new file mode 100644
index 0000000000..0e78f38641
--- /dev/null
+++ b/src/Mod/Sketcher/Gui/PropertyVisualLayerList.cpp
@@ -0,0 +1,108 @@
+/***************************************************************************
+ *   Copyright (c) 2023 Abdullah Tahiri <abdullah.tahiri.yo@gmail.com      *
+ *                                                                         *
+ *   This file is part of the FreeCAD CAx development system.              *
+ *                                                                         *
+ *   This library is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU Library General Public           *
+ *   License as published by the Free Software Foundation; either          *
+ *   version 2 of the License, or (at your option) any later version.      *
+ *                                                                         *
+ *   This library  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 Library General Public License for more details.                  *
+ *                                                                         *
+ *   You should have received a copy of the GNU Library General Public     *
+ *   License along with this library; see the file COPYING.LIB. If not,    *
+ *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
+ *   Suite 330, Boston, MA  02111-1307, USA                                *
+ *                                                                         *
+ ***************************************************************************/
+
+#include "PreCompiled.h"
+
+#include <Base/Console.h>
+#include <Base/Reader.h>
+#include <Base/Writer.h>
+#include <Base/Interpreter.h>
+
+#include "PropertyVisualLayerList.h"
+
+
+using namespace App;
+using namespace Base;
+using namespace std;
+using namespace SketcherGui;
+
+
+TYPESYSTEM_SOURCE(SketcherGui::PropertyVisualLayerList , App::PropertyLists)
+
+//**************************************************************************
+// Construction/Destruction
+
+PropertyVisualLayerList::PropertyVisualLayerList() = default;
+
+PropertyVisualLayerList::~PropertyVisualLayerList() = default;
+
+//**************************************************************************
+// Base class implementer
+
+PyObject *PropertyVisualLayerList::getPyObject()
+{
+    THROWM(Base::NotImplementedError, "PropertyVisualLayerList has no python counterpart");
+}
+
+VisualLayer PropertyVisualLayerList::getPyValue(PyObject *item) const {
+
+    (void) item;
+    THROWM(Base::NotImplementedError, "PropertyVisualLayerList has no python counterpart");
+}
+
+void PropertyVisualLayerList::Save (Base::Writer &writer) const
+{
+    writer.Stream() << writer.ind() << "<VisualLayerList count=\"" << getSize() <<"\">" << endl;
+    writer.incInd();
+    for (int i = 0; i < getSize(); i++) {
+        _lValueList[i].Save(writer);
+    }
+    writer.decInd();
+    writer.Stream() << writer.ind() << "</VisualLayerList>" << endl ;
+}
+
+void PropertyVisualLayerList::Restore(Base::XMLReader &reader)
+{
+    reader.readElement("VisualLayerList");
+    // get the value of my attribute
+    int count = reader.getAttributeAsInteger("count");
+
+    std::vector<VisualLayer> layers;
+    layers.reserve(count);
+
+    for (int i = 0; i < count; i++) {
+        VisualLayer visualLayer;
+        visualLayer.Restore(reader);
+        layers.push_back(std::move(visualLayer));
+    }
+
+    reader.readEndElement("VisualLayerList");
+
+    setValues(std::move(layers));
+}
+
+Property *PropertyVisualLayerList::Copy() const
+{
+    PropertyVisualLayerList *p= new PropertyVisualLayerList();
+    p->_lValueList = _lValueList;
+    return p;
+}
+
+void PropertyVisualLayerList::Paste(const Property &from)
+{
+    setValues(dynamic_cast<const PropertyVisualLayerList&>(from)._lValueList);
+}
+
+unsigned int PropertyVisualLayerList::getMemSize () const
+{
+    return static_cast<unsigned int>(_lValueList.size() * sizeof(VisualLayer));
+}
diff --git a/src/Mod/Sketcher/Gui/PropertyVisualLayerList.h b/src/Mod/Sketcher/Gui/PropertyVisualLayerList.h
new file mode 100644
index 0000000000..ec893f4c2f
--- /dev/null
+++ b/src/Mod/Sketcher/Gui/PropertyVisualLayerList.h
@@ -0,0 +1,76 @@
+/***************************************************************************
+ *   Copyright (c) 2023 Abdullah Tahiri <abdullah.tahiri.yo@gmail.com      *
+ *                                                                         *
+ *   This file is part of the FreeCAD CAx development system.              *
+ *                                                                         *
+ *   This library is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU Library General Public           *
+ *   License as published by the Free Software Foundation; either          *
+ *   version 2 of the License, or (at your option) any later version.      *
+ *                                                                         *
+ *   This library  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 Library General Public License for more details.                  *
+ *                                                                         *
+ *   You should have received a copy of the GNU Library General Public     *
+ *   License along with this library; see the file COPYING.LIB. If not,    *
+ *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
+ *   Suite 330, Boston, MA  02111-1307, USA                                *
+ *                                                                         *
+ ***************************************************************************/
+
+#ifndef SKETCHERGUI_PropertyVisualLayerList_H
+#define SKETCHERGUI_PropertyVisualLayerList_H
+
+#include <vector>
+
+#include <App/Property.h>
+
+#include <Mod/Sketcher/SketcherGlobal.h>
+
+#include "VisualLayer.h"
+
+
+namespace Base {
+class Writer;
+}
+
+namespace SketcherGui
+{
+
+class SketcherGuiExport PropertyVisualLayerList: public App::PropertyListsT<VisualLayer>
+{
+    TYPESYSTEM_HEADER_WITH_OVERRIDE();
+
+public:
+
+    /**
+     * A constructor.
+     * A more elaborate description of the constructor.
+     */
+    PropertyVisualLayerList();
+
+    /**
+     * A destructor.
+     * A more elaborate description of the destructor.
+     */
+    ~PropertyVisualLayerList() override;
+
+    PyObject *getPyObject() override;
+
+    void Save (Base::Writer &writer) const override;
+    void Restore(Base::XMLReader &reader) override;
+
+    Property *Copy() const override;
+    void Paste(const Property &from) override;
+    unsigned int getMemSize () const override;
+
+protected:
+    VisualLayer getPyValue(PyObject *) const override;
+};
+
+} // namespace SketcherGui
+
+
+#endif // SKETCHERGUI_PropertyVisualLayerList_H