dgeoutils 2.2.1 → 2.2.5

package/dist/DPolygon.d.ts

@@ -4,13 +4,46 @@ import { DLine } from './DLine';
 import { DPolygonLoop } from './DPolygonLoop';
 export declare const MIN_POINTS_IN_VALID_POLYGON = 3;
 export declare class DPolygon {
+    private pPoints;
     properties: {
         [key: string]: any;
     };
     holes: DPolygon[];
-    private pPoints;
     private searchStore;
-    constructor(points?: DPoint[]);
+    constructor(pPoints?: DPoint[]);
+    /**
+     * Specifies a round line buffer end cap style.
+     */
+    static CAP_ROUND: number;
+    /**
+     * Specifies a flat line buffer end cap style.
+     */
+    static CAP_FLAT: number;
+    /**
+     * Specifies a square line buffer end cap style.
+     */
+    static CAP_SQUARE: number;
+    /**
+     * Transform array of triangles to Three.JS vertices
+     *
+     * ```
+     * const geometry = new THREE.BufferGeometry();
+     * // create a simple square shape. We duplicate the top left and bottom right
+     * // vertices because each vertex needs to appear once per triangle.
+     * const vertices = new Float32Array( DPolygon.arrayOfTrianglesToVertices(triangles, 10) );
+     *
+     * // itemSize = 3 because there are 3 values (components) per vertex
+     * geometry.setAttribute( 'position', new THREE.BufferAttribute( vertices, 3 ) );
+     * const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
+     * mesh = new THREE.Mesh( geometry, material );
+     *
+     * scene.add( mesh );
+     * ```
+     *
+     * @param triangles
+     * @param [height=0]
+     */
+    static arrayOfTrianglesToVertices(triangles: DPolygon[], height?: number): number[];
     /**
      * Get size of min area rectangle.
      * @param poly should be `minAreaRectangle`
@@ -138,37 +171,25 @@ export declare class DPolygon {
      * @param newCenter
      */
     setCenter(newCenter: DPoint): DPolygon;
-    toWKT(): string;
+    static WKT_LINESTRING: string;
+    static WKT_POLYGON: string;
     /**
-     * Rotate polygon with center in point {0, 0}
-     * @param a Radians
+     * @param [type = DPolygon.WKT_POLYGON] Available values `DPolygon.WKT_POLYGON`, `DPolygon.WKT_LINESTRING`
      */
-    rotate(a: number): DPolygon;
+    toWKT(type?: string): string;
     /**
      * Filter points
      * @param f
      */
     filter(f: (p: DPoint) => boolean): DPolygon;
-    move(x?: number | DPoint, y?: number): DPolygon;
-    scale(x?: number | DPoint, y?: number): DPolygon;
-    divide(x?: number | DPoint, y?: number): DPolygon;
-    round(): DPolygon;
-    floor(): DPolygon;
-    ceil(): DPolygon;
-    flipVertically(size: DPoint | number): DPolygon;
-    toFixed(n?: number): DPolygon;
     map(f: (r: DPoint, index?: number) => DPoint): DPolygon;
-    p(index: number, divide?: boolean): DPoint;
+    at(index: number): DPoint;
     pop(): DPoint;
     push(...args: DPoint[]): number;
     shift(): DPoint;
     unshift(...args: DPoint[]): number;
     reverse(): DPolygon;
     getValue(): string;
-    degreeToMeters(): DPolygon;
-    metersToDegree(): DPolygon;
-    radiansToMeters(): DPolygon;
-    metersToRadians(): DPolygon;
     toString(): string;
     /**
      * Add to the end of polygon point equal to first point if it not exist
@@ -178,11 +199,6 @@ export declare class DPolygon {
      * Remove from the end of polygon point equal to first point if it exist
      */
     open(): DPolygon;
-    /**
-     * Set `height` (`z`)
-     * @param z
-     */
-    height(z: number): DPolygon;
     add(poly: DPolygon): DPolygon;
     /**
      * Check if has point in list of points
@@ -204,7 +220,7 @@ export declare class DPolygon {
     /**
      * Get polygon approximation by
      * [Ramer–Douglas–Peucker algorithm](https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm)
-     * @param e
+     * @param [e=Math.sqrt(this.perimeter)*APPROXIMATION_VALUE]
      */
     approximation(e?: number): DPolygon;
     insertAfter(index: number, ...points: DPoint[]): void;
@@ -224,8 +240,8 @@ export declare class DPolygon {
     /**
      * Check if contain point
      * @param p
-     * @param isBorderInside
-     * @param move Ignore this parameter
+     * @param [isBorderInside=false]
+     * @param [move=(0,0)] Ignore this parameter
      */
     contain(p: DPoint, isBorderInside?: boolean, move?: DPoint): boolean;
     /**
@@ -242,11 +258,20 @@ export declare class DPolygon {
      */
     removeDuplicates(): DPolygon;
     /**
-     * Parse from [OpenLayers](https://openlayers.org/) coordinates or
-     * [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) coordinates
+     * Parse from [OpenLayers](https://openlayers.org/) coordinates
+     * @param a
+     */
+    static parse(a: LatLng[]): DPolygon;
+    /**
+     * Parse from [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) coordinates
+     * @param a
+     */
+    static parse(a: number[][]): DPolygon;
+    /**
+     * Parse from [OpenLayers](https://openlayers.org/) coordinates
      * @param a
      */
-    static parse(a: LatLng[] | number[][] | DCoord[]): DPolygon;
+    static parse(a: DCoord[]): DPolygon;
     /**
      * Transform to array of coordinates for [OpenLayers](https://openlayers.org/) or
      * [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON)
@@ -270,14 +295,16 @@ export declare class DPolygon {
     /**
      * Divide polygon to triangles
      *
-     * ![Example](/media/examples/toTriangles.png)
+     * ![Example](https://edejin.github.io/DGeoUtils/media/examples/toTriangles.png)
      */
     toTriangles(): DPolygon[];
+    get closed(): boolean;
     /**
-     * @internal
+     * @param v
+     * @param [quadrantSegments=64]
+     * @param [type=DPolygon.CAP_ROUND] DPolygon.CAP_ROUND || DPolygon.CAP_FLAT || DPolygon.CAP_SQUARE
      */
-    getTriangle(): DPolygon | void;
-    private innerAndNotIntersect;
+    buffer(v: number, quadrantSegments?: number, type?: number): DPolygon;
     private simpleIncludeX;
     private simpleIncludeY;
     private douglasPeucker;