@openglobus/og 0.12.1 → 0.12.3

package/types/renderer/Renderer.d.ts

@@ -0,0 +1,290 @@
+/**
+ * Represents high level WebGL context interface that starts WebGL handler working in real time.
+ * @class
+ * @param {Handler} handler - WebGL handler context.
+ * @param {Object} [params] - Renderer parameters:
+ * @fires og.RendererEvents#draw
+ * @fires og.RendererEvents#resize
+ * @fires og.RendererEvents#mousemove
+ * @fires og.RendererEvents#mousestop
+ * @fires og.RendererEvents#lclick
+ * @fires og.RendererEvents#rclick
+ * @fires og.RendererEvents#mclick
+ * @fires og.RendererEvents#ldblclick
+ * @fires og.RendererEvents#rdblclick
+ * @fires og.RendererEvents#mdblclick
+ * @fires og.RendererEvents#lup
+ * @fires og.RendererEvents#rup
+ * @fires og.RendererEvents#mup
+ * @fires og.RendererEvents#ldown
+ * @fires og.RendererEvents#rdown
+ * @fires og.RendererEvents#mdown
+ * @fires og.RendererEvents#lhold
+ * @fires og.RendererEvents#rhold
+ * @fires og.RendererEvents#mhold
+ * @fires og.RendererEvents#mousewheel
+ * @fires og.RendererEvents#touchstart
+ * @fires og.RendererEvents#touchend
+ * @fires og.RendererEvents#touchcancel
+ * @fires og.RendererEvents#touchmove
+ * @fires og.RendererEvents#doubletouch
+ * @fires og.RendererEvents#touchleave
+ * @fires og.RendererEvents#touchenter
+ */
+export class Renderer {
+    constructor(handler: any, params: any);
+    /**
+     * Div element with WebGL canvas.
+     * @public
+     * @type {object}
+     */
+    public div: object;
+    /**
+     * WebGL handler context.
+     * @public
+     * @type {Handler}
+     */
+    public handler: Handler;
+    exposure: number;
+    gamma: number;
+    whitepoint: number;
+    brightThreshold: number;
+    backgroundColor: any;
+    /**
+     * Render nodes drawing queue.
+     * @private
+     * @type {Array.<scene.RenderNode>}
+     */
+    private _renderNodesArr;
+    /**
+     * Render nodes store for the comfortable access by the node name.
+     * @public
+     * @type {Object.<og.scene.RenderNode>}
+     */
+    public renderNodes: any;
+    /**
+     * Current active camera.
+     * @public
+     * @type {Camera}
+     */
+    public activeCamera: Camera;
+    /**
+     * Renderer events. Represents interface for setting events like mousemove, draw, keypress etc.
+     * @public
+     * @type {RendererEvents}
+     */
+    public events: RendererEvents;
+    /**
+     * OpenGlobus controls array.
+     * @public
+     * @type {Object}
+     */
+    public controls: any;
+    /**
+     * Provides exchange between controls.
+     * @public
+     * @type {Object}
+     */
+    public controlsBag: any;
+    /**
+     * Hash table for drawing objects.
+     * @public
+     * @type {Object}
+     */
+    public colorObjects: any;
+    /**
+     * Color picking objects rendering queue.
+     * @type {Array.<Renderer~pickingCallback>}
+     */
+    _pickingCallbacks: Array<Renderer>;
+    /**
+     * Picking objects(labels and billboards) framebuffer.
+     * @public
+     * @type {Framebuffer}
+     */
+    public pickingFramebuffer: Framebuffer;
+    /**
+     * Depth objects rendering queue.
+     * @type {Array.<Renderer~depthCallback>}
+     */
+    _depthCallbacks: Array<Renderer>;
+    depthFramebuffer: Framebuffer;
+    _msaa: any;
+    _internalFormat: string;
+    _format: string;
+    _type: string;
+    sceneFramebuffer: Framebuffer | Multisample;
+    blitFramebuffer: Framebuffer;
+    toneMappingFramebuffer: Framebuffer;
+    /**
+     * Stores current picking rgb color.
+     * @private
+     * @type {Array.<number>} - (exactly 3 entries)
+     */
+    private _currPickingColor;
+    /**
+     * Stores previous picked rgb color.
+     * @private
+     * @type {Array.<number>} - (exactly 3 entries)
+     */
+    private _prevPickingColor;
+    _tempPickingColor_: Uint8Array;
+    _initialized: boolean;
+    /**
+     * Texture atlas for the billboards images. One atlas per node.
+     * @protected
+     * @type {utils.TextureAtlas}
+     */
+    protected billboardsTextureAtlas: utils.TextureAtlas;
+    /**
+     * Texture font atlas for the font families and styles. One atlas per node.
+     * @public
+     * @type {utils.FontAtlas}
+     */
+    public fontAtlas: utils.FontAtlas;
+    _entityCollections: any[];
+    _currentOutput: string;
+    labelWorker: LabelWorker;
+    /**
+     * Sets renderer events activity.
+     * @param {Boolean} activity - Events activity.
+     */
+    setEventsActivity(activity: boolean): void;
+    addDepthCallback(sender: any, callback: any): number;
+    removeDepthCallback(id: any): void;
+    /**
+     * Adds picking rendering callback function.
+     * @param {object} sender - Callback context.
+     * @param {Renderer~pickingCallback} callback - Rendering callback.
+     * @returns {Number} Handler id
+     */
+    addPickingCallback(sender: object, callback: any): number;
+    /**
+     * Removes picking rendering callback function.
+     * @param {Number} id - Handler id to remove.
+     */
+    removePickingCallback(id: number): void;
+    getPickingObjectByColor(r: any, g: any, b: any): any;
+    /**
+     * Assign picking color to the object.
+     * @public
+     * @param {Object} obj - Object that pressume to be picked.
+     */
+    public assignPickingColor(obj: any): void;
+    /**
+     * Removes picking color from object.
+     * @public
+     * @param {Object} obj - Object to remove picking color.
+     */
+    public clearPickingColor(obj: any): void;
+    /**
+     * Get the client width.
+     * @public
+     * @returns {number} -
+     */
+    public getWidth(): number;
+    /**
+     * Get the client height.
+     * @public
+     * @returns {number} -
+     */
+    public getHeight(): number;
+    /**
+     * Get center of the screen
+     * @public
+     * @returns {math.Vec2} -
+     */
+    public getCenter(): math.Vec2;
+    /**
+     * Add the given control to the renderer.
+     * @param {control.Control} control - Control.
+     */
+    addControl(control: control.Control): void;
+    /**
+     * Add the given controls array to the planet node.
+     * @param {Array.<control.Control>} cArr - Control array.
+     */
+    addControls(cArr: Array<control.Control>): void;
+    /**
+     * Remove control from the renderer.
+     * @param {control.Control} control  - Control.
+     */
+    removeControl(control: control.Control): void;
+    /**
+     * Renderer initialization.
+     * @public
+     */
+    public initialize(): void;
+    screenDepthFramebuffer: Framebuffer;
+    _fnScreenFrame: () => void;
+    screenTexture: {
+        screen: any;
+        picking: any;
+        depth: any;
+        frustum?: undefined;
+    } | {
+        screen: any;
+        picking: any;
+        depth: any;
+        frustum: any;
+    };
+    _screenFrameCornersBuffer: any;
+    outputTexture: any;
+    setCurrentScreen(screenName: any): void;
+    resize(): void;
+    removeNode(renderNode: any): void;
+    /**
+     * Adds render node to the renderer.
+     * @public
+     * @param {RenderNode} renderNode - Render node.
+     */
+    public addNode(renderNode: RenderNode): void;
+    /**
+     * Adds render node to the renderer before specific node.
+     * @public
+     * @param {RenderNode} renderNode - Render node.
+     */
+    public addNodeBefore(renderNode: RenderNode, renderNodeBefore: any): void;
+    /**
+     * Adds render nodes array to the renderer.
+     * @public
+     * @param {Array.<scene.RenderNode>} nodesArr - Render nodes array.
+     */
+    public addNodes(nodesArr: Array<scene.RenderNode>): void;
+    getMaxMSAA(internalFormat: any): any;
+    getMSAA(): any;
+    /**
+     * TODO: replace with cahce frendly linked list by bilboardHandler, label handler etc.
+     */
+    enqueueEntityCollectionsToDraw(ecArr: any): void;
+    /**
+     * Draws entity collections.
+     * @public
+     * @param {Array<og.EntityCollection>} ec - Entity collection array.
+     */
+    public _drawEntityCollections(): void;
+    /**
+     * Draw nodes.
+     * @public
+     */
+    public draw(): void;
+    _screenFrameMSAA(): void;
+    _screenFrameNoMSAA(): void;
+    /**
+     * Draw picking objects framebuffer.
+     * @private
+     */
+    private _drawPickingBuffer;
+    _drawDepthBuffer(): void;
+    _readPickingColor(): void;
+    /**
+     * Function starts rendering.
+     * @public
+     */
+    public start(): void;
+}
+import { Camera } from "../camera/Camera.js";
+import { RendererEvents } from "./RendererEvents.js";
+import { Framebuffer } from "../webgl/index.js";
+import { Multisample } from "../webgl/index.js";
+import { LabelWorker } from "../entity/LabelWorker.js";

