@openglobus/og 0.22.2 → 0.23.0

package/lib/@openglobus/js/light/LightSource.d.ts

@@ -2,173 +2,35 @@ import { Vec3 } from "../math/Vec3";
 import { RenderNode } from "../scene/RenderNode";
 export interface ILightSourceParams {
     position?: Vec3;
-    directional?: boolean;
     ambient?: Vec3;
     diffuse?: Vec3;
     specular?: Vec3;
     shininess?: number;
 }
-/**
- * Represents basic light source.
- * @class
- * @param {string} [name] - Light source name.
- * @param {ILightSourceParams} [params] - Light parameters:
- * @param {Vec3} [params.position] - Light source position if it is a point light, otherwise it is a light direction vector.
- * @param {Vec3} [params.ambient]  - Ambient RGB color.
- * @param {Vec3} [params.diffuse]  - Diffuse RGB color.
- * @param {Vec3} [params.specular]  - Specular RGB color.
- * @param {number} [params.shininess]  - Specular shininess.
- */
 declare class LightSource {
-    static __counter__: number;
-    /**
-     * Light name.
-     * @protected
-     * @type {string}
-     */
-    protected _name: string;
-    /**
-     * Render node where light is shines.
-     * @protected
-     * @type {RenderNode}
-     */
     protected _renderNode: RenderNode | null;
-    /**
-     * Light position.
-     * @public
-     * @type {Vec3}
-     */
     _position: Vec3;
-    /**
-     * True if the light is directional.
-     * @public
-     * @type {boolean}
-     */
-    directional: boolean;
-    /**
-     * Ambient color.
-     * @protected
-     * @type {Vec3}
-     */
     protected _ambient: Vec3;
-    /**
-     * Diffuse color.
-     * @protected
-     * @type {Vec3}
-     */
     protected _diffuse: Vec3;
-    /**
-     * Specular color.
-     * @protected
-     * @type {Vec3}
-     */
     protected _specular: Vec3;
-    /**
-     * Shininess.
-     * @protected
-     * @type {number}
-     */
     protected _shininess: number;
-    /**
-     * Light activity.
-     * @protected
-     * @type {boolean}
-     */
     protected _active: boolean;
     protected _tempAmbient: Vec3;
     protected _tempDiffuse: Vec3;
     protected _tempSpecular: Vec3;
     protected _tempShininess: number;
-    constructor(name: string, params: ILightSourceParams);
-    /**
-     * Creates clone of the current light object.
-     * @todo: TODO
-     * @public
-     * @returns {LightSource}
-     */
-    clone(): void;
-    /**
-     * Set light activity. If activity is false the light doesn't shine.
-     * @public
-     * @param {boolean} active - Light activity.
-     */
-    setActive(active: boolean): void;
-    /**
-     * Gets light activity.
-     * @public
-     * @returns {boolean}
-     */
+    constructor(params: ILightSourceParams);
     isActive(): boolean;
-    /**
-     * Set light source position, or if it is a directional type sets light direction vector.
-     * @public
-     * @param {Vec3} position - Light position or direction vector.
-     */
     setPosition3v(position: Vec3): void;
-    /**
-     * Set light source position, or if it is a directional type sets light direction vector.
-     * @public
-     */
     setPosition(x: number, y: number, z: number): void;
-    /**
-     * Returns light source position, or if it is a directional type sets light direction vector.
-     * @public
-     * @returns {Vec3} - Light source position/direction.
-     */
     getPosition(): Vec3;
-    /**
-     * Set ambient color.
-     * @public
-     * @param {Vec3} rgb - Ambient color.
-     */
     setAmbient3v(rgb: Vec3): void;
-    /**
-     * Set diffuse color.
-     * @public
-     * @param {Vec3} rgb - Diffuse color.
-     */
     setDiffuse3v(rgb: Vec3): void;
-    /**
-     * Set specular color.
-     * @public
-     * @param {Vec3} rgb - Specular color.
-     */
     setSpecular3v(rgb: Vec3): void;
-    /**
-     * Set ambient color.
-     * @public
-     */
     setAmbient(r: number, g: number, b: number): void;
-    /**
-     * Set diffuse color.
-     * @public
-     */
     setDiffuse(r: number, g: number, b: number): void;
-    /**
-     * Set specular color.
-     * @public
-     */
     setSpecular(r: number, g: number, b: number): void;
-    /**
-     * Set material shininess.
-     * @public
-     */
     setShininess(shininess: number): void;
-    /**
-     * Sets light to black.
-     * @public
-     */
-    setBlack(): void;
-    /**
-     * Adds current light to the render node scene.
-     * @public
-     * @param {RenderNode} renderNode - Render node scene.
-     */
     addTo(renderNode: RenderNode): void;
-    /**
-     * Removes from render node scene.
-     * @public
-     */
-    remove(): void;
 }
 export { LightSource };

