@bitbybit-dev/base 0.19.8 → 0.20.0

package/lib/api/services/point.d.ts

@@ -0,0 +1,222 @@
+import { GeometryHelper } from "./geometry-helper";
+import * as Inputs from "../inputs";
+import { Transforms } from "./transforms";
+/**
+ * Contains various methods for points. Point in bitbybit is simply an array containing 3 numbers for [x, y, z].
+ * Because of this form Point can be interchanged with Vector, which also is an array in [x, y, z] form.
+ * When creating 2D points, z coordinate is simply set to 0 - [x, y, 0].
+ */
+export declare class Point {
+    private readonly geometryHelper;
+    private readonly transforms;
+    constructor(geometryHelper: GeometryHelper, transforms: Transforms);
+    /**
+     * Transforms the single point
+     * @param inputs Contains a point and the transformations to apply
+     * @returns Transformed point
+     * @group transforms
+     * @shortname transform point
+     * @drawable true
+     */
+    transformPoint(inputs: Inputs.Point.TransformPointDto): Inputs.Base.Point3;
+    /**
+     * Transforms multiple points
+     * @param inputs Contains points and the transformations to apply
+     * @returns Transformed points
+     * @group transforms
+     * @shortname transform points
+     * @drawable true
+     */
+    transformPoints(inputs: Inputs.Point.TransformPointsDto): Inputs.Base.Point3[];
+    /**
+     * Transforms multiple points by multiple transformations
+     * @param inputs Contains points and the transformations to apply
+     * @returns Transformed points
+     * @group transforms
+     * @shortname transforms for points
+     * @drawable true
+     */
+    transformsForPoints(inputs: Inputs.Point.TransformsForPointsDto): Inputs.Base.Point3[];
+    /**
+     * Translate multiple points
+     * @param inputs Contains points and the translation vector
+     * @returns Translated points
+     * @group transforms
+     * @shortname translate points
+     * @drawable true
+     */
+    translatePoints(inputs: Inputs.Point.TranslatePointsDto): Inputs.Base.Point3[];
+    /**
+     * Translate multiple points
+     * @param inputs Contains points and the translation vector
+     * @returns Translated points
+     * @group transforms
+     * @shortname translate points with vectors
+     * @drawable true
+     */
+    translatePointsWithVectors(inputs: Inputs.Point.TranslatePointsWithVectorsDto): Inputs.Base.Point3[];
+    /**
+     * Translate multiple points by x, y, z values provided
+     * @param inputs Contains points and the translation in x y and z
+     * @returns Translated points
+     * @group transforms
+     * @shortname translate xyz points
+     * @drawable true
+     */
+    translateXYZPoints(inputs: Inputs.Point.TranslateXYZPointsDto): Inputs.Base.Point3[];
+    /**
+     * Scale multiple points by providing center point and x, y, z scale factors
+     * @param inputs Contains points, center point and scale factors
+     * @returns Scaled points
+     * @group transforms
+     * @shortname scale points on center
+     * @drawable true
+     */
+    scalePointsCenterXYZ(inputs: Inputs.Point.ScalePointsCenterXYZDto): Inputs.Base.Point3[];
+    /**
+     * Rotate multiple points by providing center point, axis and degrees of rotation
+     * @param inputs Contains points, axis, center point and angle of rotation
+     * @returns Rotated points
+     * @group transforms
+     * @shortname rotate points center axis
+     * @drawable true
+     */
+    rotatePointsCenterAxis(inputs: Inputs.Point.RotatePointsCenterAxisDto): Inputs.Base.Point3[];
+    /**
+     * Measures the closest distance between a point and a collection of points
+     * @param inputs Point from which to measure and points to measure the distance against
+     * @returns Distance to closest point
+     * @group extract
+     * @shortname distance to closest pt
+     * @drawable false
+     */
+    closestPointFromPointsDistance(inputs: Inputs.Point.ClosestPointFromPointsDto): number;
+    /**
+     * Finds the closest point index between a point and a collection of points. Caution, index is not 0 based, it starts with 1.
+     * @param inputs Point from which to find the index in a collection of points
+     * @returns Closest point index
+     * @group extract
+     * @shortname index of closest pt
+     * @drawable false
+     */
+    closestPointFromPointsIndex(inputs: Inputs.Point.ClosestPointFromPointsDto): number;
+    /**
+     * Finds the closest point in a collection
+     * @param inputs Point and points collection to find the closest point in
+     * @returns Closest point
+     * @group extract
+     * @shortname closest pt
+     * @drawable true
+     */
+    closestPointFromPoints(inputs: Inputs.Point.ClosestPointFromPointsDto): Inputs.Base.Point3;
+    /**
+     * Finds the distance between two points
+     * @param inputs Coordinates of start and end points
+     * @returns Distance
+     * @group measure
+     * @shortname distance
+     * @drawable false
+     */
+    distance(inputs: Inputs.Point.StartEndPointsDto): number;
+    /**
+     * Finds the distances between the start point and multiple end points
+     * @param inputs Coordinates of start and end points
+     * @returns Distances
+     * @group measure
+     * @shortname distances to points
+     * @drawable false
+     */
+    distancesToPoints(inputs: Inputs.Point.StartEndPointsListDto): number[];
+    /**
+     * Multiply point by a specified amount
+     * @param inputs The point to be multiplied and the amount of points to create
+     * @returns Distance
+     * @group transforms
+     * @shortname multiply point
+     * @drawable true
+     */
+    multiplyPoint(inputs: Inputs.Point.MultiplyPointDto): Inputs.Base.Point3[];
+    /**
+     * Get x coordinate of the point
+     * @param inputs The point
+     * @returns X coordinate
+     * @group get
+     * @shortname x coord
+     * @drawable false
+     */
+    getX(inputs: Inputs.Point.PointDto): number;
+    /**
+     * Get y coordinate of the point
+     * @param inputs The point
+     * @returns Y coordinate
+     * @group get
+     * @shortname y coord
+     * @drawable false
+     */
+    getY(inputs: Inputs.Point.PointDto): number;
+    /**
+     * Get z coordinate of the point
+     * @param inputs The point
+     * @returns Z coordinate
+     * @group get
+     * @shortname z coord
+     * @drawable false
+     */
+    getZ(inputs: Inputs.Point.PointDto): number;
+    /**
+     * Get average point of points
+     * @param inputs The points
+     * @returns point
+     * @group extract
+     * @shortname average point
+     * @drawable true
+     */
+    averagePoint(inputs: Inputs.Point.PointsDto): Inputs.Base.Point3;
+    /**
+     * Creates the xyz point
+     * @param inputs xyz information
+     * @returns point 3d
+     * @group create
+     * @shortname point xyz
+     * @drawable true
+     */
+    pointXYZ(inputs: Inputs.Point.PointXYZDto): Inputs.Base.Point3;
+    /**
+     * Creates the xy point
+     * @param inputs xy information
+     * @returns point 3d
+     * @group create
+     * @shortname point xy
+     * @drawable false
+     */
+    pointXY(inputs: Inputs.Point.PointXYDto): Inputs.Base.Point2;
+    /**
+     * Creates the spiral out of multiple points
+     * @param inputs Spiral information
+     * @returns Specified number of points in the array along the spiral
+     * @group create
+     * @shortname spiral
+     * @drawable true
+     */
+    spiral(inputs: Inputs.Point.SpiralDto): Inputs.Base.Point3[];
+    /**
+     * Creates a flat point grid on XY plane. This grid contains center points for hexagons of the given radius.
+     * Be aware that we control only the nr of hexagons to be made and not the length and width of the grid.
+     * @param inputs Information about hexagon and the grid
+     * @returns Points in the array on the grid
+     * @group create
+     * @shortname hex grid
+     * @drawable true
+     */
+    hexGrid(inputs: Inputs.Point.HexGridCentersDto): Inputs.Base.Point3[];
+    /**
+     * Removes consecutive duplicates from the point array with tolerance
+     * @param inputs points, tolerance and check first and last
+     * @returns Points in the array without consecutive duplicates
+     * @group clean
+     * @shortname remove duplicates
+     * @drawable true
+     */
+    removeConsecutiveDuplicates(inputs: Inputs.Point.RemoveConsecutiveDuplicatesDto): Inputs.Base.Point3[];
+    private closestPointFromPointData;
+}

