wip pin label dimension

Author: matas-bitbybit-dev

packages/dev/occt-worker/lib/api/occt/dimensions.ts

@@ -10,7 +10,7 @@ export class OCCTDimensions {
     }
 
     /**
-    * Creates simple linear length dimension between two points - measuring units
+    * Creates simple linear length dimension between two points - measuring units. You decide what kind of units you re using by providing a suffix.
     * @param inputs two points, direction, label size, label normal direction, offset, and unit suffix, decimal rounding place
     * @returns compound wires representing dimensions
     * @group simple
@@ -22,8 +22,8 @@ export class OCCTDimensions {
     }
 
     /**
-     * Creates simple angular dimension
-     * @param inputs two points, direction, label size, label normal direction, offset, and unit suffix, decimal rounding place
+     * Creates simple angular dimension. By default we output degrees, but you can opt to use radians.
+     * @param inputs a center, two directions, radius and various label parameters
      * @returns compound wires representing dimension
      * @group simple
      * @shortname angular dimension
@@ -32,4 +32,16 @@ export class OCCTDimensions {
     simpleAngularDimension(inputs: Inputs.OCCT.SimpleAngularDimensionDto): Promise<Inputs.OCCT.TopoDSCompoundPointer> {
         return this.occWorkerManager.genericCallToWorkerPromise("dimensions.simpleAngularDimension", inputs);
     }
+
+    /**
+     * Creates pin label. It can be used to explain things about the models or mark important things in the 3D scene
+     * @param inputs a start and end point, direction and parameters for the label
+     * @returns compound wires representing dimension
+     * @group simple
+     * @shortname pin with label
+     * @drawable true
+     */
+    pinWithLabel(inputs: Inputs.OCCT.PinWithLabelDto): Promise<Inputs.OCCT.TopoDSCompoundPointer> {
+        return this.occWorkerManager.genericCallToWorkerPromise("dimensions.pinWithLabel", inputs);
+    }
 }

packages/dev/occt/lib/api/inputs/occ-inputs.ts

@@ -6035,7 +6035,7 @@ export namespace OCCT {
             if (direction1 !== undefined) { this.direction1 = direction1; }
             if (direction2 !== undefined) { this.direction2 = direction2; }
             if (center !== undefined) { this.center = center; }
-            if( radius !== undefined) { this.radius = radius; }
+            if (radius !== undefined) { this.radius = radius; }
             if (offsetFromCenter !== undefined) { this.offsetFromCenter = offsetFromCenter; }
             if (crossingSize !== undefined) { this.extraSize = crossingSize; }
             if (radians !== undefined) { this.radians = radians; }
@@ -6118,4 +6118,59 @@ export namespace OCCT {
          */
         radians = false;
     }
+    export class PinWithLabelDto {
+        constructor(startPoint?: Base.Point3, endPoint?: Base.Point3, direction?: Base.Vector3, offsetFromStart?: number, label?: string, labelOffset?: number, labelSize?: number) {
+            if (startPoint !== undefined) { this.startPoint = startPoint; }
+            if (endPoint !== undefined) { this.endPoint = endPoint; }
+            if (direction !== undefined) { this.direction = direction; }
+            if (offsetFromStart !== undefined) { this.offsetFromStart = offsetFromStart; }
+            if (label !== undefined) { this.label = label; }
+            if (labelOffset !== undefined) { this.labelOffset = labelOffset; }
+            if (labelSize !== undefined) { this.labelSize = labelSize; }
+        }
+        /**
+         * The start point for dimension
+         * @default [0, 0, 0]
+         */
+        startPoint: Base.Point3 = [0, 0, 0];
+        /**
+         * The end point for dimension
+         * @default [0, 5, 2]
+         */
+        endPoint?: Base.Point3 = [0, 5, 2];
+        /**
+         * The dimension direction (must include length)
+         * @default [0, 0, 1]
+         */
+        direction?: Base.Vector3 = [0, 0, 1];
+        /**
+         * Offset from the start point
+         * @default 0
+         * @minimum 0
+         * @maximum Infinity
+         * @step 0.1
+         */
+        offsetFromStart? = 0;
+        /**
+         * The dimension label
+         * @default Pin
+         */
+        label? = "Pin";
+        /**
+         * The dimension label offset
+         * @default 0.3
+         * @minimum -Infinity
+         * @maximum Infinity
+         * @step 0.1
+         */
+        labelOffset? = 0.3;
+        /**
+         * The dimension label size
+         * @default 0.1
+         * @minimum 0
+         * @maximum Infinity
+         * @step 0.1
+         */
+        labelSize? = 0.1;
+    }
 }