package/lib/@openglobus/js/math/Quat.d.ts

@@ -118,13 +118,18 @@ export declare class Quat {
      * @returns {Quat} -
      */
     static getRotationBetweenVectorsUp(source: Vec3, dest: Vec3, up: Vec3): Quat;
-    static setFromEulerAngles(pitch: number, yaw: number, roll: number): Quat;
     /**
      * Returns true if the components are zero.
      * @public
      * @returns {boolean} -
      */
     isZero(): boolean;
+    /**
+     * Returns true if a component is NaN.
+     * @public
+     * @returns {boolean} -
+     */
+    isNaN(): boolean;
     /**
      * Clear Quat. Sets zeroes.
      * @public
@@ -167,6 +172,13 @@ export declare class Quat {
      * @returns {Quat} -
      */
     add(q: Quat): Quat;
+    /**
+     * Computes the componentwise sum of two Quats.
+     * @public
+     * @param {Quat} q - Quat to add.
+     * @returns {Quat} -
+     */
+    addRes(q: Quat, res: Quat): Quat;
     /**
      * Computes the componentwise difference of two Quats.
      * @public
@@ -194,6 +206,15 @@ export declare class Quat {
      * @returns {Array.<number>} - (exactly 4 entries)
      */
     toVec(): [number, number, number, number];
+    get xyz(): Vec3;
+    /**
+     * Sets rotation with the given heading and up vectors.
+     * @static
+     * @param {Vec3} forward - Heading target coordinates.
+     * @param {Vec3} up - Up vector.
+     * @returns {Quat} -
+     */
+    setLookRotation(forward: Vec3, up: Vec3): Quat;
     /**
      * Sets current quaternion by spherical coordinates.
      * @public
@@ -203,20 +224,12 @@ export declare class Quat {
      * @returns {Quat} -
      */
     setFromSphericalCoords(lat: number, lon: number, angle: number): Quat;
-    /**
-     * Sets rotation with the given heading and up vectors.
-     * @static
-     * @param {Vec3} forward - Heading target coordinates.
-     * @param {Vec3} up - Up vector.
-     * @returns {Quat} -
-     */
-    setLookRotation(forward: Vec3, up: Vec3): Quat;
     /**
      * Gets spherical coordinates.
      * @public
      * @returns {Object} Returns object with latitude, longitude and alpha.
      */
-    toSphericalCoords(): any;
+    getSphericalCoords(): any;
     /**
      * Sets current Quat representing a rotation around an axis.
      * @public
@@ -228,9 +241,16 @@ export declare class Quat {
     /**
      * Returns axis and angle of the current Quat.
      * @public
-     * @returns {Object} -
+     * @returns { axis: Vec3, angle: number } -
      */
-    getAxisAngle(): any;
+    getAxisAngle(): {
+        axis: Vec3;
+        angle: number;
+    };
+    getPitch(): number;
+    getYaw(): number;
+    getRoll(): number;
+    setPitchYawRoll(pitchRad: number, yawRad: number, rollRad: number, frame?: Quat): Quat;
     /**
      * Sets current Quat by Euler's angles.
      * @public
@@ -274,6 +294,13 @@ export declare class Quat {
      * @returns {Vec3} -
      */
     mulVec3(v: Vec3): Vec3;
+    /**
+     * Returns quaternion and vector production.
+     * @public
+     * @param {Vec3} v - 3d Vector.
+     * @returns {Vec3} -
+     */
+    mulVec3Res(v: Vec3, res: Vec3): Vec3;
     /**
      * Computes the product of two Quats.
      * @public
@@ -281,6 +308,13 @@ export declare class Quat {
      * @returns {Quat} -
      */
     mul(q: Quat): Quat;
+    /**
+     * Computes the product of two Quats.
+     * @public
+     * @param {Quat} q - Quat to multiply.
+     * @returns {Quat} -
+     */
+    mulRes(q: Quat, res: Quat): Quat;
     /**
      * Computes the product of two Quats.
      * @public
@@ -340,27 +374,6 @@ export declare class Quat {
      * @returns {Quat} -
      */
     slerp(b: Quat, t: number): Quat;
-    /**
-     * Returns a roll angle in radians.
-     * @public
-     * @param {Boolean} [reprojectAxis] -
-     * @returns {Number} -
-     */
-    getRoll(reprojectAxis?: boolean): number;
-    /**
-     * Returns a pitch angle in radians.
-     * @public
-     * @param {Boolean} [reprojectAxis] -
-     * @returns {number} -
-     */
-    getPitch(reprojectAxis?: boolean): number;
-    /**
-     * Returns a yaw angle in radians.
-     * @public
-     * @param {Boolean} [reprojectAxis] -
-     * @returns {number} -
-     */
-    getYaw(reprojectAxis?: boolean): number;
 }
 /**
  * Creates Quat instance.

package/lib/@openglobus/js/math/Ray.d.ts

@@ -1,6 +1,7 @@
 import { Box } from "../bv/Box";
 import { Sphere } from "../bv/Sphere";
 import { Vec3 } from "./Vec3";
+import { Plane } from "./Plane";
 /**
  * Represents a ray that extends infinitely from the provided origin in the provided direction.
  * @class
@@ -38,10 +39,9 @@ export declare class Ray {
      */
     set(origin: Vec3, direction: Vec3): Ray;
     /**
-     * Computes the point along the ray on the distance.
-     * @public
-     * @param {number} distance - Point distance.
-     * @returns {Vec3}
+     * Get a point on the ray at a given distance `t`.
+     * @param {number} distance - Distance from the origin along the ray.
+     * @returns {Vec3} The point at distance `t`.
      */
     getPoint(distance: number): Vec3;
     /**
@@ -73,4 +73,10 @@ export declare class Ray {
      */
     hitSphere(sphere: Sphere): Vec3 | null;
     hitBox(box: Box): void;
