@pirireis/webglobeplugins 0.16.0 → 0.16.1

package/semiplugins/lightweight/line-plugin.ts

@@ -1,343 +0,0 @@
-import { SemiPluginInterface } from "../interface";
-import { LineOnGlobeCache } from "../../programs/line-on-globe/naive-accurate-flexible";
-import { PluginStyleOptions } from "../type";
-import { Globe, ProgramInterface, PluginInterface, Color, BUFFER_TYPE } from "../../types";
-
-
-
-import { BufferOrchestrator } from "../../util/account/single-attribute-buffer-management/buffer-orchestrator";
-import { BufferManager } from "../../util/account/single-attribute-buffer-management/buffer-manager";
-import { BufferManagersMap } from "../../util/account/single-attribute-buffer-management/types";
-
-import { LongLat, UBOHandler } from "../../types";
-
-import { sphereCoord } from "../../util/geometry/index";
-import { constraintFloat } from "../../util/check/typecheck";
-import { BufferAndReadInfo } from "../../types";
-
-/**
- * This plugin is lightweight. Processes and memories minimal data. Sacrifices details.
- * Only two points to draw a line in 2D and an Arc in 3D.
- * The 3D arc does not fit the terrain!
- * The 2D line is straight, not great circle projection
- */
-
-export type LineInput = {
-    key: string; // Unique key for the line
-    start: LongLat; // Start position
-    start_altitude?: number; // Start altitude, default is 0
-    end: LongLat; // End position
-    end_altitude?: number; // End altitude, default is 0
-    color?: Color; // Color of the line
-    dashed_line_opacity?: number; // Proportion of the opacity of the dashed line
-    dashed_line_ratio?: number; // Ratio of the dashed line
-}
-
-export type LinePluginOptions = PluginStyleOptions & {
-
-    flatViewOn: boolean; // If true, the line will be drawn in flat view.
-    globeViewOn: boolean; // If true, the line will be drawn in globe view.
-    variativeColorsOn: boolean; // If true, the color will be variative based on the circle's radius.
-    defaultColor: Color; // Default color of the line.
-    dashedLineOpacityVariativeOn: boolean; // If true, the line will be dashed.
-    dashedLineRatioVariativeOn: boolean; // If true, the dashed line ratio will be variative based on the circle's radius.
-    bufferType: BUFFER_TYPE; // Buffer draw type, default is DYNAMIC_DRAW
-    opacity: number; // Opacity of the line, default is 1.0
-    initialCapacity: number;
-
-}
-
-export class LinePlugin implements PluginInterface, SemiPluginInterface {
-    id: string;
-    private globe: Globe | null = null;
-    private gl: WebGL2RenderingContext | null = null;
-    private program: ProgramInterface | null = null;
-    private vao: WebGLVertexArrayObject | null = null;
-    private _options: LinePluginOptions;
-    private _uboHandler: UBOHandler | null = null;
-    private bufferOrchestrator: BufferOrchestrator;
-    private bufferManagersMap: BufferManagersMap = new Map();
-    private _freed: boolean = false;
-
-    constructor(id: string, {
-        flatViewOn = true,
-        globeViewOn = true,
-        variativeColorsOn = false,
-        defaultColor = [1, 1, 1, 1],
-        dashedLineOpacityVariativeOn = false,
-        dashedLineRatioVariativeOn = false,
-        bufferType = "DYNAMIC_DRAW",
-        opacity = 1.0,
-        initialCapacity = 10
-    }: Partial<LinePluginOptions> = {}) {
-        this.id = id;
-        this._options = {
-            flatViewOn: flatViewOn ?? true,
-            globeViewOn: globeViewOn ?? true,
-            variativeColorsOn: variativeColorsOn ?? false,
-            defaultColor: defaultColor ?? [1, 1, 1, 1],
-            dashedLineOpacityVariativeOn: dashedLineOpacityVariativeOn ?? false,
-            dashedLineRatioVariativeOn: dashedLineRatioVariativeOn ?? false,
-            bufferType: bufferType ?? "DYNAMIC_DRAW",
-            opacity: opacity ?? 1.0,
-            initialCapacity: initialCapacity ?? 10
-        };
-        this.bufferOrchestrator = new BufferOrchestrator({ capacity: initialCapacity ?? 10 });
-    }
-
-
-    init(globe: Globe, gl: WebGL2RenderingContext): void {
-        this.globe = globe;
-        this.gl = gl;
-
-        this.program = LineOnGlobeCache.get(globe) as ProgramInterface;
-
-        this._uboHandler = this.program.createUBO() as UBOHandler;
-        this.setDefaultColor(this._options.defaultColor);
-
-
-        this._fillManagerMap();
-
-
-        this.vao = this.program.createVAO(
-            ...this._createSelectBufferNames().map((key) => {
-                if (key === null) {
-                    return null;
-                }
-                const bufferManagerComp = this.bufferManagersMap.get(key);
-                if (bufferManagerComp === undefined) {
-                    throw new Error(`Buffer key ${key} does not exist in bufferManagersMap`);
-                }
-                const { bufferManager } = bufferManagerComp;
-                return {
-                    stride: 0,
-                    offset: 0,
-                    buffer: bufferManager.buffer as WebGLBuffer
-                } as BufferAndReadInfo;
-            })
-        );
-
-    }
-
-    // PLUGIN INTERFACE METHODS
-
-
-
-    increaseSpace(amount: number): void {
-        if (this._freed) {
-            console.warn("Plugin is freed, cannot increase space");
-            return;
-        }
-        if (this.globe === null) {
-            console.warn("Globe is not initialized.");
-            return;
-        }
-        if (typeof amount !== "number" || amount <= 0) {
-            console.warn("Invalid amount, must be a positive number");
-            return;
-        }
-        this.bufferOrchestrator.ensureSpace(amount, this.bufferManagersMap!);
-    }
-
-
-    insertBulk(items: Array<LineInput>): void {
-        const { bufferOrchestrator, bufferManagersMap, globe } = this;
-        if (!bufferOrchestrator || !globe) {
-            throw new Error("Buffer orchestrator or globe is not initialized.");
-        }
-        bufferOrchestrator.insertBulk(items, bufferManagersMap);
-        this.globe?.DrawRender();
-    }
-
-    deleteBulk(keys: Array<string>): void {
-        const { bufferOrchestrator, bufferManagersMap, globe } = this;
-        if (!bufferOrchestrator || !globe) {
-            throw new Error("Buffer orchestrator or globe is not initialized.");
-        }
-        bufferOrchestrator.deleteBulk(keys, bufferManagersMap);
-        this.globe?.DrawRender();
-    }
-
-
-    setPluginOpacity(opacity: number, drawRender: boolean = false): void {
-        constraintFloat(opacity, 0, 1);
-        this._options.opacity = opacity;
-        if (drawRender) {
-            this.globe?.DrawRender();
-        }
-    }
-
-    setPluginDashedLineRatio(ratio: number): void {
-        constraintFloat(ratio, 0, 1);
-        this._uboHandler?.updateSingle("dashed_line_ratio", new Float32Array([ratio]));
-        this.globe?.DrawRender();
-    }
-
-    setPluginDashLineOpacity(opacity: number): void {
-        constraintFloat(opacity, 0, 1);
-        this._options.dashedLineOpacityVariativeOn = true;
-        this._options.defaultColor[3] = opacity; // Update the default color's alpha channel
-        this.globe?.DrawRender();
-    }
-
-
-
-    setDefaultColor(color: Color, drawRender: boolean = false): void {
-        if (!this.globe || !this.gl) {
-            console.warn("Globe or WebGL context is not initialized.");
-            return;
-        }
-        this._options.defaultColor = color;
-        this._uboHandler?.updateSingle("u_color", new Float32Array(color));
-        if (drawRender) {
-            this.globe.DrawRender();
-        }
-    }
-
-
-
-    updateCoordinates(items: Pick<LineInput, "key" | "start" | "end">[]): void {
-        throw new Error("Method not implemented.");
-    }
-    // GLOBE INTERACTION METHODS
-
-    draw3D(): void {
-        if (this._freed) {
-            console.warn("Plugin has been freed, cannot draw.");
-        };
-
-        if (!this.globe || !this.gl || !this.program || !this.vao) {
-            throw new Error("Globe, GL context or program is not initialized.");
-        }
-
-        const { bufferOrchestrator, _options, _uboHandler, vao } = this;
-        if (!bufferOrchestrator || !bufferOrchestrator || !_uboHandler) {
-            throw new Error("Buffer orchestrator is not initialized.");
-        }
-
-        const { flatViewOn, globeViewOn, opacity } = _options;
-
-        const drawOptions = {
-            drawRange: {
-                first: 0,
-                count: bufferOrchestrator.length
-            }
-        }
-        this.gl.disable(this.gl.DEPTH_TEST); // Disable depth test for lines
-        const currentGeometry = this.globe.api_GetCurrentGeometry();
-        if (currentGeometry === 0 && globeViewOn) {
-            // @ts-ignore
-            this.program.draw(vao, drawOptions, opacity, _uboHandler)
-        } else if (currentGeometry === 1 && flatViewOn) {
-            // @ts-ignore
-            this.program.draw(vao, drawOptions, opacity, _uboHandler);
-        }
-        this.gl.enable(this.gl.DEPTH_TEST); // Re-enable depth test after drawing
-    }
-
-
-    free(): void {
-        if (this._freed) return;
-        // TODO: FILL
-
-        this.bufferManagersMap.forEach((manager) => {
-            manager.bufferManager.free();
-        });
-        this._uboHandler?.free();
-        LineOnGlobeCache.release(this.globe as Globe);
-        this._freed = true;
-    }
-
-
-
-    // IMPLICIT INTERFACE METHODS
-
-    _fillManagerMap(): void {
-        const globe = this.globe as Globe;
-
-        const {
-            flatViewOn,
-            globeViewOn,
-            variativeColorsOn,
-            dashedLineOpacityVariativeOn,
-            dashedLineRatioVariativeOn,
-            bufferType = "DYNAMIC_DRAW"
-        } = this._options;
-
-        const m = this.bufferManagersMap;
-        const initialCapacity = this._options.initialCapacity;
-
-        if (flatViewOn) {
-            m.set("start_position",
-                {
-                    bufferManager: new BufferManager(globe.gl, 2, { bufferType, initialCapacity: this._options.initialCapacity }),
-                    adaptor: (item: LineInput) => {
-                        const result = new Float32Array(globe.api_GetMercator2DPoint(item.start[0], item.start[1]))
-                        return result;
-                    }
-                });
-            m.set("end_position", {
-                bufferManager: new BufferManager(globe.gl, 2, { bufferType, initialCapacity: this._options.initialCapacity }),
-                adaptor: (item: LineInput) => new Float32Array(globe.api_GetMercator2DPoint(item.end[0], item.end[1]))
-            });
-        }
-
-        if (globeViewOn) {
-            m.set("start_position_3d", {
-                bufferManager: new BufferManager(globe.gl, 3, { bufferType, initialCapacity: this._options.initialCapacity }),
-                adaptor: (item: LineInput) => sphereCoord(item.start[0], item.start[1], globe, item.start_altitude || 0)
-            });
-
-            m.set("end_position_3d", {
-                bufferManager: new BufferManager(globe.gl, 3, { bufferType, initialCapacity: this._options.initialCapacity }),
-                adaptor: (item: LineInput) => sphereCoord(item.end[0], item.end[1], globe, item.end_altitude || 0)
-
-            });
-        }
-
-        if (variativeColorsOn) {
-            m.set("color", {
-                bufferManager: new BufferManager(globe.gl, 4, { bufferType, initialCapacity: this._options.initialCapacity }),
-                adaptor: (item: LineInput) => new Float32Array(item.color !== undefined ? item.color : [-1, -1, -1, -1])
-            });
-        }
-
-        if (dashedLineOpacityVariativeOn) {
-            m.set("dashed_line_opacity", {
-                bufferManager: new BufferManager(globe.gl, 1, { bufferType, initialCapacity: this._options.initialCapacity }),
-                adaptor: (item: LineInput) => new Float32Array(item.dashed_line_opacity !== undefined ? [item.dashed_line_opacity] : [-1])
-            });
-        }
-
-        if (dashedLineRatioVariativeOn) {
-            m.set("dashed_line_ratio", {
-                bufferManager: new BufferManager(globe.gl, 1, { bufferType, initialCapacity: this._options.initialCapacity }),
-                adaptor: (item: LineInput) => new Float32Array(item.dashed_line_ratio !== undefined ? [item.dashed_line_ratio] : [-1])
-            });
-        }
-
-    }
-
-
-    _createSelectBufferNames(): Array<string | null> {
-        const {
-            flatViewOn,
-            globeViewOn,
-            variativeColorsOn,
-            dashedLineOpacityVariativeOn,
-            dashedLineRatioVariativeOn
-        } = this._options;
-
-        return [
-            flatViewOn ? "start_position" : null,
-            globeViewOn ? "start_position_3d" : null,
-            flatViewOn ? "end_position" : null,
-            globeViewOn ? "end_position_3d" : null,
-            dashedLineOpacityVariativeOn ? "dashed_line_opacity" : null,
-            dashedLineRatioVariativeOn ? "dashed_line_ratio" : null,
-            variativeColorsOn ? "color" : null
-        ]
-    }
-
-}
-

