@pirireis/webglobeplugins 0.17.0 → 1.0.2

package/types.ts

@@ -0,0 +1,319 @@
+export type TypedArray =
+    Float32Array | Float64Array |
+    Int32Array | Int16Array | Int8Array |
+    Uint32Array | Uint16Array | Uint8Array | Uint8ClampedArray;
+
+
+export type Color = [number, number, number, number] | Float32Array; // RGBA color format 0-1 
+export type CentigradeDegree = number;
+export type Meter = number;
+export type Radian = number;
+export type Degree = number;
+export type LongLatDegree = [CentigradeDegree, CentigradeDegree]; // [longitude, latitude]
+export type LongLatRadian = [Radian, Radian]; // [longitude, latitude]
+
+export type ColorRatio = {
+    color: Color;
+    ratio: CentigradeDegree;
+};
+
+export type BUFFER_TYPE = "STATIC_DRAW" | "DYNAMIC_DRAW" | "STREAM_DRAW";
+
+
+export type DRAW_MODE = 'LINE_STRIP' | 'TRIANGLE_FAN' | 'TRIANGLES' | 'POINTS' | 'LINES' | 'LINE_LOOP' | 'TRIANGLE_STRIP' | 'LINE_STRIP_ADJACENCY' | 'TRIANGLE_STRIP_ADJACENCY' | 'LINES_ADJACENCY' | 'PATCHES';
+
+
+export type GlobeLookInfo = {
+    CenterLong: CentigradeDegree;
+    CenterLat: CentigradeDegree;
+    Distance: Meter;
+    Tilt: CentigradeDegree;
+    NorthAng: CentigradeDegree;
+}
+
+
+export type GlobeBBox = {
+    ur: { x: Degree; y: Degree };
+    ll: { x: Degree; y: Degree };
+}
+
+export type Tile = {
+    row: number;
+    column: number;
+    level: number;
+}
+
+
+export type DrawnTileInfo = {
+    x: number;
+    y: number;
+    level: number;
+    mesh: Float32Array[];
+    bbox: GlobeBBox;
+}
+
+
+interface GlobeMath {
+    FindPointByPolar(
+        centerLong: CentigradeDegree,
+        centerLat: CentigradeDegree,
+        distance: Meter,
+        azimuth: CentigradeDegree
+    ): { long: CentigradeDegree, lat: CentigradeDegree };
+    GetDist2D(
+        long1: CentigradeDegree,
+        lat1: CentigradeDegree,
+        long2: CentigradeDegree,
+        lat2: CentigradeDegree
+    ): Meter;
+    GetAzimuthAngle(
+        long1: CentigradeDegree,
+        lat1: CentigradeDegree,
+        long2: CentigradeDegree,
+        lat2: CentigradeDegree
+    ): CentigradeDegree;
+    Clamp(x: number, min: number, max: number): number;
+}
+
+
+
+
+export interface TextFont {
+    name: string;
+    textColor: string;
+    hollowColor: string;
+    size: number;
+    hollow: boolean;
+    bold: boolean;
+    italic: boolean;
+    position?: CSMeasureTextPositionTypes | string | null;
+}
+
+
+type DrawOrder = {
+    GetObj(index: number): PluginInterface | null;
+}
+
+type FCamera = {
+    FCamLongLat: { x: Radian, y: Radian };
+}
+
+export interface Globe {
+    DrawRender(): void;
+    api_ScrW(): number;
+    api_ScrH(): number;
+    api_RegisterPlugin(plugin: PluginInterface, beforeObject: PluginInterface | null | undefined): void;
+    api_UnRegisterPlugin(pluginId: string): void;
+    api_GetCurrentGeometry(): 0 | 1;
+    api_FlyToPoint(long: number, lat: number, height: number, tilt: number, heading: number): void;
+    api_GetMousePos(): { canvasX: number; canvasY: number; };
+    api_GetCurrentLODWithDecimal(): number;
+    api_GetCurrentWorldWH(): { width: number; height: number };
+    api_GetCurrentLookInfo(): GlobeLookInfo;
+    api_GetCartesian3DPoint: (long: number, lat: number, height: number, msl: boolean) => [number, number, number];
+    api_GetMercator2DPoint: (long: number, lat: number) => [number, number];
+    api_IsScreenMoving(): boolean;
+    api_GetMouseDeg(): { lng: number; lat: number } | null;
+    api_GetZScale(): number;
+    api_SetSpaceColor(color: string): void; // color format: #RRGGBBAA
+    api_SetZScale(zScale: number): void; // Max 4 
+    api_SetWireFrameMode(wireFrame: boolean): void; // default false
+    api_DrawContextTextMultiLine(text: string, textFont: TextFont, opacity: number, position:
+        { x: number; y: number }, angleIsOn?: boolean | null, angle?: number | null): void;
+    api_GetScreenPointFromGeo(coords: { long: number; lat: number; z: number }, isMSL: boolean): { x: number | null; y: number | null };
+    api_GetCurrentWorldLimit(): GlobeBBox;
+    api_GetVisibleTilesInfo(): DrawnTileInfo[];
+    gl: WebGL2RenderingContext;
+    Fp: { x: number; y: number; z: number };
+    FUPos: { x: number; y: number; z: number };
+    Math: GlobeMath;
+    ObjectArray: ObjectArray;
+    DrawOrder: DrawOrder;
+    FCamera: FCamera;
+}
+
+
+
+export type GlobeChanges = {
+    geometry: boolean;
+    look: boolean;
+    lod: boolean;
+    lod2DWheel: boolean;
+    elevationScale: boolean;
+    screenMoved: boolean;
+}
+
+export type ChargerInput = {
+    totalTime: number;
+    ratio: number;
+    acceleration: number;
+}
+
+
+export type DrawRange = {
+    first: number;
+    count: number;
+};
+
+
+export type DrawRangeIndexParams = {
+    drawRange: DrawRange;
+    elementBuffer?: WebGLBuffer;
+    elementBufferIndexType?: number;
+    drawMode?: number;
+};
+
+
+export interface ProgramInterface {
+    draw(vao: WebGLVertexArrayObject, drawOptions: DrawRangeIndexParams, opacity: number, flexibleUBO: UBOHandler | null): void;
+    createUBO(bufferReadType?: "STATIC_DRAW" | "DYNAMIC_DRAW" | "STREAM_DRAW"): UBOHandler;
+    createVAO(...inputs: (BufferAndReadInfo | null)[]): WebGLVertexArrayObject;
+    free(): void;
+
+}
+
+export enum CSRenderPass {
+    NORMAL = 0,
+    SELECTED,
+    EDITING
+}
+
+export interface PluginInterface {
+    id: string;
+    globe: Globe | null;
+    init(globe: Globe, gl: WebGL2RenderingContext): void;
+    draw3D(projectionMatrix: Float32Array, modelViewMatrix: Float32Array, transPosition: { x: number, y: number, z: number }, csRenderPass: CSRenderPass): void;
+    draw2D?(csRenderPass: CSRenderPass): void;
+    free(): void;
+
+    mouseDown?(x: number, y: number, event: MouseEvent, csRenderPass: CSRenderPass): boolean;
+    mouseMove?(x: number, y: number, event: MouseEvent, csRenderPass: CSRenderPass): boolean;
+    mouseUp?(x: number, y: number, event: MouseEvent, csRenderPass: CSRenderPass): boolean;
+    mouseClick?(x: number, y: number, event: MouseEvent, csRenderPass: CSRenderPass): boolean;
+    mouseDblClick?(x: number, y: number, event: MouseEvent, csRenderPass: CSRenderPass): boolean;
+
+    supportNormalPass?: boolean;
+    supportSelectedPass?: boolean;
+    supportEditingPass?: boolean;
+}
+
+
+
+export type BufferAndReadInfo = {
+    buffer: WebGLBuffer;
+    stride: number;
+    offset: number;
+};
+
+export type BufferInfo = BufferAndReadInfo | null;
+
+export type AttributeLoaderOptions = {
+    divisor?: number | null;
+    type?: number | null;
+    escapeValues?: Array<number> | null;
+    normalized?: boolean;
+};
+
+export type UBOHandler = {
+    ubo: WebGLBuffer;
+    update: (nameValueMap: Map<string, any>) => void;
+    updateSingle: (name: string, value: Float32Array | Uint32Array | Int32Array | DataView | ArrayBuffer) => void;
+    bind: () => void;
+    unbind: () => void;
+    free: () => void;
+};
+
+
+export type PluginAttachmentParameters = {
+    plugin: PluginInterface;
+    freeOnUnregister?: boolean;
+}
+
+
+
+export interface ElevationMode {
+    setElevationMode(mode: "agl" | "msl"): void;
+}
+
+export interface UpdateColor {
+    updateColors(keyColorCouples: { key: string, color: Color }[], drawRender: boolean): void;
+}
+
+
+// OBJECT ARRAY START
+
+
+export interface ObjectArray {
+    Add(object: LayerObjectObjectArray): void;
+    Delete(id: string): void;
+    GetDefaultStyle(): StyleObjectArray;
+    StyleChanged(object: LayerObjectObjectArray): void;
+    UpdateData(object: LayerObjectObjectArray, mode: any, buckets: DataBucketObjectArray[], options: { attribs: boolean; icon: boolean; text: boolean }): void;
+    SetData(object: LayerObjectObjectArray, data: DataBucketObjectArray): void;
+}
+
+export interface StyleObjectArray {
+    fidKey: string;
+    opacity: number;
+    labels: LabelObjectArray[];
+}
+
+export interface LabelObjectArray {
+    offset: { x: number; y: number };
+    fontFamily: { hollowWidth: number };
+    vAlignment: number;
+    hAlignment: number;
+    size: number;
+    text: string;
+}
+
+export interface LayerObjectObjectArray {
+    displayName: string;
+    layerType: number;
+    wkbGeom: null;
+    wfsLayerName: null;
+    objectType: string;
+    bbox: null;
+    startLod: number;
+    endLod: number;
+    continuousLOD: boolean;
+    MVTXYZName: string;
+    rasterize: boolean;
+    style: StyleObjectArray;
+    id: string;
+}
+
+export interface DataBucketObjectArray {
+    coords: number[];
+    coordsZ: number[];
+    attribs: Record<string, any>[];
+}
+
+
+
+// OBJECT ARRAY FINISH
+
+
+//  GLOBE MANAGER
+
+export interface GlobeManager {
+    /**
+     * When mesh service is not working call this method with (false, true) it fixes issues
+     * @param retry 
+     * @param divideMeshFurther 
+     */
+    api_ReTryAtMeshTimeout(retry: boolean, divideMeshFurther: boolean): void;
+}
+
+export enum CSMeasureTextPositionTypes {
+    CENTER = 'center',
+    LEFT = 'left',
+    RIGHT = 'right',
+    TOP = 'bottom',
+    BOTTOM = 'top',
+    TOP_LEFT = 'bottom_left',
+    TOP_RIGHT = 'bottom_right',
+    BOTTOM_LEFT = 'top_left',
+    BOTTOM_RIGHT = 'top_right',
+};
+