@openglobus/og 0.28.7 → 1.0.0-rc2

package/lib/entity/{Strip.d.ts → strip/Strip.d.ts}

@@ -1,11 +1,12 @@
-import { Entity } from "./Entity";
-import { RenderNode } from "../scene/RenderNode";
-import { Vec3 } from "../math/Vec3";
-import { Vec4 } from "../math/Vec4";
-import type { NumberArray3 } from "../math/Vec3";
-import type { NumberArray4 } from "../math/Vec4";
+import { Entity } from "../Entity";
+import { Scene } from "../../scene/Scene";
+import { Vec3 } from "../../math/Vec3";
+import { Vec4 } from "../../math/Vec4";
+import type { NumberArray3 } from "../../math/Vec3";
+import type { NumberArray4 } from "../../math/Vec4";
 import { StripHandler } from "./StripHandler";
-import type { WebGLBufferExt } from "../webgl/Handler";
+import type { WebGLBufferExt } from "../../webgl/Handler";
+import type { ShaderProgram } from "../../webgl/ShaderProgram";
 type TPoiExt = Vec3 | NumberArray3;
 type TStripExt = [TPoiExt, TPoiExt];
 type TPoi = Vec3;
@@ -41,13 +42,13 @@ declare class Strip {
      * @type {boolean}
      */
     visibility: boolean;
-    color: Float32Array;
+    protected _color: Float32Array;
     /**
      * Parent collection render node.
      * @protected
-     * @type {RenderNode}
+     * @type {Scene}
      */
-    protected _renderNode: RenderNode | null;
+    protected _scene: Scene | null;
     /**
      * Entity instance that holds this strip.
      * @public
@@ -96,33 +97,36 @@ declare class Strip {
     setColorHTML(color: string): void;
     setColor(r: number, g: number, b: number, a?: number): void;
     /**
-     * Set strip opacity.
+     * Sets strip opacity.
      * @public
-     * @param {number} opacity - opacity.
+     * @param {number} opacity - Opacity.
      */
     setOpacity(opacity: number): void;
+    isOpaque(): boolean;
     /**
-     * Sets cloud visibility.
+     * Sets strip visibility.
      * @public
      * @param {boolean} visibility - Visibility flag.
      */
     setVisibility(visibility: boolean): void;
     /**
-     * @return {boolean} Strip visibility.
+     * @returns {boolean} Strip visibility.
      */
     getVisibility(): boolean;
     /**
      * Assign rendering scene node.
      * @public
-     * @param {RenderNode}  renderNode - Assigned render node.
+     * @param {Scene}  scene - Assigned render node.
      */
-    setRenderNode(renderNode: RenderNode): void;
+    bindScene(scene: Scene): void;
     /**
      * Removes from entity.
      * @public
      */
     remove(): void;
-    draw(): void;
+    protected _drawImpl(sh: ShaderProgram, color: Float32Array, opacity: number): void;
+    drawTransparent(): void;
+    drawOpaque(): void;
     drawPicking(): void;
     /**
      * Delete buffers

package/lib/entity/{StripHandler.d.ts → strip/StripHandler.d.ts}

@@ -1,6 +1,6 @@
-import { EntityCollection } from "./EntityCollection";
-import { Renderer } from "../renderer/Renderer";
-import { RenderNode } from "../scene/RenderNode";
+import { EntityCollection } from "../EntityCollection";
+import { Renderer } from "../../renderer/Renderer";
+import { Scene } from "../../scene/Scene";
 import { Strip } from "./Strip";
 declare class StripHandler {
     static __counter__: number;
@@ -29,13 +29,18 @@ declare class StripHandler {
      * @type {Array.<Strip>}
      */
     protected _strips: Strip[];
+    protected _opaqueCount: number;
     constructor(entityCollection: EntityCollection);
     protected _initProgram(): void;
-    setRenderNode(renderNode: RenderNode): void;
+    bindScene(scene: Scene): void;
+    protected _swap(i: number, j: number): void;
     add(strip: Strip): void;
     remove(strip: Strip): void;
-    reindexStripArray(startIndex: number): void;
-    draw(): void;
+    drawForward(): void;
+    drawOpaque(): void;
+    drawTransparent(): void;
+    drawTransparentForward(): void;
+    updateStripOpacity(strip: Strip): void;
     drawPicking(): void;
     clear(): void;
 }

package/lib/index.d.ts

