Update rips module, proto files, and Python examples

Author: magnesj

docs/rips/PythonExamples/surfaces_and_visualization/create_polygon.py

@@ -33,3 +33,17 @@
         print("Coordinates for {}:".format(p.name))
         for coord in p.coordinates:
             print(coord)
+
+        # Customize appearance
+        appearance = p.appearance()
+        if appearance is not None:
+            appearance.line_color = "#ff0000"
+            appearance.line_thickness = 5
+            appearance.show_spheres = True
+            appearance.sphere_color = "#0000ff"
+            appearance.update()
+            print(
+                "Appearance updated: line_color={}, line_thickness={}".format(
+                    appearance.line_color, appearance.line_thickness
+                )
+            )

docs/rips/PythonExamples/wells_and_fractures/import_well_paths_and_logs.py

@@ -29,6 +29,14 @@
 for well_path in well_paths:
     print("Imported from individual files: " + well_path.name)
 
+# Set well path colors using hex color strings
+all_well_paths = resInsight.project.well_paths()
+colors = ["#ff0000", "#00ff00", "#0000ff", "#ffff00"]
+for i, well_path in enumerate(all_well_paths):
+    well_path.well_path_color = colors[i % len(colors)]
+    well_path.update()
+    print("Set color of " + well_path.name + " to " + well_path.well_path_color)
+
 
 well_path_names = resInsight.project.import_well_log_files(
     well_log_folder="D:/Projects/ResInsight-regression-test/ModelData/Norne_PLT_LAS"

docs/rips/generated/generated_classes.py

@@ -1084,11 +1084,13 @@ class WellPath(PdmObjectBase):
 
     Attributes:
         name (str): Name
+        well_path_color (str): Well Path Color
     """
     __custom_init__ = None #: Assign a custom init routine to be run at __init__
 
     def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
         self.name: str = ""
+        self.well_path_color: str = "#ff55ff"
         PdmObjectBase.__init__(self, pb2_object, channel)
         if WellPath.__custom_init__ is not None:
             WellPath.__custom_init__(self, pb2_object=pb2_object, channel=channel)
@@ -1490,6 +1492,16 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if Polygon.__custom_init__ is not None:
             Polygon.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+    def appearance(self) -> Optional[RimPolygonAppearance]:
+        """Appearance
+
+        Returns:
+             RimPolygonAppearance
+        """
+        children = self.children("Appearance", RimPolygonAppearance)
+        return children[0] if len(children) > 0 else None
+
+
 class PolygonCollection(PdmObjectBase):
     __custom_init__ = None #: Assign a custom init routine to be run at __init__
 
@@ -1980,6 +1992,35 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if MudWeightWindowParameters.__custom_init__ is not None:
             MudWeightWindowParameters.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class RimPolygonAppearance(PdmObjectBase):
+    """
+    Attributes:
+        is_closed (bool): Closed Polygon
+        line_color (str): Line Color
+        line_thickness (int): Line Thickness
+        lock_polygon (bool): Lock Polygon to Plane
+        polygon_plane_depth (float): Polygon Plane Depth
+        show_lines (bool): Show Lines
+        show_spheres (bool): Show Spheres
+        sphere_color (str): Sphere Color
+        sphere_radius_factor (float): Sphere Radius Factor
+    """
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        self.is_closed: bool = True
+        self.line_color: str = "#ffa500"
+        self.line_thickness: int = 3
+        self.lock_polygon: bool = False
+        self.polygon_plane_depth: float = 0.000000000000000e+00
+        self.show_lines: bool = True
+        self.show_spheres: bool = False
+        self.sphere_color: str = "#ffa500"
+        self.sphere_radius_factor: float = 1.500000000000000e-01
+        PdmObjectBase.__init__(self, pb2_object, channel)
+        if RimPolygonAppearance.__custom_init__ is not None:
+            RimPolygonAppearance.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
 class ReservoirGridEnsemble(NamedObject):
     """
     Grid Ensemble from File Set
@@ -3805,6 +3846,7 @@ def class_dict() -> Dict[str, Type[PdmObjectBase]]:
     classes['ResampleData'] = ResampleData
     classes['Reservoir'] = Reservoir
     classes['ReservoirGridEnsemble'] = ReservoirGridEnsemble
+    classes['RimPolygonAppearance'] = RimPolygonAppearance
     classes['RimStatisticalCalculation'] = RimStatisticalCalculation
     classes['RoffCase'] = RoffCase
     classes['SimulationWell'] = SimulationWell

docs/rips/tests/test_polygon_appearance.py

@@ -0,0 +1,120 @@
+"""
+Tests for polygon appearance functionality.
+
+These tests verify that polygon appearance properties can be read and modified
+via the Python API.
+"""
+
+import os
+import sys
+
+import pytest
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+import rips
+
+
+@pytest.fixture
+def project(rips_instance):
+    """Get the current project."""
+    return rips_instance.project
+
+
+class TestPolygonAppearance:
+    """Tests for PolygonAppearance functionality."""
+
+    @pytest.fixture
+    def polygon(self, project):
+        """Create a test polygon."""
+        polygon_collection = project.descendants(rips.PolygonCollection)[0]
+        coordinates = [
+            [100.0, 200.0, 300.0],
+            [200.0, 200.0, 300.0],
+            [200.0, 300.0, 300.0],
+            [100.0, 300.0, 300.0],
+        ]
+        p = polygon_collection.create_polygon(
+            name="Test Polygon", coordinates=coordinates
+        )
+        return p
+
+    def test_access_appearance(self, polygon):
+        """Test that appearance child object is accessible."""
+        appearance = polygon.appearance()
+        assert appearance is not None, "Appearance should be accessible"
+
+    def test_default_values(self, polygon):
+        """Test that default appearance values are correct."""
+        appearance = polygon.appearance()
+        assert appearance.is_closed is True
+        assert appearance.show_lines is True
+        assert appearance.show_spheres is False
+        assert appearance.line_thickness == 3
+        assert appearance.lock_polygon is False
+
+    def test_set_line_color(self, polygon):
+        """Test setting line color."""
+        appearance = polygon.appearance()
+        appearance.line_color = "#ff0000"
+        appearance.update()
+
+        # Re-read to verify persistence
+        appearance2 = polygon.appearance()
+        assert appearance2.line_color == "#ff0000"
+
+    def test_set_sphere_color(self, polygon):
+        """Test setting sphere color."""
+        appearance = polygon.appearance()
+        appearance.sphere_color = "#00ff00"
+        appearance.update()
+
+        appearance2 = polygon.appearance()
+        assert appearance2.sphere_color == "#00ff00"
+
+    def test_set_line_thickness(self, polygon):
+        """Test setting line thickness."""
+        appearance = polygon.appearance()
+        appearance.line_thickness = 5
+        appearance.update()
+
+        appearance2 = polygon.appearance()
+        assert appearance2.line_thickness == 5
+
+    def test_set_show_spheres(self, polygon):
+        """Test toggling sphere visibility."""
+        appearance = polygon.appearance()
+        appearance.show_spheres = True
+        appearance.update()
+
+        appearance2 = polygon.appearance()
+        assert appearance2.show_spheres is True
+
+    def test_set_sphere_radius_factor(self, polygon):
+        """Test setting sphere radius factor."""
+        appearance = polygon.appearance()
+        appearance.sphere_radius_factor = 0.5
+        appearance.update()
+
+        appearance2 = polygon.appearance()
+        assert abs(appearance2.sphere_radius_factor - 0.5) < 1e-6
+
+    def test_set_is_closed(self, polygon):
+        """Test setting closed polygon state."""
+        appearance = polygon.appearance()
+        appearance.is_closed = False
+        appearance.update()
+
+        appearance2 = polygon.appearance()
+        assert appearance2.is_closed is False
+
+    def test_set_lock_polygon(self, polygon):
+        """Test setting lock polygon to plane."""
+        appearance = polygon.appearance()
+        appearance.lock_polygon = True
+        appearance.polygon_plane_depth = 500.0
+        appearance.update()
+
+        appearance2 = polygon.appearance()
+        assert appearance2.lock_polygon is True
+        assert abs(appearance2.polygon_plane_depth - 500.0) < 1e-6

docs/rips/tests/test_well_path_color.py

@@ -0,0 +1,39 @@
+import sys
+import os
+
+sys.path.insert(1, os.path.join(sys.path[0], "../../"))
+
+import dataroot
+
+
+def test_well_path_color(rips_instance, initialize_test):
+    """Test reading and setting well path colors via Python API."""
+    case_root_path = dataroot.PATH + "/TEST10K_FLT_LGR_NNC"
+    case_path = case_root_path + "/TEST10K_FLT_LGR_NNC.EGRID"
+    rips_instance.project.load_case(path=case_path)
+
+    well_path_files = [
+        case_root_path + "/wellpath_a.dev",
+        case_root_path + "/wellpath_b.dev",
+    ]
+    rips_instance.project.import_well_paths(well_path_files)
+    wells = rips_instance.project.well_paths()
+    assert len(wells) == 2
+
+    # Read default color
+    well_a = wells[0]
+    well_b = wells[1]
+    assert well_a.well_path_color is not None
+    assert well_b.well_path_color is not None
+
+    # Set colors using hex strings
+    well_a.well_path_color = "#ff0000"
+    well_a.update()
+
+    well_b.well_path_color = "#0000ff"
+    well_b.update()
+
+    # Re-fetch and verify colors persist
+    wells = rips_instance.project.well_paths()
+    assert wells[0].well_path_color == "#ff0000"
+    assert wells[1].well_path_color == "#0000ff"