feat: Add customizable casing shoe size (#481)

Let's the implementer override default shoe size. Issue: https://github.com/equinor/wellx-designer/issues/653
equinor · Sep 12, 2022 · 1e49f2e · 1e49f2e
1 parent f0c47ad
commit 1e49f2e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -81,9 +81,15 @@ export interface HoleSizeLayerOptions extends WellComponentBaseOptions {
   lineColor?: number;
 }
 
+export interface CasingShoeSize {
+  width: number;
+  length: number;
+}
+
 export interface CasingLayerOptions extends WellComponentBaseOptions {
   solidColor?: number;
   lineColor?: number;
+  casingShoeSize?: CasingShoeSize;
 }
 
 export interface CementLayerOptions extends WellComponentBaseOptions {

diff --git a/src/layers/CasingLayer.ts b/src/layers/CasingLayer.ts
@@ -1,7 +1,7 @@
 import { Point, Rectangle, RENDERER_TYPE, Texture } from 'pixi.js';
 import { zip } from 'd3-array';
 import { WellboreBaseComponentLayer } from './WellboreBaseComponentLayer';
-import { CasingLayerOptions, Casing } from '..';
+import { CasingLayerOptions, Casing, CasingShoeSize } from '..';
 import { makeTubularPolygon } from '../datautils/wellboreItemShapeGenerator';
 import { createNormals, offsetPoint, offsetPoints } from '../utils/vectorUtils';
 import { SHOE_LENGTH, SHOE_WIDTH } from '../constants';
@@ -16,13 +16,19 @@ export interface CasingRenderObject {
   casingWallWidth: number;
 }
 
+const defaultCasingShoeSize: CasingShoeSize = {
+  width: SHOE_WIDTH,
+  length: SHOE_LENGTH,
+};
+
 export class CasingLayer extends WellboreBaseComponentLayer {
   constructor(id?: string, options?: CasingLayerOptions) {
     super(id, options);
     this.options = {
       ...this.options,
       solidColor: 0xdcdcdc,
       lineColor: 0x575757,
+      casingShoeSize: defaultCasingShoeSize,
       ...options,
     };
   }
@@ -100,10 +106,9 @@ export class CasingLayer extends WellboreBaseComponentLayer {
   };
 
   drawShoe(casingEnd: number, casingRadius: number): void {
-    const { exaggerationFactor } = this.options as CasingLayerOptions;
-
-    const shoeWidth = SHOE_WIDTH * exaggerationFactor;
-    const shoeLength = SHOE_LENGTH * exaggerationFactor;
+    const { exaggerationFactor, casingShoeSize } = this.options as CasingLayerOptions;
+    const shoeWidth = casingShoeSize.width * exaggerationFactor;
+    const shoeLength = casingShoeSize.length * exaggerationFactor;
     const shoeCoords = this.generateShoe(casingEnd, casingRadius, shoeLength, shoeWidth);
     const shoeCoords2 = this.generateShoe(casingEnd, casingRadius, shoeLength, -shoeWidth);
     this.drawBigPolygon(shoeCoords2);