package/types/renderer/RendererEvents.d.ts

@@ -0,0 +1,237 @@
+/**
+ * Renderer events handler.
+ * @class
+ * @param {Renderer} renderer - Renderer object, events that works for.
+ */
+export class RendererEvents extends Events {
+    constructor(renderer: any);
+    /**
+     * Assigned renderer.
+     * @public
+     * @type {Renderer}
+     */
+    public renderer: Renderer;
+    /**
+     * Low level touch events handler.
+     * @private
+     * @type {input.TouchHandler}
+     */
+    private _touchHandler;
+    /**
+     * Low level mouse events handler.
+     * @private
+     * @type {input.MouseHandler}
+     */
+    private _mouseHandler;
+    /**
+     * Low level keyboard events handler.
+     * @private
+     * @type {input.KeyboardHandler}
+     */
+    private _keyboardHandler;
+    _active: boolean;
+    clickRadius: number;
+    /**
+     * Current mouse state.
+     * @public
+     * @enum {Object}
+     */
+    public mouseState: {
+        anyEvent: () => boolean;
+        /** Current screen mouse X position. */
+        clientX: number;
+        /** Current screen mouse Y position. */
+        clientY: number;
+        /** Current viewport mouse X position. */
+        x: number;
+        /** Current viewport mouse Y position. */
+        y: number;
+        /** Current mouse X position from 0 to 1 */
+        nx: number;
+        /** Current mouse Y position from 0 to 1 */
+        ny: number;
+        /** Previous mouse X position. */
+        prev_x: number;
+        /** Previous mouse Y position. */
+        prev_y: number;
+        /** Screen mouse position world direction. */
+        direction: Vec3;
+        /** Left mouse button has stopped pushing down right now.*/
+        leftButtonUp: boolean;
+        /** Right mouse button has stopped pushing down right now.*/
+        rightButtonUp: boolean;
+        /** Middle mouse button has stopped pushing down right now.*/
+        middleButtonUp: boolean;
+        /** Left mouse button has pushed now.*/
+        leftButtonDown: boolean;
+        /** Right mouse button has pushed now.*/
+        rightButtonDown: boolean;
+        /** Middle mouse button has pushed now.*/
+        middleButtonDown: boolean;
+        /** Left mouse button is pushing.*/
+        leftButtonHold: boolean;
+        /** Right mouse button is pushing.*/
+        rightButtonHold: boolean;
+        /** Middle mouse button is pushing.*/
+        middleButtonHold: boolean;
+        /** Left mouse button has clicked twice now.*/
+        leftButtonDoubleClick: boolean;
+        /** Right mouse button has clicked twice now.*/
+        rightButtonDoubleClick: boolean;
+        /** Middle mouse button has clicked twice now.*/
+        middleButtonDoubleClick: boolean;
+        /** Left mouse button has clicked now. */
+        leftButtonClick: boolean;
+        /** Right mouse button has clicked now. */
+        rightButtonClick: boolean;
+        /** Middle mouse button has clicked now. */
+        middleButtonClick: boolean;
+        /** Mouse is moving now. */
+        moving: boolean;
+        /** Mouse has just stopped now. */
+        justStopped: boolean;
+        /** Mose double click delay response time.*/
+        doubleClickDelay: number;
+        /** Mose click delay response time.*/
+        clickDelay: number;
+        /** Mouse wheel. */
+        wheelDelta: number;
+        /** JavaScript mouse system event message. */
+        sys: any;
+        /** Current picking object. */
+        pickingObject: any;
+        /** Renderer instanve. */
+        renderer: any;
+    };
+    /**
+     * Current touch state.
+     * @public
+     * @enum {Object}
+     */
+    public touchState: {
+        /** Touching is moving now. */
+        moving: boolean;
+        /** Touch has ended right now.*/
+        touchEnd: boolean;
+        /** Touch has started right now.*/
+        touchStart: boolean;
+        /** Touch canceled.*/
+        touchCancel: boolean;
+        /** Touched twice.*/
+        doubleTouch: boolean;
+        /** Double touching responce delay.*/
+        doubleTouchDelay: number;
+        /** Double touching responce radius in screen pixels.*/
+        doubleTouchRadius: number;
+        /** Current touch X - coordinate. */
+        x: number;
+        /** Current touch Y - coordinate. */
+        y: number;
+        /** Current touch X - coordinate from 0 to 1 */
+        nx: number;
+        /** Current touch Y - coordinate from 0 to 1 */
+        ny: number;
+        /** Previous touch X coordinate. */
+        prev_x: number;
+        /** Previous touch Y coordinate. */
+        prev_y: number;
+        /** JavaScript touching system event message. */
+        sys: any;
+        /** Current touched(picking) object. */
+        pickingObject: any;
+        /** Renderer instanve. */
+        renderer: any;
+    };
+    _dblTchCoords: Vec2;
+    _oneTouchStart: boolean;
+    _dblTchBegins: number;
+    /**
+     * @type {number}
+     */
+    _mousestopThread: number;
+    _ldblClkBegins: number;
+    _rdblClkBegins: number;
+    _mdblClkBegins: number;
+    _lClkBegins: number;
+    _rClkBegins: number;
+    _mClkBegins: number;
+    _lclickX: number;
+    _lclickY: number;
+    _rclickX: number;
+    _rclickY: number;
+    _mclickX: number;
+    _mclickY: number;
+    set active(arg: boolean);
+    get active(): boolean;
+    /**
+     * Used in render node frame.
+     * @public
+     */
+    public handleEvents(): void;
+    /**
+     * Check key is pressed.
+     * @public
+     * @param {number} keyCode - Key code
+     * @return {boolean}
+     */
+    public isKeyPressed(keyCode: number): boolean;
+    releaseKeys(): void;
+    /**
+     * Renderer events initialization.
+     * @public
+     */
+    public initialize(): void;
+    /**
+     * @private
+     */
+    private onMouseWheel;
+    /**
+     * @protected
+     */
+    protected updateButtonsStates(buttons: any): void;
+    /**
+     * @private
+     */
+    private onMouseMove;
+    onMouseLeave(event: any): void;
+    onMouseEnter(event: any): void;
+    /**
+     * @private
+     */
+    private onMouseDown;
+    /**
+     * @private
+     */
+    private onMouseUp;
+    /**
+     * @private
+     */
+    private onTouchStart;
+    /**
+     * @private
+     */
+    private onTouchEnd;
+    /**
+     * @private
+     */
+    private onTouchCancel;
+    /**
+     * @private
+     */
+    private onTouchMove;
+    /**
+     * @private
+     */
+    private entityPickingEvents;
+    /**
+     * @private
+     */
+    private handleMouseEvents;
+    /**
+     * @private
+     */
+    private handleTouchEvents;
+}
+import { Events } from "../Events.js";
+import { Vec3 } from "../math/Vec3.js";
+import { Vec2 } from "../math/Vec2.js";