@@ -1,43 +1,48 @@
-import '../css/og.css';
-import * as jd from './astro/jd';
-import * as math from './math';
-import * as mercator from './mercator';
-import * as utils from './utils/shared';
-import * as bv from './bv/index';
-import * as control from './control/index';
-import * as scene from './scene/index';
-import * as terrain from './terrain/index';
-import * as layer from './layer/index';
-import * as ui from './ui/index';
-import * as webgl from './webgl/index';
-export * from './control/Control';
-export * from './entity/index';
-export * from './layer/index';
-export * from './Globe';
-export type { IControlParams } from './control/Control';
-export type { ITouchState } from './renderer/RendererEvents';
+import "../css/og.css";
+import * as jd from "./astro/jd";
+import * as math from "./math";
+import * as mercator from "./mercator";
+import * as utils from "./utils/shared";
+import * as bv from "./bv/index";
+import * as control from "./control/index";
+import * as scene from "./scene/index";
+import * as terrain from "./terrain/index";
+import * as layer from "./layer/index";
+import * as ui from "./ui/index";
+import * as webgl from "./webgl/index";
+export * from "./control/Control";
+export * from "./entity/index";
+export * from "./layer/index";
+export * from "./Globe";
+export type { IControlParams } from "./control/Control";
+export type { ITouchState } from "./renderer/RendererEvents";
+export type { IDeferredShadingPass } from "./renderer/IDeferredShadingPass";
+export type { ITransparencyPass } from "./renderer/ITransparencyPass";
+export { PhongDeferredShading } from "./renderer/PhongDeferredShading";
+export { AtmosphereDeferredShading } from "./renderer/AtmosphereDeferredShading";
+export { WOITPass } from "./renderer/WOITPass";
+export { SHADE_UNLIT, SHADE_PHONG, SHADE_PBR, type ShadeMode, type ShadeModeInput } from "./shadeModeConstants";
 export declare const version: string;
-import { Geoid } from './terrain/Geoid';
-import { input } from './input/input';
-import { Ellipsoid, wgs84, moon, mars } from './ellipsoid/index';
-import { Camera, PlanetCamera } from './camera/index';
-import { Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4 } from './math/index';
-import { Renderer } from './renderer/Renderer';
-import { LightSource } from './light/LightSource';
-import { Clock } from './Clock';
-import { Events, type EventsHandler, createEvents } from './Events';
-import { Extent } from './Extent';
-import { LonLat } from './LonLat';
-import { RenderNode } from './scene/RenderNode';
-import { Planet } from './scene/Planet';
-import { Popup } from './Popup';
-import { Loader, type IResponse } from './utils/Loader';
-import { EarthQuadTreeStrategy, EquiQuadTreeStrategy, QuadTreeStrategy, quadTreeStrategyType, Wgs84QuadTreeStrategy } from './quadTree/index';
-import { Object3d } from './Object3d';
-import { Handler, Program, Framebuffer, Multisample } from './webgl/index';
-import { EmptyTerrain, GlobusTerrain, RgbTerrain, BilTerrain, GlobusRgbTerrain } from './terrain/index';
-import { MoveAxisEntity } from "./control/geoObjectEditor/MoveAxisEntity";
-import { Gltf } from './utils/gltf/gltfParser';
-import { Easing } from './utils/easing';
-import type { EasingFunction } from './utils/easing';
-export { bv, jd, math, mercator, utils, input, control, scene, quadTreeStrategyType, wgs84, moon, mars, terrain, layer, ui, webgl, Easing, EasingFunction, Framebuffer, EmptyTerrain, GlobusTerrain, RgbTerrain, GlobusRgbTerrain, BilTerrain, Camera, Ellipsoid, Planet, PlanetCamera, LightSource, Program, Handler, Multisample, Renderer, Clock, Events, EventsHandler, createEvents, Extent, LonLat, RenderNode, Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4, Geoid, Popup, QuadTreeStrategy, EquiQuadTreeStrategy, EarthQuadTreeStrategy, Wgs84QuadTreeStrategy, Object3d, Gltf, MoveAxisEntity, Loader, IResponse };
+import { Geoid } from "./terrain/Geoid";
+import { input } from "./input/input";
+import { Ellipsoid, wgs84, moon, mars } from "./ellipsoid/index";
+import { Camera, PlanetCamera } from "./camera/index";
+import { Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4 } from "./math/index";
+import { Renderer } from "./renderer/Renderer";
+import { Clock } from "./Clock";
+import { Events, type EventsHandler, createEvents } from "./Events";
+import { Extent } from "./Extent";
+import { LonLat } from "./LonLat";
+import { Scene } from "./scene/Scene";
+import { Planet } from "./scene/Planet";
+import { Popup } from "./Popup";
+import { Loader, type IResponse } from "./utils/Loader";
+import { EarthQuadTreeStrategy, EquiQuadTreeStrategy, QuadTreeStrategy, quadTreeStrategyType, Wgs84QuadTreeStrategy } from "./quadTree/index";
+import { Object3d } from "./Object3d";
+import { Handler, ShaderProgram, Framebuffer, Multisample } from "./webgl/index";
+import { EmptyTerrain, GlobusTerrain, RgbTerrain, BilTerrain, GlobusRgbTerrain } from "./terrain/index";
+import { MoveAxisEntity } from "./control/entityEditor/MoveAxisEntity";
+import { Gltf } from "./utils/gltf/gltfParser";
+import { Easing } from "./utils/easing";
+import type { EasingFunction } from "./utils/easing";
+export { bv, jd, math, mercator, utils, input, control, scene, quadTreeStrategyType, wgs84, moon, mars, terrain, layer, ui, webgl, Easing, EasingFunction, Framebuffer, EmptyTerrain, GlobusTerrain, RgbTerrain, GlobusRgbTerrain, BilTerrain, Camera, Ellipsoid, Planet, PlanetCamera, ShaderProgram, Handler, Multisample, Renderer, Clock, Events, EventsHandler, createEvents, Extent, LonLat, Scene, Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4, Geoid, Popup, QuadTreeStrategy, EquiQuadTreeStrategy, EarthQuadTreeStrategy, Wgs84QuadTreeStrategy, Object3d, Gltf, MoveAxisEntity, Loader, IResponse };