packages/dev/occt/lib/occ-helper.ts

@@ -84,7 +84,7 @@ export class OccHelper {
         this.wiresService = new WiresService(occ, this.occRefReturns, this.vector, this.shapesHelperService, this.shapeGettersService, this.transformsService,
             this.enumService, this.entitiesService, this.converterService, this.geomService, this.edgesService, this.textService, this.operationsService);
 
-        this.dimensionsService = new DimensionsService(this.vector, this.point, this.transformsService,
+        this.dimensionsService = new DimensionsService(this.math, this.vector, this.point, this.transformsService,
             this.converterService, this.entitiesService, this.edgesService, this.wiresService);
 
         this.verticesService.wiresService = this.wiresService;

packages/dev/occt/lib/services/base/dimensions.service.ts

@@ -7,13 +7,14 @@ import * as Inputs from "../../api/inputs/inputs";
 import { TransformsService } from "./transforms.service";
 import { ConverterService } from "./converter.service";
 import { WiresService } from "./wires.service";
-import { Point, Vector } from "@bitbybit-dev/base";
+import { MathBitByBit, Point, Vector } from "@bitbybit-dev/base";
 import { EdgesService } from "./edges.service";
 import { EntitiesService } from "./entities.service";
 
 export class DimensionsService {
 
     constructor(
+        private readonly math: MathBitByBit,
         private readonly vector: Vector,
         private readonly point: Point,
         private readonly transformsService: TransformsService,
@@ -189,13 +190,17 @@ export class DimensionsService {
         const wireArc = this.wiresService.createWireFromEdge({ shape: arc });
 
         const midPt = this.wiresService.midPointOnWire({ shape: wireArc });
-        const angleDeg = this.vector.angleBetween({
+        let angle = this.vector.angleBetween({
             first: inputs.direction1,
             second: inputs.direction2,
         }) as number;
 
+        if (inputs.radians) {
+            angle = this.math.degToRad({number: angle});
+        }
+
         const txtOpt = new Inputs.OCCT.TextWiresDto();
-        txtOpt.text = angleDeg.toFixed(inputs.decimalPlaces) + " " + inputs.labelSuffix;
+        txtOpt.text = angle.toFixed(inputs.decimalPlaces) + " " + inputs.labelSuffix;
         txtOpt.xOffset = 0;
         txtOpt.yOffset = 0;
         txtOpt.height = inputs.labelSize;
@@ -239,4 +244,28 @@ export class DimensionsService {
         return res;
     }
 
+    pinWithLabel(inputs: Inputs.OCCT.PinWithLabelDto): TopoDS_Compound {
+        const pinLine = this.wiresService.createLineWireWithExtensions({
+            start: inputs.startPoint,
+            end: inputs.endPoint,
+            extensionStart: -inputs.offsetFromStart,
+            extensionEnd: 0,
+        });
+
+        const text = this.wiresService.textWiresWithData({
+            text: inputs.label,
+            xOffset: 0,
+            yOffset: 0,
+            height: inputs.labelSize,
+            centerOnOrigin: true,
+        });
+        const labelTransformed = this.transformsService.translate({
+            shape: text.compound,
+            translation: inputs.endPoint,
+        });
+
+        const res = this.converterService.makeCompound({ shapes: [pinLine, labelTransformed] });
+        return res;
+    }
+
 }

packages/dev/occt/lib/services/dimensions.ts

@@ -17,5 +17,10 @@ export class OCCTDimensions {
     simpleAngularDimension(inputs: Inputs.OCCT.SimpleAngularDimensionDto): TopoDS_Compound {
         return this.och.dimensionsService.simpleAngularDimension(inputs);
     }
+
+    pinWithLabel(inputs: Inputs.OCCT.PinWithLabelDto): TopoDS_Compound {
+        return this.och.dimensionsService.pinWithLabel(inputs);
+    }
+    
 
 }