feat(grid3d): prop to show-hide grid lines added (#1624)

* feat(grid3d): prop to show-hide grid lines added * docs(grid3d): descr of gridLines prop updated --------- Co-authored-by: Leonid Polukhin <leonid.polukhin@aspentech.com>
equinor · Aug 2, 2023 · 0b22788 · 0b22788
1 parent 2529360
commit 0b22788
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/typescript/packages/subsurface-viewer/src/layers/grid3d/grid3dLayer.stories.tsx b/typescript/packages/subsurface-viewer/src/layers/grid3d/grid3dLayer.stories.tsx
@@ -43,6 +43,7 @@ const defaultProps = {
 const grid3dLayer = {
     "@@type": "Grid3DLayer",
     id: "Grid3DLayer",
+    gridLines: true,
     material: true,
     colorMapName: "Rainbow",
     ZIncreasingDownwards: false,

diff --git a/typescript/packages/subsurface-viewer/src/layers/grid3d/grid3dLayer.ts b/typescript/packages/subsurface-viewer/src/layers/grid3d/grid3dLayer.ts
@@ -103,6 +103,11 @@ export interface Grid3DLayerProps extends ExtendedLayerProps {
      */
     colorMapFunction?: colorMapFunctionType | false;
 
+    /** Enable lines around cell faces.
+     *  default: true.
+     */
+    gridLines: boolean;
+
     /** Surface material properties.
      * material: true  = default material, coloring depends on surface orientation and lighting.
      *           false = no material,  coloring is independent on surface orientation and lighting.
@@ -133,6 +138,7 @@ const defaultProps = {
     visible: true,
     material: true,
     colorMapName: "",
+    gridLines: true,
     propertyValueRange: [0.0, 1.0],
     depthTest: true,
     ZIncreasingDownwards: true,
@@ -258,6 +264,7 @@ export default class Grid3DLayer extends CompositeLayer<Grid3DLayerProps> {
                 colorMapRange: this.props.colorMapRange,
                 colorMapClampColor: this.props.colorMapClampColor,
                 colorMapFunction: this.props.colorMapFunction,
+                gridLines: this.props.gridLines,
                 propertyValueRange: this.state["propertyValueRange"],
                 material: this.props.material,
                 depthTest: this.props.depthTest,

diff --git a/typescript/packages/subsurface-viewer/src/layers/grid3d/privateLayer.ts b/typescript/packages/subsurface-viewer/src/layers/grid3d/privateLayer.ts
@@ -102,6 +102,7 @@ export interface privateLayerProps extends ExtendedLayerProps {
     colorMapRange: [number, number];
     colorMapClampColor: Color | undefined | boolean;
     colorMapFunction?: colorMapFunctionType | false;
+    gridLines: boolean;
     propertyValueRange: [number, number];
     depthTest: boolean;
 }
@@ -247,7 +248,9 @@ export default class privateLayer extends Layer<privateLayerProps> {
         gl.disable(gl.POLYGON_OFFSET_FILL);
 
         // Draw lines.
-        mesh_lines_model.draw();
+        if (this.props.gridLines) {
+            mesh_lines_model.draw();
+        }
 
         if (!this.props.depthTest) {
             gl.enable(gl.DEPTH_TEST);