@openglobus/og 0.11.7 → 0.12.3

package/types/entity/Label.d.ts

@@ -0,0 +1,189 @@
+/**
+ * Billboard text label.
+ * @class
+ * @extends {BaseBillboard}
+ * @param {Object} [options] - Label options:
+ * @param {Vec3|Array.<number>} [options.position] - Billboard spatial position.
+ * @param {number} [options.rotation] - Screen angle rotaion.
+ * @param {Vec4|string|Array.<number>} [options.color] - Billboard color.
+ * @param {Vec3|Array.<number>} [options.alignedAxis] - Billboard aligned vector.
+ * @param {Vec3|Array.<number>} [options.offset] - Billboard center screen offset.
+ * @param {boolean} [options.visibility] - Visibility.
+ * @param {string} [options.text] - Text string.
+ * @param {string} [options.face] - HTML5 font face.
+ * @param {number} [options.size] - Font size in pixels.
+ * @param {string} [options.style] - HTML5 font style. Example 'normal', 'italic'.
+ * @param {string} [options.weight] - HTML5 font weight. Example 'normal', 'bold'.
+ * @param {number} [options.outline] - Text outline size. 0 - no outline, 1 - maximum outline. Default 0.58.
+ * @param {Vec4|string|Array.<number>} [options.outlineColor] - Outline color.
+ * @param {Label.ALIGN} [options.align] - Text horizontal align: "left", "right" and "center".
+ */
+export class Label extends BaseBillboard {
+    /**
+     * Label text string.
+     * @private
+     * @type {string}
+     */
+    private _text;
+    /**
+     * HTML5 font face.
+     * @private
+     * @type {string}
+     */
+    private _face;
+    /**
+     * Font size in pixels.
+     * @private
+     * @type {number}
+     */
+    private _size;
+    /**
+     * Label outline.
+     * @private
+     * @type {number}
+     */
+    private _outline;
+    /**
+     * Label outline color.
+     * @private
+     * @type {Vec4}
+     */
+    private _outlineColor;
+    /**
+     * Text horizontal align: "left", "right" and "center".
+     * @private
+     * @type {Label.ALIGN}
+     */
+    private _align;
+    /**
+     * Label font atlas index.
+     * @private
+     * @type {number}
+     */
+    private _fontIndex;
+    /**
+     * Font atlas pointer.
+     * @private
+     * @type {utils.FontAtlas}
+     */
+    private _fontAtlas;
+    /**
+     * Sets lablel text.
+     * @public
+     * @param {string} text - Text string.
+     * It can't be bigger than maximum labelHandler _maxLetters value.
+     */
+    public setText(text: string): void;
+    /**
+     * Gets current text string.
+     * @public
+     * @returns {string}
+     */
+    public getText(): string;
+    /**
+     * Sets label text align. Could be center, left or right. Left is default.
+     * @public
+     * @param {Label.ALIGN} align - Text align.
+     */
+    public setAlign(align: Label.ALIGN): void;
+    /**
+     * Gets label text current alignment.
+     * @public
+     * @returns {Label.ALIGN}
+     */
+    public getAlign(): Label.ALIGN;
+    /**
+     * Sets font face family.
+     * @public
+     * @param {string} face - Font face family.
+     */
+    public setFace(face: string): void;
+    /**
+     * Gets current font face.
+     * @public
+     * @returns {string}
+     */
+    public getFace(): string;
+    /**
+     * Sets label font size in pixels.
+     * @public
+     * @param {number} size - Label size in pixels.
+     */
+    public setSize(size: number): void;
+    /**
+     * Gets label size in pixels.
+     * @public
+     * @returns {number}
+     */
+    public getSize(): number;
+    /**
+     * Sets text outline border size. Where 0 - is no outline and 1 - is the maximum outline size.
+     * @public
+     * @param {number} outline - Text outline size.
+     */
+    public setOutline(outline: number): void;
+    /**
+     * Gets text current outline size.
+     * @public
+     * @returns {number}
+     */
+    public getOutline(): number;
+    /**
+     * Sets text outline color.
+     * @public
+     * @param {number} r - Red.
+     * @param {number} g - Green.
+     * @param {number} b - Blue.
+     * @param {number} a - Alpha.
+     */
+    public setOutlineColor(r: number, g: number, b: number, a: number): void;
+    /**
+     * Sets text outline color.
+     * @public
+     * @param {Vec4} rgba - Color vector.
+     */
+    public setOutlineColor4v(rgba: Vec4): void;
+    /**
+     * Sets text outline color HTML string.
+     * @public
+     * @param {string} color - HTML string color.
+     */
+    public setOutlineColorHTML(color: string): void;
+    /**
+     * Gets outline color vector.
+     * @public
+     * @returns {Vec4}
+     */
+    public getOutlineColor(): Vec4;
+    /**
+     * Sets outline opacity. Actually outline color alpha value.
+     * @public
+     * @param {number} opacity - Outline opacity.
+     */
+    public setOutlineOpacity(opacity: number): void;
+    /**
+     * Gets outline opacity value.
+     * @public
+     * @returns {number}
+     */
+    public getOutlineOpacity(): number;
+    /**
+     * Updates label parameters.
+     * @public
+     */
+    public update(): Promise<void>;
+    _applyFontIndex(fontIndex: any): void;
+    /**
+     * Assigns font atlas and update.
+     * @public
+     * @param {utils.FontAtlas} fontAtlas - Font atlas.
+     */
+    public assignFontAtlas(fontAtlas: utils.FontAtlas): void;
+}
+export namespace ALIGN {
+    const RIGHT: number;
+    const LEFT: number;
+    const CENTER: number;
+}
+import { BaseBillboard } from "./BaseBillboard.js";
+import { Vec4 } from "../math/Vec4.js";

