enhancing plot2d feature to color lines based on their depth in the water column:

- adding an  option to only plot the line color based on depth for shared lines.

Author: Yuksel-Rudy

famodel/project.py

@@ -2163,6 +2163,8 @@ def plot2d(self, ax=None, plot_seabed=False,draw_soil=False,plot_bathymetry=True
         ...
         bare : bool
             If True, supress display of extra labeling like the colorbar.
+        color_lineDepth: bool
+            If True, color mooring lines based on depth. Only works if plot_bathymetry=False.
         '''
 
         # Handle extra keyword arguments or use default values
@@ -2183,7 +2185,7 @@ def plot2d(self, ax=None, plot_seabed=False,draw_soil=False,plot_bathymetry=True
         show_legend = kwargs.get('show_legend', True)
 
         max_line_depth = kwargs.get('max_line_depth', None)  # max depth for line coloring if color_lineDepth is True
-        
+        only_shared    = kwargs.get('only_shared', False)   # if color_lineDepth is True, only color shared lines
         # if axes not passed in, make a new figure
         if ax == None:
             fig, ax = plt.subplots(1,1, figsize=figsize)
@@ -2251,16 +2253,15 @@ def plot2d(self, ax=None, plot_seabed=False,draw_soil=False,plot_bathymetry=True
                     ax.fill(env['x'], env['y'], edgecolor=edgecolor, facecolor='none', linestyle='dashed', lw=0.8, label='Platform Envelope')
 
         if plot_moorings:
-            depth_cmap_settings = None
+            line_depth_settings = None
             if color_lineDepth:
-                if max_line_depth is None:
-                    bath_depth = True
                 if plot_bathymetry:
                     raise ValueError("Cannot use depth-based line coloring with plot_bathymetry=True. Disable bathymetry to avoid confusion.")
-                depth_cmap_settings = {
+                line_depth_settings = {
                     "cmap": "Blues",
                     "vmin": max_line_depth if max_line_depth else -np.max(self.grid_depth),
-                    "vmax": 0
+                    "vmax": 0,
+                    "only_shared": only_shared
                 }            
             for mooring in self.mooringList.values():
                 for name, env in mooring.envelopes.items():
@@ -2296,23 +2297,23 @@ def plot2d(self, ax=None, plot_seabed=False,draw_soil=False,plot_bathymetry=True
 
                 if mooring.ss:
                     mooring.ss.drawLine2d(0, ax, color="self", endpoints=False, 
-                                          Xuvec=[1,0,0], Yuvec=[0,1,0], depth_cmap_settings=depth_cmap_settings, label=labs)  
+                                          Xuvec=[1,0,0], Yuvec=[0,1,0], line_depth_settings=line_depth_settings, label=labs)  
                 elif mooring.parallels:
                     for i,line in enumerate(lineList):
                         line.drawLine2d(0, ax, color="self",
-                                        Xuvec=[1,0,0], Yuvec=[0,1,0], depth_cmap_settings=depth_cmap_settings, label=labs[i])
+                                        Xuvec=[1,0,0], Yuvec=[0,1,0], line_depth_settings=line_depth_settings, label=labs[i])
 
                 else: # simple line plot
                     ax.plot([mooring.rA[0], mooring.rB[0]], 
                             [mooring.rA[1], mooring.rB[1]], 'k', lw=0.5, label='Mooring Line')
 
         # ---- Add colorbar for line depth ----
-        if depth_cmap_settings is not None and not bare:
+        if line_depth_settings is not None and not bare:
             import matplotlib.cm as cm
             import matplotlib.colors as mcolors
-            sm = cm.ScalarMappable(cmap=cm.get_cmap(depth_cmap_settings["cmap"]),
-                                norm=mcolors.Normalize(vmin=depth_cmap_settings["vmin"],
-                                                        vmax=depth_cmap_settings["vmax"]))
+            sm = cm.ScalarMappable(cmap=cm.get_cmap(line_depth_settings["cmap"]),
+                                norm=mcolors.Normalize(vmin=line_depth_settings["vmin"],
+                                                        vmax=line_depth_settings["vmax"]))
             sm.set_array([])
             cbar = plt.colorbar(sm, ax=ax, fraction=0.04)
             cbar.set_label("Line Depth (m)")