+    /**
+     * Finds the intersection of the ray with a plane.
+     * @param {Plane} plane - The plane to intersect with.
+     * @returns {Vec3 | null} The intersection point or null if no intersection.
+     */
+    hitPlane2(plane: Plane, res: Vec3): number;
 }

package/lib/@openglobus/js/math/Vec3.d.ts

@@ -241,6 +241,13 @@ export declare class Vec3 {
      * @returns {Vec3} Returns a sum vector.
      */
     add(p: Vec3): Vec3;
+    /**
+     * Gets two vectors summarization.
+     * @public
+     * @param {Vec3} p - Vector to add.
+     * @returns {Vec3} Returns a sum vector.
+     */
+    addRes(p: Vec3, res: Vec3): Vec3;
     /**
      * Subtract vector from the current.
      * @public
@@ -283,6 +290,13 @@ export declare class Vec3 {
      * @returns {Vec3} -
      */
     mul(vec: Vec3): Vec3;
+    /**
+     * Multiply current vector object to another and returns new vector instance.
+     * @public
+     * @param {Vec3} vec - Multiply vector.
+     * @returns {Vec3} -
+     */
+    mulRes(vec: Vec3, res: Vec3): Vec3;
     /**
      * Divide current vector's components to another. Results stores in the current vector object.
      * @public
@@ -452,6 +466,7 @@ export declare class Vec3 {
      * @returns {Vec3} -
      */
     slerp(v2: Vec3, t: number): Vec3;
+    mulVecA(a: Vec3): Vec3;
     /**
      * Gets the shortest arc quaternion to rotate this vector to the destination vector.
      * @param {Vec3} dest -

package/lib/@openglobus/js/math.d.ts

@@ -70,7 +70,7 @@ export declare function log(n: number, base: number): number;
 /**
  * Clamp the number.
  * @function
- * @param {number} number - Input number.
+ * @param {number} value - Input number.
  * @param {number} min - Minimal edge.
  * @param {number} max - Maximal edge.
  * @returns {number} -
@@ -78,7 +78,7 @@ export declare function log(n: number, base: number): number;
  * clamp(12, 1, 5)
  * //returns 5
  */
-export declare function clamp(number: number, min: number, max: number): number;
+export declare function clamp(value: number, min: number, max: number): number;
 /**
  * Converts degrees value to radians.
  * @function

package/lib/@openglobus/js/quadTree/EntityCollectionNode.d.ts

@@ -16,7 +16,7 @@ declare class EntityCollectionNode {
     layer: Vector;
     strategy: EntityCollectionsTreeStrategy;
     parentNode: EntityCollectionNode | null;
-    childrenNodes: EntityCollectionNode[];
+    childNodes: EntityCollectionNode[];
     partId: number;
     nodeId: number;
     state: number | null;
@@ -34,7 +34,7 @@ declare class EntityCollectionNode {
     __setLonLat__(entity: Entity): LonLat;
     buildTree(entities: Entity[], rightNow?: boolean): void;
     isInside(entity: Entity): boolean;
-    createChildrenNodes(): void;
+    createChildNodes(): void;
     collectRenderCollectionsPASS1(visibleNodes: NodesDict, outArr: EntityCollection[]): void;
     collectRenderCollectionsPASS2(visibleNodes: NodesDict, outArr: EntityCollection[], renderingNodeId: number): void;
     applyCollection(): void;

package/lib/@openglobus/js/quadTree/Node.d.ts

@@ -33,7 +33,7 @@ declare class Node {
     inFrustum: number;
     _fadingNodes: Node[];
     constructor(SegmentPrototype: typeof Segment, planet: Planet, partId: number, parent: Node | null, tileZoom: number, extent: Extent);
-    createChildrenNodes(): void;
+    createChildNodes(): void;
     createBounds(): void;
     getState(): number | null;
     /**

package/lib/@openglobus/js/quadTree/earth/EarthEntityCollectionNodeLonLat.d.ts

@@ -9,7 +9,7 @@ export declare class EarthEntityCollectionNodeLonLat extends EntityCollectionNod
     isNorth: boolean;
     strategy: EarthEntityCollectionsTreeStrategy;
     constructor(strategy: EarthEntityCollectionsTreeStrategy, partId: number, parent: EarthEntityCollectionNodeLonLat | null, extent: Extent, planet: Planet, zoom: number);
-    createChildrenNodes(): void;
+    createChildNodes(): void;
     protected _setExtentBounds(): void;
     __setLonLat__(entity: Entity): LonLat;
     isVisible(): boolean;

package/lib/@openglobus/js/quadTree/equi/EquiEntityCollectionNodeLonLat.d.ts

@@ -8,7 +8,7 @@ import { EquiEntityCollectionsTreeStrategy } from "./EquiEntityCollectionsTreeSt
 export declare class EquiEntityCollectionNodeLonLat extends EntityCollectionNode {
     strategy: EquiEntityCollectionsTreeStrategy;
     constructor(strategy: EquiEntityCollectionsTreeStrategy, partId: number, parent: EquiEntityCollectionNodeLonLat | null, extent: Extent, planet: Planet, zoom: number);
-    createChildrenNodes(): void;
+    createChildNodes(): void;
     protected _setExtentBounds(): void;
     __setLonLat__(entity: Entity): LonLat;
     isVisible(): boolean;

package/lib/@openglobus/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,18 +290,14 @@ 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
@@ -299,19 +310,27 @@ declare class Renderer {
      * 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

package/lib/@openglobus/js/renderer/RendererEvents.d.ts

@@ -8,6 +8,7 @@ import { Vec3 } from "../math/Vec3";
 export type RendererEventsHandler = RendererEvents & EventsHandler<RendererEventsType>;
 export declare function createRendererEvents(renderer: Renderer): RendererEvents;
 export type RendererEventsType = [
+    "changerelativecenter",
     "draw",
     "drawtransparent",
     "postdraw",