package/types/entity/LabelHandler.d.ts

@@ -0,0 +1,31 @@
+export class LabelHandler extends BillboardHandler {
+    /**
+     *
+     * @param {*} entityCollection
+     * @param {*} maxLetters
+     */
+    constructor(entityCollection: any, maxLetters?: any);
+    _gliphParamBuffer: any;
+    _fontIndexBuffer: any;
+    _noOutlineBuffer: any;
+    _outlineBuffer: any;
+    _outlineColorBuffer: any;
+    _gliphParamArr: Float32Array;
+    _fontIndexArr: Float32Array;
+    _noOutlineArr: Float32Array;
+    _outlineArr: Float32Array;
+    _outlineColorArr: Float32Array;
+    _maxLetters: any;
+    _addLabelToArrays(label: any): void;
+    assignFontAtlas(label: any): void;
+    workerCallback(data: any, label: any): void;
+    setText(index: any, text: any, fontIndex: any, align: any): void;
+    setOutlineColorArr(index: any, rgba: any): void;
+    setOutlineArr(index: any, outline: any): void;
+    setFontIndexArr(index: any, fontIndex: any): void;
+    createFontIndexBuffer(): void;
+    createOutlineBuffer(): void;
+    createOutlineColorBuffer(): void;
+    setMaxLetters(c: any): void;
+}
+import { BillboardHandler } from "./BillboardHandler.js";

package/types/entity/LabelWorker.d.ts

@@ -0,0 +1,11 @@
+export const LOCK_UPDATE: -2;
+export const LOCK_FREE: -1;
+export class LabelWorker {
+    constructor(numWorkers?: number);
+    _id: number;
+    _source: {};
+    _freeWorkerQueue: Worker[];
+    _pendingQueue: any[];
+    check(): void;
+    make(handler: any, label: any): void;
+}

package/types/entity/PointCloud.d.ts

