update to new slice plane API

Author: nmwsharp

deps/polyscope

@@ -325,17 +325,37 @@ PYBIND11_MODULE(polyscope_bindings, m) {
   py::class_<ps::SlicePlane>(m, "SlicePlane")
    .def(py::init<std::string>())
    .def_readonly("name", &ps::SlicePlane::name) 
-   .def("set_pose", &ps::SlicePlane::setPose, "set pose")
-   .def("set_active", &ps::SlicePlane::setActive, "set active")
+   .def("remove", &ps::SlicePlane::remove, "remove")
+   .def("set_enabled", &ps::SlicePlane::setEnabled, "set enabled")
+   .def("get_enabled", &ps::SlicePlane::getEnabled, "get enabled")
+   .def("set_active", &ps::SlicePlane::setActive, "set active") // should have been called 'enabled'
    .def("get_active", &ps::SlicePlane::getActive, "get active")
+   .def("set_pose", &ps::SlicePlane::setPose, "set pose")
+   .def("get_center", [](ps::SlicePlane& s) { return glm2eigen(s.getCenter()); })
+   .def("get_normal", [](ps::SlicePlane& s) { return glm2eigen(s.getNormal()); })
+   .def("set_color", &ps::SlicePlane::setColor, "set color")
+   .def("get_color", [](ps::SlicePlane& s) { return glm2eigen(s.getColor()); })
+   .def("set_grid_line_color", &ps::SlicePlane::setGridLineColor, "set grid line color")
+   .def("get_grid_line_color", [](ps::SlicePlane& s) { return glm2eigen(s.getGridLineColor()); })
+   .def("set_transparency", &ps::SlicePlane::setTransparency, "set transparency")
+   .def("get_transparency", &ps::SlicePlane::getTransparency, "get transparency")
    .def("set_draw_plane", &ps::SlicePlane::setDrawPlane, "set draw plane")
    .def("get_draw_plane", &ps::SlicePlane::getDrawPlane, "get draw plane")
    .def("set_draw_widget", &ps::SlicePlane::setDrawWidget, "set draw widget")
    .def("get_draw_widget", &ps::SlicePlane::getDrawWidget, "get draw widget")
    .def("set_volume_mesh_to_inspect", &ps::SlicePlane::setVolumeMeshToInspect, "set name of inspected volume mesh")
    .def("get_volume_mesh_to_inspect", &ps::SlicePlane::getVolumeMeshToInspect, "get name of inspected volume mesh");
+  
+  
+  m.def("add_slice_plane", overload_cast_<>()(&ps::addSlicePlane), "add a slice plane", py::return_value_policy::reference);
+  m.def("add_slice_plane", overload_cast_<std::string>()(&ps::addSlicePlane), "add a slice plane", py::return_value_policy::reference);
+  m.def("get_slice_plane", &ps::getSlicePlane, "get a slice plane by name", py::return_value_policy::reference);
+  m.def("remove_slice_plane", overload_cast_<std::string>()(&ps::removeSlicePlane), "remove a slice plane by name");
+  m.def("remove_all_slice_planes", &ps::removeAllSlicePlanes, "remove all slice planes");
+
 
-  m.def("add_scene_slice_plane", ps::addSceneSlicePlane, "add a slice plane", py::return_value_policy::reference);
+  // deprecated, but still supprorted for now
+  m.def("add_scene_slice_plane", ps::addSceneSlicePlane, "add a slice plane", py::return_value_policy::reference); 
   m.def("remove_last_scene_slice_plane", ps::removeLastSceneSlicePlane, "remove last scene plane");
 
   // === Camera Parameters

src/cpp/core.cpp

@@ -531,16 +531,49 @@ def __init__(self, instance):
 
     def get_name(self):
         return self.bound_slice_plane.name
-
-    def set_pose(self, plane_position, plane_normal):
-        self.bound_slice_plane.set_pose(glm3(plane_position), glm3(plane_normal))
 
+    def remove(self):
+        self.bound_slice_plane.remove()
+    
+    def set_enabled(self, val):
+        self.bound_slice_plane.set_enabled(val)
+    
+    def get_enabled(self):
+        return self.bound_slice_plane.get_enabled()
+
     def set_active(self, val):
         self.bound_slice_plane.set_active(val)
 
     def get_active(self):
         return self.bound_slice_plane.get_active()
 
+    def set_pose(self, plane_position, plane_normal):
+        self.bound_slice_plane.set_pose(glm3(plane_position), glm3(plane_normal))
+    
+    def get_center(self):
+        return self.bound_slice_plane.get_center()
+    
+    def get_normal(self):
+        return self.bound_slice_plane.get_normal()
+    
+    def set_color(self, val):
+        self.bound_slice_plane.set_color(glm3(val))
+    
+    def get_color(self):
+        return self.bound_slice_plane.get_color()
+   
+    def set_grid_line_color(self, val):
+        self.bound_slice_plane.set_grid_line_color(glm3(val))
+    
+    def get_grid_line_color(self):
+        return self.bound_slice_plane.get_grid_line_color()
+    
+    def set_transparency(self, val):
+        self.bound_slice_plane.set_transparency(val)
+    
+    def get_transparency(self):
+        return self.bound_slice_plane.get_transparency()
+
     def set_draw_plane(self, val):
         self.bound_slice_plane.set_draw_plane(val)
 
@@ -559,11 +592,31 @@ def set_volume_mesh_to_inspect(self, val):
     def get_volume_mesh_to_inspect(self):
         return self.bound_slice_plane.get_volume_mesh_to_inspect()
 
+def add_slice_plane(name=None):
+    if name is None:
+        instance = psb.add_slice_plane()
+    else:
+        instance = psb.add_slice_plane(name)
+
+    return SlicePlane(instance)
+
+def get_slice_plane(name):
+    instance = psb.get_slice_plane(name)
+    return SlicePlane(instance)
+
+def remove_slice_plane(name):
+    psb.remove_slice_plane(name)
+
+def remove_all_slice_planes():
+    psb.remove_all_slice_planes()
+
 def add_scene_slice_plane():
+    # deprecated
     instance = psb.add_scene_slice_plane(False)
     return SlicePlane(instance)
 
 def remove_last_scene_slice_plane():
+    # deprecated
     psb.remove_last_scene_slice_plane()
 
 ### Camera Parameters

src/polyscope/core.py

@@ -270,25 +270,98 @@ def test_picking(self):
 
     def test_slice_plane(self):
 
+        # Test deprecated add_scene_slice_plane() function
         plane1 = ps.add_scene_slice_plane()
         plane2 = ps.add_scene_slice_plane()
 
+        # Test set_enabled / get_enabled
+        plane2.set_enabled(True)
+        self.assertEqual(True, plane2.get_enabled())
+        plane2.set_enabled(False)
+        self.assertEqual(False, plane2.get_enabled())
+        
+        # Test set_pose with tuple
         plane1.set_pose((-.5, 0., 0.), (1., 1., 1.)) 
 
+        # Test set_active / get_active
         plane1.set_active(False)
         self.assertEqual(False, plane1.get_active())
+        plane1.set_active(True)
+        self.assertEqual(True, plane1.get_active())
 
+        # Test set_draw_plane / get_draw_plane
         plane1.set_draw_plane(False)
         self.assertEqual(False, plane1.get_draw_plane())
+        plane1.set_draw_plane(True)
+        self.assertEqual(True, plane1.get_draw_plane())
 
+        # Test set_draw_widget / get_draw_widget
         plane1.set_draw_widget(False)
         self.assertEqual(False, plane1.get_draw_widget())
+        plane1.set_draw_widget(True)
+        self.assertEqual(True, plane1.get_draw_widget())
 
         ps.show(3)
 
         ps.remove_last_scene_slice_plane()
         ps.remove_last_scene_slice_plane()
 
+        # add with custom names 
+        plane3 = ps.add_slice_plane("custom_plane_1")
+        self.assertEqual(plane3.get_name(), "custom_plane_1")
+        
+        plane4 = ps.add_slice_plane("custom_plane_2")
+        self.assertEqual(plane4.get_name(), "custom_plane_2")
+        
+        # Test get_slice_plane
+        retrieved_plane = ps.get_slice_plane("custom_plane_1")
+        self.assertEqual(retrieved_plane.get_name(), "custom_plane_1")
+        
+        # Test set_color / get_color
+        plane3.set_color((0.5, 0.6, 0.7))
+        color = plane3.get_color()
+        for i in range(3):
+            self.assertAlmostEqual(color[i], [0.5, 0.6, 0.7][i], places=5)
+        
+        # Test set_grid_line_color / get_grid_line_color
+        plane3.set_grid_line_color((0.1, 0.2, 0.3))
+        grid_color = plane3.get_grid_line_color()
+        for i in range(3):
+            self.assertAlmostEqual(grid_color[i], [0.1, 0.2, 0.3][i], places=5)
+        
+        # Test set_transparency / get_transparency
+        plane3.set_transparency(0.5)
+        self.assertAlmostEqual(0.5, plane3.get_transparency())
+        plane3.set_transparency(0.0)
+        self.assertAlmostEqual(0.0, plane3.get_transparency())
+        plane3.set_transparency(1.0)
+        self.assertAlmostEqual(1.0, plane3.get_transparency())
+        
+        # Test set_pose with numpy array
+        plane4.set_pose(np.array([0.5, 0.5, 0.5]), np.array([0.0, 0.0, 1.0]))
+        
+        # Test get_center and get_normal
+        center = plane4.get_center()
+        self.assertIsNotNone(center)
+        self.assertEqual(len(center), 3)
+        
+        normal = plane4.get_normal()
+        self.assertIsNotNone(normal)
+        self.assertEqual(len(normal), 3)
+        
+        ps.show(3)
+        
+        # Test remove_slice_plane
+        ps.remove_slice_plane("custom_plane_1")
+        
+        # Test plane.remove() method
+        plane4.remove()
+        
+        # Test remove_all_slice_planes
+        ps.add_slice_plane("test1")
+        ps.add_slice_plane("test2")
+        ps.remove_all_slice_planes()
+
 
     def test_load_material(self):
 
@@ -814,6 +887,8 @@ def test_slice_plane(self):
 
         p = ps.register_point_cloud("test_cloud", self.generate_points())
 
+
+
         plane = ps.add_scene_slice_plane()
         p.set_cull_whole_elements(True)
         ps.show(3)