@openglobus/og 0.22.1 → 0.23.0

package/lib/js/renderer/Renderer.d.ts

@@ -1,6 +1,6 @@
 import { Camera } from "../camera/Camera";
 import { Control } from "../control/Control";
-import { RendererEventsHandler } from "./RendererEvents";
+import { IBaseInputState, RendererEventsHandler } from "./RendererEvents";
 import { EntityCollection } from "../entity/EntityCollection";
 import { Framebuffer, Multisample } from "../webgl/index";
 import { FontAtlas } from "../utils/FontAtlas";
@@ -18,6 +18,7 @@ interface IRendererParams {
     fontsSrc?: string;
     gamma?: number;
     exposure?: number;
+    dpi?: number;
 }
 interface IPickingObject {
     _pickingColor?: Vec3;
@@ -28,6 +29,39 @@ interface IFrameCallbackHandler {
     callback: Function;
     sender: any;
 }
+/**
+ * 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 EventsHandler<RendererEventsType>#draw
+ * @fires EventsHandler<RendererEventsType>#resize
+ * @fires EventsHandler<RendererEventsType>#mousemove
+ * @fires EventsHandler<RendererEventsType>#mousestop
+ * @fires EventsHandler<RendererEventsType>#lclick
+ * @fires EventsHandler<RendererEventsType>#rclick
+ * @fires EventsHandler<RendererEventsType>#mclick
+ * @fires EventsHandler<RendererEventsType>#ldblclick
+ * @fires EventsHandler<RendererEventsType>#rdblclick
+ * @fires EventsHandler<RendererEventsType>#mdblclick
+ * @fires EventsHandler<RendererEventsType>#lup
+ * @fires EventsHandler<RendererEventsType>#rup
+ * @fires EventsHandler<RendererEventsType>#mup
+ * @fires EventsHandler<RendererEventsType>#ldown
+ * @fires EventsHandler<RendererEventsType>#rdown
+ * @fires EventsHandler<RendererEventsType>#mdown
+ * @fires EventsHandler<RendererEventsType>#lhold
+ * @fires EventsHandler<RendererEventsType>#rhold
+ * @fires EventsHandler<RendererEventsType>#mhold
+ * @fires EventsHandler<RendererEventsType>#mousewheel
+ * @fires EventsHandler<RendererEventsType>#touchstart
+ * @fires EventsHandler<RendererEventsType>#touchend
+ * @fires EventsHandler<RendererEventsType>#touchcancel
+ * @fires EventsHandler<RendererEventsType>#touchmove
+ * @fires EventsHandler<RendererEventsType>#doubletouch
+ * @fires EventsHandler<RendererEventsType>#touchleave
+ * @fires EventsHandler<RendererEventsType>#touchenter
+ */
 export interface HTMLDivElementExt extends HTMLDivElement {
     attributions?: HTMLElement;
 }
@@ -65,7 +99,7 @@ declare class Renderer {
      * @public
      * @type {Camera}
      */
-    activeCamera: Camera | null;
+    activeCamera: Camera;
     /**
      * Renderer events. Represents interface for setting events like mousemove, draw, keypress etc.
      * @public
@@ -101,17 +135,6 @@ declare class Renderer {
      * @type {Framebuffer}
      */
     pickingFramebuffer: Framebuffer | null;
-    protected _tempPickingPix_: Uint8Array;
-    /**
-     * @public
-     * @type {Framebuffer}
-     */
-    distanceFramebuffer: Framebuffer | null;
-    /**
-     * @type {Function[]}
-     */
-    protected _distanceCallbacks: IFrameCallbackHandler[];
-    protected _tempDistancePix_: Uint8Array;
     /**
      * Depth objects rendering queue.
      * @type {Function[]}
@@ -144,24 +167,19 @@ declare class Renderer {
      * @type {FontAtlas}
      */
     fontAtlas: FontAtlas;
-    protected _entityCollections: EntityCollection[];
+    protected _entityCollections: EntityCollection[][];
     protected _currentOutput: string;
     protected _fnScreenFrame: Function | null;
     labelWorker: LabelWorker;
-    __useDistanceFramebuffer__: boolean;
     screenDepthFramebuffer: Framebuffer | null;
     screenFramePositionBuffer: WebGLBufferExt | null;
     screenTexture: Record<string, WebGLTexture>;
     outputTexture: WebGLTexture | null;
-    protected _skipDistanceFrame: boolean;
-    protected _distancePixelBuffer: WebGLBuffer | null;
-    protected _skipPickingFrame: boolean;
-    protected _pickingPixelBuffer: WebGLBuffer | null;
-    protected _readDistanceBuffer: () => void;
     protected _readPickingBuffer: () => void;
-    constructor(handler: Handler, params?: IRendererParams);
+    constructor(handler: Handler | string | HTMLCanvasElement, params?: IRendererParams);
     enableBlendOneSrcAlpha(): void;
     enableBlendDefault(): void;
+    setRelativeCenter(c?: Vec3): void;
     /**
      * Sets renderer events activity.
      * @param {Boolean} activity - Events activity.
@@ -169,8 +187,6 @@ declare class Renderer {
     setEventsActivity(activity: boolean): void;
     addDepthCallback(sender: any, callback: Function): number;
     removeDepthCallback(id: number): void;
-    addDistanceCallback(sender: any, callback: Function): number;
-    removeDistanceCallback(id: number): void;
     /**
      * Adds picking rendering callback function.
      * @param {object} sender - Callback context.
@@ -243,7 +259,6 @@ declare class Renderer {
      * @public
      */
     initialize(): void;
-    _initReadPixelsBuffers(): void;
     _initializeControls(): void;
     resize(): void;
     setCurrentScreen(screenName: string): void;
@@ -275,42 +290,47 @@ declare class Renderer {
     /**
      * TODO: replace with cache friendly linked list by BillboardHandler, LabelHandler etc.
      */
-    enqueueEntityCollectionsToDraw(ecArr: EntityCollection[]): void;
-    /**
-     * Draws opaque items entity collections.
-     * @protected
-     */
-    protected _drawOpaqueEntityCollections(): void;
+    enqueueEntityCollectionsToDraw(ecArr: EntityCollection[], depthOrder?: number): void;
     /**
-     * Draws transparent items entity collections.
      * @protected
      */
-    protected _drawTransparentEntityCollections(): void;
-    protected _clearEntityCollectionQueue(): void;
+    protected _drawEntityCollections(depthOrder: number): void;
+    protected _drawPickingEntityCollections(depthOrder: number): void;
+    protected _drawDepthEntityCollections(depthOrder: number): void;
+    protected _clearEntityCollectionQueue(depthOrder: number): void;
     /**
      * Draw nodes.
      * @public
      */
     draw(): void;
+    getImageDataURL(type?: string, quality?: number): string;
     protected _screenFrameMSAA(): void;
     protected _screenFrameNoMSAA(): void;
     /**
      * Draw picking objects framebuffer.
      * @private
      */
-    protected _drawPickingBuffer(): void;
+    protected _drawPickingBuffer(depthOrder: number): void;
+    protected _drawDepthBuffer(depthOrder: number): void;
+    protected _readDepthBuffer(): void;
+    protected _readPickingBuffer_webgl1(): void;
+    protected _readPickingBuffer_webgl2(): void;
+    readPickingColor(x: number, y: number, outColor: NumberArray3 | Uint8Array): void;
+    readDepth(x: number, y: number, outDepth: NumberArray3 | Float32Array): void;
     /**
-     * Draw picking objects framebuffer.
-     * @protected
+     * Returns the distance from the active (screen) camera to the 3d-surface using the defined screen coordinates
+     * @public
+     * @param {Vec2 | IBaseInputState} px - Screen coordinates.
+     * @returns {number | undefined} -
      */
-    protected _drawDistanceBuffer(): void;
-    protected _drawDepthBuffer(): void;
-    protected _readPickingBuffer_webgl1: () => void;
-    protected _readPickingBuffer_webgl2: () => void;
-    protected _readDistanceBuffer_webgl1: () => void;
-    protected _readDistanceBuffer_webgl2: () => void;
-    readPickingColor(x: number, y: number, outColor: NumberArray3 | Uint8Array): void;
-    readDistanceColor(x: number, y: number, outColor: NumberArray3 | Uint8Array): void;
+    getDistanceFromPixel(px: Vec2 | IBaseInputState, camera?: Camera | null): number | undefined;
+    /**
+     * Returns 3d coordinates from screen coordinates
+     * @public
+     * @param {Vec2 | IBaseInputState} px - Screen coordinates.
+     * @returns {Vec3 | undefined} -
+     */
+    getCartesianFromPixel(px: Vec2 | IBaseInputState): Vec3 | undefined;
     /**
      * Function starts renderer
      * @public