@equinor/videx-3d 1.0.3 → 1.1.0

package/dist/types/sdk/geometries/planar-geometry.d.ts

@@ -0,0 +1,69 @@
+import { Shape, Vector2 } from 'three';
+import { Vec2 } from '../types/common';
+export type PlanarGeometryType = 'point2d' | 'line2d' | 'polygon2d';
+export type Coordinates2D = Vec2[];
+export type PlanarPointCoordinates = Coordinates2D;
+export type PlanarLineCoordinates = Coordinates2D[];
+export type PlanarPolygonCoordinates = Coordinates2D[][];
+export type PlanarGeometryCoordinates = PlanarPointCoordinates | PlanarLineCoordinates | PlanarPolygonCoordinates;
+export type CoordinatesTransformFunction = (coord: Vec2) => Vec2;
+/**
+ * A simple abstraction for defining 2D points, lines or polygons,
+ * primarily for making it easier to work with GeoJson in videx-3d.
+ */
+export declare abstract class PlanarGeometry {
+    type: PlanarGeometryType;
+    coordinates: PlanarGeometryCoordinates;
+    private _min;
+    private _max;
+    private _size;
+    protected _offset: Vec2;
+    constructor(type: PlanarGeometryType, coordinates: PlanarGeometryCoordinates, offset?: Vec2);
+    static fromPointCoordinates(coordinates: PlanarPointCoordinates, transform?: CoordinatesTransformFunction): PlanarPointGeometry;
+    static fromLineCoordinates(coordinates: PlanarLineCoordinates, transform?: CoordinatesTransformFunction): PlanarLineGeometry;
+    static fromPolygonCoordinates(coordinates: PlanarPolygonCoordinates, transform?: CoordinatesTransformFunction): PlanarPolygonGeometry;
+    abstract forEachCoordinate(callback: (pos: Vec2) => void): void;
+    private _calculateBounds;
+    get min(): Vec2;
+    get max(): Vec2;
+    get center(): Vec2;
+    get size(): Vec2;
+    get offset(): Vec2;
+    setOffset(offset: Vec2): void;
+    removeOffset(): void;
+    centralize(): void;
+    normalize(scale?: Vec2, offset?: Vec2): void;
+    transform(transformFunc: CoordinatesTransformFunction): void;
+    abstract clone(): PlanarGeometry;
+    toObject(): {
+        type: string;
+        coordinates: PlanarGeometryCoordinates;
+        offset: Vec2;
+    };
+    abstract getPoints(): Vector2[][];
+    getPointsFlattened(): Vector2[];
+    getBounds(): {
+        min: Vec2;
+        max: Vec2;
+        size: Vec2;
+    };
+}
+export declare class PlanarPointGeometry extends PlanarGeometry {
+    constructor(coordinates: PlanarPointCoordinates, offset?: Vec2);
+    forEachCoordinate(callback: (pos: Vec2) => void): void;
+    getPoints(): Vector2[][];
+    clone(): PlanarPointGeometry;
+}
+export declare class PlanarLineGeometry extends PlanarGeometry {
+    constructor(coordinates: PlanarLineCoordinates, offset?: Vec2);
+    forEachCoordinate(callback: (pos: Vec2) => void): void;
+    getPoints(): Vector2[][];
+    clone(): PlanarLineGeometry;
+}
+export declare class PlanarPolygonGeometry extends PlanarGeometry {
+    constructor(coordinates: PlanarPolygonCoordinates, offset?: Vec2);
+    forEachCoordinate(callback: (pos: Vec2) => void): void;
+    getPoints(): Vector2[][];
+    clone(): PlanarPolygonGeometry;
+    toShapes(): Shape[];
+}

package/dist/types/sdk/utils/geojson.d.ts

@@ -0,0 +1,15 @@
+import { CoordinatesTransformFunction, PlanarGeometry } from '../geometries/planar-geometry';
+export type GeoJsonFeature = {
+    properties: Record<string, any>;
+    geometry: PlanarGeometry;
+};
+/**
+ * Simple helper function to parse a GeoJSON feature into a videx-3d GeoJsonFeature type,
+ * where the geometry is represented as an instance of PlanarGeometry.
+ * @param feature GeoJSON feature object
+ * @param transform Coordinate conversion function (i.e. from wgs84 to 3D world coordinates)
+ * @returns GeoJsonFeature type
+ *
+ * @see PlanarGeometry
+ */
+export declare function parseGeoJsonFeature(feature: any, transform?: CoordinatesTransformFunction): GeoJsonFeature;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/videx-3d",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "private": false,
   "type": "module",
   "license": "MIT",