@@ -0,0 +1,174 @@
+/**
+ * PointCloud object.
+ * @class
+ * @param {*} [options] - Point cloud options:
+ * @param {Array.<Array.<number>>} [options.points] - Points cartesian coordinates array,
+ * where first three is cartesian coordinates, next fourth is a RGBA color, and last is an point properties.
+ * @param {number} [options.pointSize] - Point screen size in pixels.
+ * @param {number} [options.pickingDistance] - Point border picking size in screen pixels.
+ * @param {boolean} [options.visibility] - Point cloud visibility.
+ * @example <caption>Creates point cloud with two ten pixel size points</caption>
+ * new og.Entity({
+ *     pointCloud: {
+ *         pointSize: 10,
+ *         points: [
+ *             [0, 0, 0, 255, 255, 255, 255, { 'name': 'White point' }],
+ *             [100, 100, 0, 255, 0, 0, 255, { 'name': 'Red point' }]
+ *         ]
+ *     }
+ * });
+ */
+export class PointCloud {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(options: any);
+    /**
+     * Object unic identifier.
+     * @public
+     * @readonly
+     * @type {number}
+     */
+    public readonly id: number;
+    /**
+     * Cloud visibility.
+     * @public
+     * @type {boolean}
+     */
+    public visibility: boolean;
+    /**
+     * Point screen size in pixels.
+     * @public
+     * @type {number}
+     */
+    public pointSize: number;
+    /**
+     * Point picking border size in pixels.
+     * @public
+     * @type {number}
+     */
+    public pickingDistance: number;
+    /**
+     * Parent collection render node.
+     * @private
+     * @type {RenderNode}
+     */
+    private _renderNode;
+    /**
+     * Entity instance that holds this point cloud.
+     * @private
+     * @type {Entity}
+     */
+    private _entity;
+    /**
+     * Points properties.
+     * @private
+     * @type {Array.<*>}
+     */
+    private _points;
+    /**
+     * Coordinates array.
+     * @private
+     * @type {Array.<number>}
+     */
+    private _coordinatesData;
+    /**
+     * Color array.
+     * @private
+     * @type {Array.<number>}
+     */
+    private _colorData;
+    /**
+     * Picking color array.
+     * @private
+     * @type {Array.<number>}
+     */
+    private _pickingColorData;
+    _coordinatesBuffer: any;
+    _colorBuffer: any;
+    _pickingColorBuffer: any;
+    /**
+     * Handler that stores and renders this object.
+     * @private
+     * @type {PointCloudHandler}
+     */
+    private _handler;
+    _handlerIndex: number;
+    _buffersUpdateCallbacks: (() => void)[];
+    _changedBuffers: any[];
+    /**
+     * Clears point cloud data
+     * @public
+     */
+    public clear(): void;
+    /**
+     * Set point cloud opacity.
+     * @public
+     * @param {number} opacity - Cloud opacity.
+     */
+    public setOpacity(opacity: number): void;
+    opacity: number;
+    /**
+     * Sets cloud visibility.
+     * @public
+     * @param {number} visibility - Visibility flag.
+     */
+    public setVisibility(visibility: number): void;
+    /**
+     * @return {boolean} Point cloud visibily.
+     */
+    getVisibility(): boolean;
+    /**
+     * Assign rendering scene node.
+     * @public
+     * @param {RenderNode}  renderNode - Assigned render node.
+     */
+    public setRenderNode(renderNode: RenderNode): void;
+    /**
+     * Removes from entity.
+     * @public
+     */
+    public remove(): void;
+    /**
+     * Adds points to render.
+     * @public
+     * @param {Array.<Array<number>>} points - Point cloud array.
+     * @example
+     * var points = [[0, 0, 0, 255, 255, 255, 255, { 'name': 'White point' }], [100, 100, 0, 255, 0, 0, 255, { 'name': 'Red point' }]];
+     */
+    public setPoints(points: Array<Array<number>>): void;
+    setPointPosition(index: any, x: any, y: any, z: any): void;
+    setPointColor(index: any, r: any, g: any, b: any, a: any): void;
+    addPoints(points: any): void;
+    addPoint(index: any, point: any): void;
+    /**
+     * Returns specific point by index.
+     * @public
+     * @param {number} index - Point index.
+     * @return {*} Specific point
+     */
+    public getPoint(index: number): any;
+    removePoint(index: any): void;
+    insertPoint(index: any, point: any): void;
+    /**
+     * Each point iterator.
+     * @public
+     * @param {callback} callback -
+     */
+    public each(callback: any): void;
+    draw(): void;
+    drawPicking(): void;
+    /**
+     * Update gl buffers.
+     * @private
+     */
+    private _update;
+    /**
+     * Delete buffers
+     * @private
+     */
+    private _deleteBuffers;
+    _createCoordinatesBuffer(): void;
+    _createColorBuffer(): void;
+    _createPickingColorBuffer(): void;
+    _setPickingColors(): void;
+}

package/types/entity/PointCloudHandler.d.ts

@@ -0,0 +1,38 @@
+export class PointCloudHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(entityCollection: any);
+    /**
+     * Picking rendering option.
+     * @public
+     * @type {boolean}
+     */
+    public pickingEnabled: boolean;
+    /**
+     * Parent collection
+     * @private
+     * @type {EntityCollection}
+     */
+    private _entityCollection;
+    /**
+     * Renderer
+     * @private
+     * @type {Renderer}
+     */
+    private _renderer;
+    /**
+     * Point cloud array
+     * @private
+     * @type {Array.<PointCloud>}
+     */
+    private _pointClouds;
+    __staticId: number;
+    _initProgram(): void;
+    setRenderNode(renderNode: any): void;
+    add(pointCloud: any): void;
+    remove(pointCloud: any): void;
+    reindexPointCloudArray(startIndex: any): void;
+    draw(): void;
+    drawPicking(): void;
+    clear(): void;
+}