wip(generic protocols): new class with rpcs

Author: JulienChampagnol

src/opengeodeweb_viewer/generic/generic_protocols.py

@@ -0,0 +1,56 @@
+# Standard library imports
+import json
+import os
+
+# Third party imports
+import vtk
+from vtk.web import protocols as vtk_protocols
+from wslink import register as exportRpc
+
+# Local application imports
+from opengeodeweb_viewer.vtk_protocol import VtkView
+from opengeodeweb_viewer.rpc.mesh.mesh_protocols import VtkMeshView
+from opengeodeweb_viewer.rpc.model.model_protocols import VtkModelView
+from opengeodeweb_viewer.utils_functions import get_schemas_dict, validate_schema
+
+schemas_dir = os.path.join(os.path.dirname(__file__), "schemas")
+schemas_dict = get_schemas_dict(schemas_dir)
+prefix = "opengeodeweb_viewer."
+
+class VtkGenericView(VtkView):
+    def __init__(self):
+        super().__init__()
+        self.prefix = prefix
+        self.schemas_dict = schemas_dict
+    
+    @exportRpc(prefix + schemas_dict["register"]["rpc"])
+    def register(self, params):
+
+        print(f"{schemas_dict=}", flush=True)
+        print(f"{params=}", flush=True)
+        validate_schema(params, schemas_dict["register"])
+        viewer_object = params["viewer_object"]
+        params.pop('viewer_object', None)
+        print(f"{params=}", flush=True)
+        if viewer_object == "mesh":
+            print(f"MESH", flush=True)
+            class_ = VtkMeshView()
+            class_.registerMesh(params)
+        elif viewer_object == "model":
+            print(f"MODEL", flush=True)
+            class_ = VtkModelView()
+            class_.registerModel(params)
+
+    @exportRpc(prefix + schemas_dict["deregister"]["rpc"])
+    def deregister(self, params):
+        validate_schema(params, schemas_dict["deregister"])
+        viewer_object = params["viewer_object"]
+        params.pop('viewer_object', None)
+        if viewer_object == "mesh":
+            VtkMeshView.registerMesh(self, params)
+        elif viewer_object == "model":
+            VtkModelView.registerModel(self, params)
+
+
+
+

src/opengeodeweb_viewer/generic/schemas/deregister.json

@@ -0,0 +1,18 @@
+{
+  "rpc": "deregister",
+  "type": "object",
+  "properties": {
+    "viewer_object": {
+      "type": "string",
+      "enum": ["mesh", "model"]
+    },
+    "id": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "viewer_object",
+    "id"
+  ],
+  "additionalProperties": false
+}

src/opengeodeweb_viewer/generic/schemas/register.json

@@ -0,0 +1,22 @@
+{
+  "rpc": "register",
+  "type": "object",
+  "properties": {
+    "viewer_object": {
+      "type": "string",
+      "enum": ["mesh", "model"]
+    },
+    "id": {
+      "type": "string"
+    },
+    "file_name": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "viewer_object",
+    "id",
+    "file_name"
+  ],
+  "additionalProperties": false
+}

src/opengeodeweb_viewer/vtkw_server.py

@@ -15,6 +15,7 @@
 from .rpc.viewer.viewer_protocols import VtkViewerView
 from .rpc.mesh.mesh_protocols import VtkMeshView
 from .rpc.model.model_protocols import VtkModelView
+from .generic.generic_protocols import VtkGenericView
 
 
 # =============================================================================
@@ -53,6 +54,7 @@ def initialize(self):
         self.registerVtkWebProtocol(VtkViewerView())
         self.registerVtkWebProtocol(VtkMeshView())
         self.registerVtkWebProtocol(VtkModelView())
+        self.registerVtkWebProtocol(VtkGenericView())
 
         # tell the C++ web app to use no encoding.
         # ParaViewWebPublishImageDelivery must be set to decode=False to match.

src/tests/test_generic_protocols.py

@@ -0,0 +1,7 @@
+from opengeodeweb_viewer.generic.generic_protocols import VtkGenericView
+class_ = VtkGenericView()
+
+def test_register(server):
+    print(class_.prefix + class_.schemas_dict["register"]["rpc"], flush=True)
+    server.call(class_.prefix + class_.schemas_dict["register"]["rpc"], [{"viewer_object": "mesh", "id": "123456789", "file_name": "hat.vtp"}])
+    assert server.compare_image(3, "mesh/register.jpeg") == True