package/lib/api/services/{point.ts → point.js}

@@ -1,17 +1,13 @@
-import { GeometryHelper } from "./geometry-helper";
-import * as Inputs from "../inputs";
-import { Transforms } from "./transforms";
-
 /**
  * Contains various methods for points. Point in bitbybit is simply an array containing 3 numbers for [x, y, z].
  * Because of this form Point can be interchanged with Vector, which also is an array in [x, y, z] form.
  * When creating 2D points, z coordinate is simply set to 0 - [x, y, 0].
  */
-
 export class Point {
-
-    constructor(private readonly geometryHelper: GeometryHelper, private readonly transforms: Transforms) { }
-
+    constructor(geometryHelper, transforms) {
+        this.geometryHelper = geometryHelper;
+        this.transforms = transforms;
+    }
     /**
      * Transforms the single point
      * @param inputs Contains a point and the transformations to apply
@@ -20,13 +16,12 @@ export class Point {
      * @shortname transform point
      * @drawable true
      */
-    transformPoint(inputs: Inputs.Point.TransformPointDto): Inputs.Base.Point3 {
+    transformPoint(inputs) {
         const transformation = inputs.transformation;
         let transformedControlPoints = [inputs.point];
         transformedControlPoints = this.geometryHelper.transformControlPoints(transformation, transformedControlPoints);
         return transformedControlPoints[0];
     }
-
     /**
      * Transforms multiple points
      * @param inputs Contains points and the transformations to apply
@@ -35,10 +30,9 @@ export class Point {
      * @shortname transform points
      * @drawable true
      */
-    transformPoints(inputs: Inputs.Point.TransformPointsDto): Inputs.Base.Point3[] {
+    transformPoints(inputs) {
         return this.geometryHelper.transformControlPoints(inputs.transformation, inputs.points);
     }
-
     /**
      * Transforms multiple points by multiple transformations
      * @param inputs Contains points and the transformations to apply
@@ -47,7 +41,7 @@ export class Point {
      * @shortname transforms for points
      * @drawable true
      */
-    transformsForPoints(inputs: Inputs.Point.TransformsForPointsDto): Inputs.Base.Point3[] {
+    transformsForPoints(inputs) {
         if (inputs.points.length !== inputs.transformation.length) {
             throw new Error("You must provide equal nr of points and transformations");
         }
@@ -55,7 +49,6 @@ export class Point {
             return this.geometryHelper.transformControlPoints(inputs.transformation[index], [pt])[0];
         });
     }
-
     /**
      * Translate multiple points
      * @param inputs Contains points and the translation vector
@@ -64,11 +57,10 @@ export class Point {
      * @shortname translate points
      * @drawable true
      */
-    translatePoints(inputs: Inputs.Point.TranslatePointsDto): Inputs.Base.Point3[] {
+    translatePoints(inputs) {
         const translationTransform = this.transforms.translationXYZ({ translation: inputs.translation });
         return this.geometryHelper.transformControlPoints(translationTransform, inputs.points);
     }
-
     /**
      * Translate multiple points
      * @param inputs Contains points and the translation vector
@@ -77,7 +69,7 @@ export class Point {
      * @shortname translate points with vectors
      * @drawable true
      */
-    translatePointsWithVectors(inputs: Inputs.Point.TranslatePointsWithVectorsDto): Inputs.Base.Point3[] {
+    translatePointsWithVectors(inputs) {
         if (inputs.points.length !== inputs.translations.length) {
             throw new Error("You must provide equal nr of points and translations");
         }
@@ -86,7 +78,6 @@ export class Point {
             return this.geometryHelper.transformControlPoints(translationTransforms[index], [pt])[0];
         });
     }
-
     /**
      * Translate multiple points by x, y, z values provided
      * @param inputs Contains points and the translation in x y and z
@@ -95,11 +86,10 @@ export class Point {
      * @shortname translate xyz points
      * @drawable true
      */
-    translateXYZPoints(inputs: Inputs.Point.TranslateXYZPointsDto): Inputs.Base.Point3[] {
+    translateXYZPoints(inputs) {
         const translationTransform = this.transforms.translationXYZ({ translation: [inputs.x, inputs.y, inputs.z] });
         return this.geometryHelper.transformControlPoints(translationTransform, inputs.points);
     }
-
     /**
      * Scale multiple points by providing center point and x, y, z scale factors
      * @param inputs Contains points, center point and scale factors
@@ -108,11 +98,10 @@ export class Point {
      * @shortname scale points on center
      * @drawable true
      */
-    scalePointsCenterXYZ(inputs: Inputs.Point.ScalePointsCenterXYZDto): Inputs.Base.Point3[] {
+    scalePointsCenterXYZ(inputs) {
         const scaleTransforms = this.transforms.scaleCenterXYZ({ center: inputs.center, scaleXyz: inputs.scaleXyz });
         return this.geometryHelper.transformControlPoints(scaleTransforms, inputs.points);
     }
-
     /**
      * Rotate multiple points by providing center point, axis and degrees of rotation
      * @param inputs Contains points, axis, center point and angle of rotation
@@ -121,11 +110,10 @@ export class Point {
      * @shortname rotate points center axis
      * @drawable true
      */
-    rotatePointsCenterAxis(inputs: Inputs.Point.RotatePointsCenterAxisDto): Inputs.Base.Point3[] {
+    rotatePointsCenterAxis(inputs) {
         const rotationTransforms = this.transforms.rotationCenterAxis({ center: inputs.center, axis: inputs.axis, angle: inputs.angle });
         return this.geometryHelper.transformControlPoints(rotationTransforms, inputs.points);
     }
-
     /**
      * Measures the closest distance between a point and a collection of points
      * @param inputs Point from which to measure and points to measure the distance against
@@ -134,10 +122,9 @@ export class Point {
      * @shortname distance to closest pt
      * @drawable false
      */
-    closestPointFromPointsDistance(inputs: Inputs.Point.ClosestPointFromPointsDto): number {
+    closestPointFromPointsDistance(inputs) {
         return this.closestPointFromPointData(inputs).distance;
     }
-
     /**
      * Finds the closest point index between a point and a collection of points. Caution, index is not 0 based, it starts with 1.
      * @param inputs Point from which to find the index in a collection of points
@@ -146,10 +133,9 @@ export class Point {
      * @shortname index of closest pt
      * @drawable false
      */
-    closestPointFromPointsIndex(inputs: Inputs.Point.ClosestPointFromPointsDto): number {
+    closestPointFromPointsIndex(inputs) {
         return this.closestPointFromPointData(inputs).index;
     }
-
     /**
      * Finds the closest point in a collection
      * @param inputs Point and points collection to find the closest point in
@@ -158,10 +144,9 @@ export class Point {
      * @shortname closest pt
      * @drawable true
      */
-    closestPointFromPoints(inputs: Inputs.Point.ClosestPointFromPointsDto): Inputs.Base.Point3 {
-        return this.closestPointFromPointData(inputs).point as Inputs.Base.Point3;
+    closestPointFromPoints(inputs) {
+        return this.closestPointFromPointData(inputs).point;
     }
-
     /**
      * Finds the distance between two points
      * @param inputs Coordinates of start and end points
@@ -170,13 +155,12 @@ export class Point {
      * @shortname distance
      * @drawable false
      */
-    distance(inputs: Inputs.Point.StartEndPointsDto): number {
+    distance(inputs) {
         const x = inputs.endPoint[0] - inputs.startPoint[0];
         const y = inputs.endPoint[1] - inputs.startPoint[1];
         const z = inputs.endPoint[2] - inputs.startPoint[2];
         return Math.sqrt(x * x + y * y + z * z);
     }
-
     /**
      * Finds the distances between the start point and multiple end points
      * @param inputs Coordinates of start and end points
@@ -185,12 +169,11 @@ export class Point {
      * @shortname distances to points
      * @drawable false
      */
-    distancesToPoints(inputs: Inputs.Point.StartEndPointsListDto): number[] {
+    distancesToPoints(inputs) {
         return inputs.endPoints.map(pt => {
             return this.distance({ startPoint: inputs.startPoint, endPoint: pt });
         });
     }
-
     /**
      * Multiply point by a specified amount
      * @param inputs The point to be multiplied and the amount of points to create
@@ -199,14 +182,13 @@ export class Point {
      * @shortname multiply point
      * @drawable true
      */
-    multiplyPoint(inputs: Inputs.Point.MultiplyPointDto): Inputs.Base.Point3[] {
+    multiplyPoint(inputs) {
         const points = [];
         for (let i = 0; i < inputs.amountOfPoints; i++) {
             points.push([inputs.point[0], inputs.point[1], inputs.point[2]]);
         }
         return points;
     }
-
     /**
      * Get x coordinate of the point
      * @param inputs The point
@@ -215,10 +197,9 @@ export class Point {
      * @shortname x coord
      * @drawable false
      */
-    getX(inputs: Inputs.Point.PointDto): number {
+    getX(inputs) {
         return inputs.point[0];
     }
-
     /**
      * Get y coordinate of the point
      * @param inputs The point
@@ -227,10 +208,9 @@ export class Point {
      * @shortname y coord
      * @drawable false
      */
-    getY(inputs: Inputs.Point.PointDto): number {
+    getY(inputs) {
         return inputs.point[1];
     }
-
     /**
      * Get z coordinate of the point
      * @param inputs The point
@@ -239,10 +219,9 @@ export class Point {
      * @shortname z coord
      * @drawable false
      */
-    getZ(inputs: Inputs.Point.PointDto): number {
+    getZ(inputs) {
         return inputs.point[2];
     }
-
     /**
      * Get average point of points
      * @param inputs The points
@@ -251,24 +230,21 @@ export class Point {
      * @shortname average point
      * @drawable true
      */
-    averagePoint(inputs: Inputs.Point.PointsDto): Inputs.Base.Point3 {
+    averagePoint(inputs) {
         const xVals = [];
         const yVals = [];
         const zVals = [];
-
         inputs.points.forEach(pt => {
             xVals.push(pt[0]);
             yVals.push(pt[1]);
             zVals.push(pt[2]);
         });
-
         return [
             xVals.reduce((p, c) => p + c, 0) / inputs.points.length,
             yVals.reduce((p, c) => p + c, 0) / inputs.points.length,
             zVals.reduce((p, c) => p + c, 0) / inputs.points.length,
         ];
     }
-
     /**
      * Creates the xyz point
      * @param inputs xyz information
@@ -277,10 +253,9 @@ export class Point {
      * @shortname point xyz
      * @drawable true
      */
-    pointXYZ(inputs: Inputs.Point.PointXYZDto): Inputs.Base.Point3 {
+    pointXYZ(inputs) {
         return [inputs.x, inputs.y, inputs.z];
     }
-
     /**
      * Creates the xy point
      * @param inputs xy information
@@ -289,10 +264,9 @@ export class Point {
      * @shortname point xy
      * @drawable false
      */
-    pointXY(inputs: Inputs.Point.PointXYDto): Inputs.Base.Point2 {
+    pointXY(inputs) {
         return [inputs.x, inputs.y];
     }
-
     /**
      * Creates the spiral out of multiple points
      * @param inputs Spiral information
@@ -301,7 +275,7 @@ export class Point {
      * @shortname spiral
      * @drawable true
      */
-    spiral(inputs: Inputs.Point.SpiralDto): Inputs.Base.Point3[] {
+    spiral(inputs) {
         const phi = inputs.phi;
         const b = Math.log(phi) / (Math.PI / inputs.widening);
         const spiral = [];
@@ -314,7 +288,6 @@ export class Point {
         }
         return spiral;
     }
-
     /**
      * Creates a flat point grid on XY plane. This grid contains center points for hexagons of the given radius.
      * Be aware that we control only the nr of hexagons to be made and not the length and width of the grid.
@@ -324,7 +297,7 @@ export class Point {
      * @shortname hex grid
      * @drawable true
      */
-    hexGrid(inputs: Inputs.Point.HexGridCentersDto): Inputs.Base.Point3[] {
+    hexGrid(inputs) {
         const xLength = Math.sqrt(Math.pow(inputs.radiusHexagon, 2) - Math.pow(inputs.radiusHexagon / 2, 2));
         const points = [];
         for (let ix = 0; ix < inputs.nrHexagonsX; ix++) {
@@ -335,7 +308,6 @@ export class Point {
                 points.push([adjustX, coordY, 0]);
             }
         }
-
         if (inputs.orientOnCenter) {
             const compensateX = points[points.length - 1][0] / 2;
             const compensateY = points[points.length - 1][1] / 2;
@@ -343,16 +315,13 @@ export class Point {
                 points[index] = [p[0] - compensateX, p[1] - compensateY, 0];
             });
         }
-
         if (inputs.pointsOnGround) {
             points.forEach((p, index) => {
                 points[index] = [p[0], 0, p[1]];
             });
         }
-
         return points;
     }
-
     /**
      * Removes consecutive duplicates from the point array with tolerance
      * @param inputs points, tolerance and check first and last
@@ -361,26 +330,22 @@ export class Point {
      * @shortname remove duplicates
      * @drawable true
      */
-    removeConsecutiveDuplicates(inputs: Inputs.Point.RemoveConsecutiveDuplicatesDto): Inputs.Base.Point3[] {
+    removeConsecutiveDuplicates(inputs) {
         return this.geometryHelper.removeConsecutivePointDuplicates(inputs.points, inputs.checkFirstAndLast, inputs.tolerance);
     }
-
-    private closestPointFromPointData(inputs: Inputs.Point.ClosestPointFromPointsDto): {
-        index: number, point: Inputs.Base.Point3, distance: number
-    } {
+    closestPointFromPointData(inputs) {
         let distance = Number.MAX_SAFE_INTEGER;
-        let closestPointIndex: number;
-        let point: Inputs.Base.Point3;
+        let closestPointIndex;
+        let point;
         for (let i = 0; i < inputs.points.length; i++) {
             const pt = inputs.points[i];
             const currentDist = this.distance({ startPoint: inputs.point, endPoint: pt });
             if (currentDist < distance) {
                 distance = currentDist;
                 closestPointIndex = i;
-                point = pt as Inputs.Base.Point3;
+                point = pt;
             }
         }
         return { index: closestPointIndex + 1, distance, point };
     }
-
 }

package/lib/api/services/text.d.ts

@@ -0,0 +1,69 @@
+import * as Inputs from "../inputs";
+/**
+ * Contains various text methods.
+ */
+export declare class TextBitByBit {
+    /**
+     * Creates a text
+     * @param inputs a text
+     * @returns text
+     * @group create
+     * @shortname text
+     * @drawable false
+     */
+    create(inputs: Inputs.Text.TextDto): string;
+    /**
+    * Split the text to multiple pieces by a separator
+    * @param inputs a text
+    * @returns text
+    * @group transform
+    * @shortname split
+    * @drawable false
+    */
+    split(inputs: Inputs.Text.TextSplitDto): string[];
+    /**
+    * Replace all occurrences of a text by another text
+    * @param inputs a text
+    * @returns text
+    * @group transform
+    * @shortname replaceAll
+    * @drawable false
+    */
+    replaceAll(inputs: Inputs.Text.TextReplaceDto): string;
+    /**
+    * Join multiple items by a separator into text
+    * @param inputs a list of items
+    * @returns text
+    * @group transform
+    * @shortname join
+    * @drawable false
+    */
+    join(inputs: Inputs.Text.TextJoinDto): string;
+    /**
+    * Transform any item to text
+    * @param inputs any item
+    * @returns text
+    * @group transform
+    * @shortname to string
+    * @drawable false
+    */
+    toString<T>(inputs: Inputs.Text.ToStringDto<T>): string;
+    /**
+    * Transform each item in list to text
+    * @param inputs list of items
+    * @returns texts
+    * @group transform
+    * @shortname to strings
+    * @drawable false
+    */
+    toStringEach<T>(inputs: Inputs.Text.ToStringEachDto<T>): string[];
+    /**
+     * Format a text with values
+     * @param inputs a text and values
+     * @returns formatted text
+     * @group transform
+     * @shortname format
+     * @drawable false
+     */
+    format(inputs: Inputs.Text.TextFormatDto): string;
+}