package/semiplugins/lightweight/piece-of-pie-plugin.ts

@@ -1,275 +0,0 @@
-import { Globe, Meter, PluginInterface, Color, BUFFER_TYPE, LongLat, BufferAndReadInfo, UBOHandler } from "../../types";
-import { PieceOfPieProgramCache, Logic, DrawMode } from "../../programs/rings/partial-ring/piece-of-pie";
-import { BufferManagersMap, BufferManager, BufferOrchestrator } from "../../util/account/single-attribute-buffer-management/index";
-import { sphereCoord } from "../../util/geometry/index";
-import { opacityCheck } from "../../util/check/typecheck";
-import { CentigradeDegree } from "../../types";
-
-
-const INITIAL_CAPACITY = 10; // Initial capacity for the buffer orchestrator
-const EDGE_COUNT = 100; // Number of edges for the pie chart
-const Radians = Math.PI / 180; // Conversion factor from degrees to radians
-
-export type FillingMode = 0 | 1 | 2; // 0: constant, 1: fading, 2: hide
-export type DrawModePlugin = DrawMode | "BOTH";
-
-
-
-export type PieceOfPiePluginOptions = {
-    defaultHeightFromGroundIn3D: Meter; // Default altitude for the pie chart
-    bufferType: BUFFER_TYPE; // Type of buffer to use
-    initialCapacity: number; // Initial capacity for the buffer orchestrator
-    defaultColor: Color; // Default color for the pie chart
-    variativeColorsOn: boolean; // Whether to use variative colors
-    opacity: number; // Opacity of the pie chart
-}
-
-
-export type PieceOfPiePluginInput = {
-    key: string;
-    center: LongLat;
-    radius: Meter;
-    startAngle2D?: CentigradeDegree; // in radians
-    startAngle3D?: CentigradeDegree; // in radians
-    coverAngle2D?: CentigradeDegree; // in radians
-    coverAngle3D?: CentigradeDegree; // in radians
-    altitude?: Meter;
-    fillingMode?: FillingMode;
-    color?: Color;
-}
-
-
-export class PieceOfPiePlugin implements PluginInterface {
-    id: string;
-    private _isFreed: boolean = false;
-    private globe: Globe | null = null;
-    private gl: WebGL2RenderingContext | null = null;
-    private program: Logic | null = null;
-    private vao: WebGLVertexArrayObject | null = null;
-    private bufferManagersMap: BufferManagersMap | null = null;
-    private bufferOrchestrator: BufferOrchestrator = new BufferOrchestrator({ capacity: INITIAL_CAPACITY });
-    private drawMode: DrawModePlugin = "BOTH";
-    private _uboHandler: UBOHandler | null = null;
-
-    private _pluginOptions: PieceOfPiePluginOptions = {
-        bufferType: "STATIC_DRAW",
-        initialCapacity: INITIAL_CAPACITY,
-        opacity: 1.0, // Default opacity is 1.0
-        defaultHeightFromGroundIn3D: 0, // Default altitude is ground level
-        defaultColor: [1, 1, 1, 1], // Default color is white with full opacity
-        variativeColorsOn: false, // Default is to not use variative colors
-    };
-    constructor(
-        id: string,
-        options: Partial<PieceOfPiePluginOptions> | null = null
-    ) {
-        this.id = id;
-        if (options) {
-            this._pluginOptions = {
-                ...this._pluginOptions,
-                ...options
-            };
-        }
-    }
-
-
-    insertBulk(items: PieceOfPiePluginInput[]): void {
-
-        this.bufferOrchestrator.insertBulk(items, this.bufferManagersMap as BufferManagersMap);
-        this.globe?.DrawRender();
-    }
-
-
-    deleteBulk(keys: string[]): void {
-        this.bufferOrchestrator.deleteBulk(keys, this.bufferManagersMap as BufferManagersMap);
-        this.globe?.DrawRender();
-    }
-
-
-    setPluginOpacity(opacity: number, drawRender: boolean = true): void {
-        opacityCheck(opacity);
-        this._uboHandler?.updateSingle("u_opacity", new Float32Array([opacity]));
-        if (drawRender) {
-            this.globe?.DrawRender();
-        }
-    }
-
-    setDrawMode(drawMode: DrawMode): void {
-        if (drawMode !== "TRIANGLE_FAN" && drawMode !== "LINE_STRIP" && drawMode !== "BOTH") {
-            throw new Error("Invalid draw mode. Use 'TRIANGLE_FAN' or 'LINE_STRIP'.");
-        }
-        this.drawMode = drawMode;
-        this.globe?.DrawRender();
-    }
-
-
-    setDefaultColor(color: Color): void {
-        if (this._isFreed) {
-            console.warn("PieceOfPiePlugin is freed, cannot set default color.");
-            return;
-        }
-        if (!Array.isArray(color) || color.length !== 4) {
-            throw new Error("Color must be an array of 4 numbers [R, G, B, A].");
-        }
-        this._uboHandler?.updateSingle("u_color", new Float32Array(color));
-        this.globe?.DrawRender();
-    }
-
-
-    _createBufferManagersMap(): void {
-        const { gl, globe, _pluginOptions } = this;
-        const { bufferType, initialCapacity } = _pluginOptions;
-        if (!gl || !globe) {
-            throw new Error("Globe and WebGL context must be initialized before creating buffer management map.");
-        }
-
-        const bufferManagersMap: BufferManagersMap = new Map(
-            [
-                ["centerCoords2d", {
-                    bufferManager: new BufferManager(
-                        this.gl as WebGL2RenderingContext,
-                        2,
-                        { bufferType: bufferType, initialCapacity }
-                    ),
-                    adaptor: (item: PieceOfPiePluginInput) => new Float32Array(
-                        globe.api_GetMercator2DPoint(item.center[0], item.center[1])
-                    ),
-                }],
-                ["centerCoords3d", {
-                    bufferManager: new BufferManager(gl, 3, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => sphereCoord(
-                        item.center[0], item.center[1],
-                        globe,
-                        (item.altitude ?? this._pluginOptions.defaultHeightFromGroundIn3D) / 1000
-                    )
-                }],
-                ["startAngle2d", {
-                    bufferManager: new BufferManager(gl, 1, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => {
-                        if (item.startAngle2D === undefined) {
-                            return new Float32Array([0]); // Default angle if not provided
-                        }
-                        return new Float32Array([(item.startAngle2D) * Radians]);
-                    }
-                }],
-                ["tailAngle2d", {
-                    bufferManager: new BufferManager(gl, 1, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => {
-                        if (item.coverAngle2D === undefined) {
-                            return new Float32Array([0]); // Default angle if not provided
-                        }
-                        return new Float32Array([item.coverAngle2D * Radians]);
-                    }
-                }],
-                ["startAngle3d", {
-                    bufferManager: new BufferManager(gl, 1, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => {
-                        if (item.startAngle3D === undefined) {
-                            return new Float32Array([0]); // Default angle if not provided
-                        }
-                        return new Float32Array([item.startAngle3D * Radians]);
-                    }
-                }],
-                ["tailAngle3d", {
-                    bufferManager: new BufferManager(gl, 1, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => {
-                        if (item.coverAngle3D === undefined) {
-                            return new Float32Array([0]); // Default angle if not provided
-                        }
-                        return new Float32Array([item.coverAngle3D * Radians]);
-                    }
-                }],
-                ["fillingMode", {
-                    bufferManager: new BufferManager(gl, 1, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => new Float32Array([item.fillingMode ?? 0])
-                }],
-
-                ["radius", {
-                    bufferManager: new BufferManager(gl, 1, { bufferType, initialCapacity }),
-                    adaptor: (item: PieceOfPiePluginInput) => new Float32Array([item.radius])
-                }],
-            ]
-        );
-
-        if (this._pluginOptions.variativeColorsOn) {
-            bufferManagersMap.set("rgba", {
-                bufferManager: new BufferManager(gl, 4, { bufferType, initialCapacity }),
-                adaptor: (item: PieceOfPiePluginInput) => {
-                    if (!item.color || item.color.length === 0) {
-                        return new Float32Array([1, 1, 1, 1]); // Default color if none provided
-                    }
-                    return new Float32Array(item.color);
-                }
-            }
-            );
-        }
-        this.bufferManagersMap = bufferManagersMap;
-    }
-
-
-    init(globe: Globe, gl: WebGL2RenderingContext): void {
-        this.globe = globe;
-        this.gl = gl;
-        this.program = PieceOfPieProgramCache.get(globe) as Logic;
-        this._createBufferManagersMap();
-        this.vao = this.program.createVAO(
-            //@ts-ignore
-            ...['centerCoords2d',
-                'centerCoords3d',
-                'startAngle2d',
-                'tailAngle2d',
-                'startAngle3d',
-                'tailAngle3d',
-                'rgba',
-                'radius',
-                'fillingMode'].map((name) => {
-                    if (!this.bufferManagersMap?.has(name)) {
-                        return null; // this make vao with default attribute value with no buffer bound to it
-                    }
-                    const buffer = this.bufferManagersMap?.get(name)?.bufferManager.buffer;
-                    return {
-                        buffer: buffer,
-                        stride: 0,
-                        offset: 0,
-                    } as BufferAndReadInfo;
-                })
-        );
-
-        this._uboHandler = this.program.createUBO();
-        this._uboHandler.updateSingle("u_color", new Float32Array(this._pluginOptions.defaultColor));
-        this._uboHandler.updateSingle("u_opacity", new Float32Array([this._pluginOptions.opacity ?? 1.0])); // Default opacity is 1.0
-    }
-
-
-
-    draw3D(): void {
-        if (!this.gl || !this.program || !this.vao || !this.globe) {
-            console.warn("PieChartPlugin is not initialized properly Or unregistered from globe.");
-            return;
-        }
-        const length = this.bufferOrchestrator.length;
-        this.gl.disable(this.gl.DEPTH_TEST);
-        if (this.drawMode === "BOTH") {
-            this.program?.draw(length, this.vao, EDGE_COUNT, "LINE_STRIP", this._uboHandler);
-            this.program?.draw(length, this.vao, EDGE_COUNT, "TRIANGLE_FAN", this._uboHandler);
-        } else {
-            this.program?.draw(length, this.vao, EDGE_COUNT, this.drawMode as DrawMode, this._uboHandler);
-        }
-        this.gl.enable(this.gl.DEPTH_TEST);
-    }
-
-
-    free(): void {
-        if (this._isFreed) {
-            console.warn("PieChartPlugin is already freed.");
-            return;
-        }
-        PieceOfPieProgramCache.release(this.globe as Globe);
-        this.gl?.deleteVertexArray(this.vao as WebGLVertexArrayObject);
-        this._isFreed = true;
-        this.globe = null;
-        this.gl = null;
-        this.program = null;
-    }
-
-}