package/lib/layer/BaseGeoImage.d.ts

@@ -12,14 +12,11 @@ export interface IBaseGeoImageParams extends ILayerParams {
     fullExtent?: boolean;
     corners?: NumberArray2[];
 }
-type BaseGeoImageEventsList = [
-    "loadend"
-];
+type BaseGeoImageEventsList = ["loadend"];
 export type BaseGeoImageEventsType = EventsHandler<BaseGeoImageEventsList> & EventsHandler<LayerEventsList>;
 /**
- * BaseGeoImage layer represents square imagery layer that
- * could be a static image, or animated video or webgl buffer
- * object displayed on the globe.
+ * BaseGeoImage represents a square imagery layer displayed on the globe.
+ * It can use a static image, animated video, or WebGL buffer as a source.
  * @class
  * @extends {Layer}
  */
@@ -48,12 +45,14 @@ declare class BaseGeoImage extends Layer {
     protected _cornersWgs84: LonLat[];
     protected _cornersMerc: LonLat[];
     protected _isFullExtent: number;
+    protected _crossesAntimeridian: boolean;
     /**
      * rendering function pointer
      * @type {Function}
      */
     rendering: Function;
     protected _onLoadend_: EventCallback | null;
+    protected _materialMipmapUpdateCounter: number;
     constructor(name: string | null, options?: IBaseGeoImageParams);
     get isIdle(): boolean;
     addTo(planet: Planet): void;
@@ -63,31 +62,33 @@ declare class BaseGeoImage extends Layer {
     /**
      * Gets corners coordinates.
      * @public
-     * @return {Array.<LonLat>} - (exactly 4 entries)
+     * @returns {Array.<LonLat>} - (exactly 4 entries)
      */
     getCornersLonLat(): LonLat[];
     /**
      * Gets corners coordinates.
      * @public
-     * @return {Array.<Array<number>>} - (exactly 3 entries)
+     * @returns {Array.<Array<number>>} - (exactly 4 entries)
      */
     getCorners(): NumberArray2[];
     /**
      * Sets geoImage geographical corners coordinates.
      * @public
-     * @param {Array.<Array.<number>>} corners - GeoImage corners coordinates. Where first coordinate (exactly 3 entries)
-     * coincedents to the left top image corner, secont to the right top image corner, third to the right bottom
-     * and fourth - left bottom image corner.
+     * @param {Array.<Array.<number>>} corners - GeoImage corner coordinates. Each coordinate has exactly 2 entries.
+     * The first corner is top-left, the second is top-right, the third is bottom-right, and the fourth is bottom-left.
      */
     setCorners(corners: NumberArray2[]): void;
     /**
      * Sets geoImage geographical corners coordinates.
      * @public
-     * @param {Array.<LonLat>} corners - GeoImage corners coordinates. Where first coordinate
-     * coincedents to the left top image corner, secont to the right top image corner, third to the right bottom
-     * and fourth - left bottom image corner. (exactly 4 entries)
+     * @param {Array.<LonLat>} corners - GeoImage corner coordinates.
+     * The first corner is top-left, the second is top-right, the third is bottom-right, and the fourth is bottom-left.
+     * (exactly 4 entries)
      */
     setCornersLonLat(corners: LonLat[]): void;
+    protected _isExplicitFullWorldLonEdge(lonA: number, lonB: number): boolean;
+    protected _unwrapCornersLonLat(corners: LonLat[]): LonLat[];
+    protected _detectAntimeridianCrossing(corners: LonLat[]): boolean;
     /**
      * Creates geoImage frame.
      * @protected
@@ -117,22 +118,23 @@ declare class BaseGeoImage extends Layer {
      * @param {Material} material - GeoImage material.
      */
     clearMaterial(material: Material): void;
+    protected _getCyclicLonShift(sourceExtent: Extent, targetExtent: Extent, worldWidth: number): number;
     /**
      * @public
      * @override
-     * @returns {Array<number>} -
+     * @returns {NumberArray4}
      */
     applyMaterial(material: Material): NumberArray4;
     /**
      * Gets frame width size in pixels.
      * @public
-     * @returns {Number} Frame width.
+     * @returns {number} Frame width.
      */
     get getFrameWidth(): number;
     /**
      * Gets frame height size in pixels.
      * @public
-     * @returns {Number} Frame height.
+     * @returns {number} Frame height.
      */
     get getFrameHeight(): number;
     /**
@@ -140,6 +142,7 @@ declare class BaseGeoImage extends Layer {
      * @protected
      */
     protected _createSourceTexture(): void;
+    protected _updateMaterialTextureMipmap(): void;
     _renderingProjType1(): void;
     protected _renderingProjType0(): void;
 }

package/lib/layer/CanvasTiles.d.ts

@@ -12,26 +12,26 @@ export interface ICanvasTilesParams extends ILayerParams {
     minNativeZoom?: number;
     maxNativeZoom?: number;
 }
-type CanvasTilesEventsList = [
-    "load",
-    "loadend"
-];
+type CanvasTilesEventsList = ["load", "loadend"];
 type CanvasTilesEventsType = EventsHandler<CanvasTilesEventsList> & EventsHandler<LayerEventsList>;
 /**
- * Layer used to rendering each tile as a separate canvas object.
+ * Layer that renders each tile as a separate canvas object.
  * @class
  * @extends {Layer}
- * @param {String} [name="noname"] - Layer name.
- * @param {ICanvasTilesParams} options:
+ * @param {string} [name="noname"] - Layer name.
+ * @param {ICanvasTilesParams} options - Layer options.
  * @param {number} [options.opacity=1.0] - Layer opacity.
  * @param {number} [options.minZoom=0] - Minimal visibility zoom level.
- * @param {number} [options.maxZoom=0] - Maximal visibility zoom level.
- * @param {string} [options.attribution] - Layer attribution that displayed in the attribution area on the screen.
+ * @param {number} [options.maxZoom=50] - Maximal visibility zoom level.
+ * @param {string} [options.attribution] - Layer attribution shown in the attribution area.
  * @param {boolean} [options.isBaseLayer=false] - Base layer flag.
  * @param {boolean} [options.visibility=true] - Layer visibility.
+ * @param {boolean} [options.animated=false] - Re-draw ready tiles every frame.
+ * @param {number} [options.minNativeZoom=0] - Minimal zoom level where native tile drawing is allowed.
+ * @param {number} [options.maxNativeZoom=100] - Maximal zoom level where native tile drawing is allowed.
  * @param {DrawTileCallback} options.drawTile - Draw tile callback.
- * @fires EventsHandler<CanvasTilesEventsList>#load
- * @fires EventsHandler<CanvasTilesEventsList>#loadend
+ * @fires load
+ * @fires loadend
  */
 declare class CanvasTiles extends Layer {
     static MAX_REQUESTS: number;
@@ -47,7 +47,7 @@ declare class CanvasTiles extends Layer {
      */
     protected _counter: number;
     /**
-     * Tile pending queue that waiting for create.
+     * Queue of pending tiles waiting to be created.
      * @protected
      * @type {Material[]}
      */
@@ -99,6 +99,8 @@ declare class CanvasTiles extends Layer {
     protected _dequeueRequest(): void;
     protected _whilePendings(): Material | null;
     applyMaterial(material: Material): NumberArray4;
+    protected _apllyMaterialDefault(material: Material): NumberArray4;
+    protected _applyMaterialFast(material: Material): NumberArray4;
     clearMaterial(material: Material): void;
 }
 export { CanvasTiles };

package/lib/layer/GeoImage.d.ts

@@ -30,7 +30,7 @@ declare class GeoImage extends BaseGeoImage {
     /**
      * Sets image source url path.
      * @public
-     * @param {string} srs - Image url path.
+     * @param {string} src - Image url path.
      */
     setSrc(src: string): void;
     /**

package/lib/layer/GeoTexture2d.d.ts

@@ -1,5 +1,5 @@
-import { BaseGeoImage } from './BaseGeoImage';
-import type { IBaseGeoImageParams } from './BaseGeoImage';
+import { BaseGeoImage } from "./BaseGeoImage";
+import type { IBaseGeoImageParams } from "./BaseGeoImage";
 import { Material } from "../layer/Material";
 import type { WebGLTextureExt } from "../webgl/Handler";
 interface IGeoTexture2dParams extends IBaseGeoImageParams {

package/lib/layer/KML.d.ts

@@ -1,19 +1,19 @@
-import { Billboard } from "../entity/Billboard";
-import type { IBillboardParams } from "../entity/Billboard";
+import type { IBillboardParams } from "../entity/billboard/Billboard";
+import { Billboard } from "../entity/billboard/Billboard";
 import { Entity } from "../entity/Entity";
 import { Extent } from "../Extent";
-import { Vector } from "./Vector";
 import type { IVectorParams } from "./Vector";
+import { Vector } from "./Vector";
 interface IKMLParams extends IVectorParams {
     color?: string;
     billboard?: IBillboardParams;
 }
 /**
- * Layer to render KMLs files
+ * Layer to render KML files.
  * @class
  * @extends {Vector}
- * @param {string} name
- * @param {*} [options]
+ * @param {string} name - Layer name.
+ * @param {IKMLParams} [options] - KML layer options.
  */
 export declare class KML extends Vector {
     protected _color: string;
@@ -24,7 +24,7 @@ export declare class KML extends Vector {
     protected _AGBRtoRGBA(agbr: string): string | undefined;
     /**
      * @protected
-     * @returns array of longitude, latitude, altitude (altitude optional)
+     * @returns {number[][]} Array of `[longitude, latitude, altitude?]`.
      */
     protected _parseKMLcoordinates(coords: Element): number[][];
     protected _kmlPlacemarkToEntity(placemark: Element | undefined | null, extent: Extent): Entity | undefined;
@@ -34,22 +34,23 @@ export declare class KML extends Vector {
     /**
      * Creates billboards or polylines from array of lonlat.
      * @protected
-     * @param {Array} coordonates
-     * @param {string} color
-     * @returns {any}
+     * @param {number[][][][]} coordinates - Coordinates grouped by files and paths.
+     * @param {string} color - Polyline color.
+     * @param {IBillboardParams} [billboard] - Billboard options.
+     * @returns {{entities: Array.<(Entity|undefined)>, extent: Extent}}
      */
     protected _convertCoordonatesIntoEntities(coordinates: number[][][][], color: string, billboard?: IBillboardParams): any;
     /**
      * @protected
-     * @returns {Document}
+     * @returns {Promise<XMLDocument>}
      */
     protected _getXmlContent(file: Blob): Promise<XMLDocument>;
     protected _expandExtents(extent1: Extent | null | undefined, extent2: Extent): Extent;
     /**
      * @public
-     * @param {File[]} kmls
-     * @param {string} [color]
-     * @param {Billboard} [billboard]
+     * @param {Blob[]} kmls - KML files.
+     * @param {string} [color] - Polyline color.
+     * @param {IBillboardParams} [billboard] - Billboard options.
      * @returns {Promise<{entities: Entity[], extent: Extent}>}
      */
     addKmlFromFiles(kmls: Blob[], color?: string, billboard?: IBillboardParams): Promise<{
@@ -57,16 +58,16 @@ export declare class KML extends Vector {
         extent: any;
     } | null>;
     /**
-     * @param {string} color
+     * @param {string} color - Layer color.
      * @public
      */
     setColor(color: string): void;
     protected _getKmlFromUrl(url: string): Promise<Document>;
     /**
      * @public
-     * @param {string} url - Url of the KML to display. './myFile.kml' or 'http://mySite/myFile.kml' for example.
-     * @param {string} [color]
-     * @param {Billboard} [billboard]
+     * @param {string} url - URL of the KML to display. For example: './myFile.kml' or 'http://mySite/myFile.kml'.
+     * @param {string} [color] - Polyline color.
+     * @param {Billboard | IBillboardParams} [billboard] - Billboard options.
      * @returns {Promise<{entities: Entity[], extent: Extent}>}
      */
     addKmlFromUrl(url: string, color?: string, billboard?: Billboard | IBillboardParams): Promise<any>;