globe.gl 2.33.2 → 2.34.0

package/README.md

@@ -67,8 +67,7 @@ or using a *script* tag
 ```
 then
 ```js
-const myGlobe = Globe();
-myGlobe(myDOMElement)
+const myGlobe = new Globe(myDOMElement)
   .globeImageUrl(myImageUrl)
   .pointsData(myData);
 ```
@@ -97,7 +96,7 @@ myGlobe(myDOMElement)
 ### Initialisation
 
 ```js
-Globe({ configOptions })(<domElement>)
+new Globe(<domElement>, { configOptions })
 ```
 
 | Config options | Description | Default |
@@ -113,14 +112,14 @@ Globe({ configOptions })(<domElement>)
 | <b>width</b>([<i>px</i>]) | Getter/setter for the canvas width. | *&lt;window width&gt;* |
 | <b>height</b>([<i>px</i>]) | Getter/setter for the canvas height. | *&lt;window height&gt;* |
 | <b>backgroundColor</b>([<i>str</i>]) | Getter/setter for the background color. | `#000011` |
-| <b>backgroundImageUrl</b>([<i>url</i>]) | Getter/setter for the URL of the image to be used as background to the globe. If no image is provided, the background color is shown instead. | `null` |
+| <b>backgroundImageUrl</b>([<i>url</i>]) | Getter/setter for the URL of the equirectangular projection image to be used as background to the globe. If no image is provided, the background color is shown instead. | `null` |
 
 ### Globe Layer
 
 | Method | Description | Default |
 | --- | --- | :--: |
-| <b>globeImageUrl</b>([<i>url</i>]) | Getter/setter for the URL of the image used in the material that wraps the globe. If no image is provided, the globe is represented as a black sphere. | `null` |
-| <b>bumpImageUrl</b>([<i>url</i>]) | Getter/setter for the URL of the image used to create a [bump map](https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.bumpMap) in the material, to represent the globe's terrain. | `null` |
+| <b>globeImageUrl</b>([<i>url</i>]) | Getter/setter for the URL of the image used in the material that wraps the globe. This image should follow an [equirectangular projection](https://en.wikipedia.org/wiki/Equirectangular_projection). If no image is provided, the globe is represented as a black sphere. | `null` |
+| <b>bumpImageUrl</b>([<i>url</i>]) | Getter/setter for the URL of the image used to create a [bump map](https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.bumpMap) in the material, to represent the globe's terrain. This image should follow an [equirectangular projection](https://en.wikipedia.org/wiki/Equirectangular_projection). | `null` |
 | <b>showGlobe</b>([<i>boolean</i>]) | Getter/setter for whether to show the globe surface itself. | `true` |
 | <b>showGraticules</b>([<i>boolean</i>]) | Getter/setter for whether to show a graticule grid demarking latitude and longitude lines at every 10 degrees. | `false` |
 | <b>showAtmosphere</b>([<i>boolean</i>]) | Getter/setter for whether to show a bright halo surrounding the globe, representing the atmosphere. | `true` |

package/dist/globe.gl.d.ts

@@ -1,4 +1,4 @@
-import { WebGLRendererParameters, Object3D, Light, Scene, Camera, WebGLRenderer } from 'three';
+import { WebGLRendererParameters, Light, Scene, Camera, WebGLRenderer, Object3D } from 'three';
 import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls.js';
 import { EffectComposer } from 'three/examples/jsm/postprocessing/EffectComposer.js';
 import { ConfigOptions as ConfigOptions$1, ThreeGlobeGeneric } from 'three-globe';
@@ -27,9 +27,10 @@ type PointerEventsFilterFn = (object: Object3D, data?: object) => boolean;
 // don't surface these internal props from inner ThreeGlobe
 type ExcludedInnerProps = 'setPointOfView' | 'pauseAnimation' | 'resumeAnimation';
 
-interface GlobeGenericInstance<ChainableInstance>
+declare class GlobeGeneric<ChainableInstance>
   extends Omit<ThreeGlobeGeneric<ChainableInstance>, ExcludedInnerProps> {
-  (element: HTMLElement): ChainableInstance;
+  constructor(element: HTMLElement, configOptions?: ConfigOptions);
+
   resetProps(): ChainableInstance;
   _destructor(): void;
 
@@ -125,8 +126,6 @@ interface GlobeGenericInstance<ChainableInstance>
   toGlobeCoords(x: number, y: number): { lat: number, lng: number} | null;
 }
 
-type GlobeInstance = GlobeGenericInstance<GlobeInstance>;
-
-declare function Globe(configOptions?: ConfigOptions): GlobeInstance;
+declare class Globe extends GlobeGeneric<Globe> {}
 
-export { type ConfigOptions, type GlobeGenericInstance, type GlobeInstance, Globe as default };
+export { type ConfigOptions, GlobeGeneric, Globe as default };