mirror of
https://github.com/openglobus/openglobus.git
synced 2025-12-08 19:25:27 +00:00
better types
This commit is contained in:
parent
9eda4928bf
commit
3f74361e44
@ -50,9 +50,9 @@ const PLANET_NAME_PREFIX = "globus_planet_";
|
||||
*
|
||||
* @param {object} options - Options:
|
||||
* @param {string} options.target - HTML element id where planet canvas have to be created.
|
||||
* @param {scene.RenderNode} [options.skybox] - Render skybox. null - default.
|
||||
* @param {RenderNode} [options.skybox] - Render skybox. null - default.
|
||||
* @param {string} [options.name] - Planet name. Default is unic identifier.
|
||||
* @param {terrain.Terrain} [options.terrain] - Terrain provider. Default no terrain - og.terrain.EmptyTerrain.
|
||||
* @param {Terrain} [options.terrain] - Terrain provider. Default no terrain - og.terrain.EmptyTerrain.
|
||||
* @param {Array.<control.Control>} [options.controls] - Renderer controls array.
|
||||
* @param {Array.<Layer>} [options.layers] - Planet layers.
|
||||
* @param {Extent} [options.viewExtent] - Viewable starting extent.
|
||||
@ -148,7 +148,7 @@ class Globe {
|
||||
/**
|
||||
* Render node renders a planet.
|
||||
* @public
|
||||
* @type {scene.Planet|og.scene.PlanetAtmosphere}
|
||||
* @type {Planet|og.scene.PlanetAtmosphere}
|
||||
*/
|
||||
// TODO:
|
||||
} else {
|
||||
|
||||
@ -227,7 +227,7 @@ class Frustum {
|
||||
/**
|
||||
* Returns true if the frustum contains a bonding sphere, but bottom plane exclude.
|
||||
* @public
|
||||
* @param {bv.Sphere} sphere - Bounding sphere.
|
||||
* @param {Sphere} sphere - Bounding sphere.
|
||||
* @returns {boolean} -
|
||||
*/
|
||||
containsSphereBottomExc(sphere) {
|
||||
@ -251,7 +251,7 @@ class Frustum {
|
||||
/**
|
||||
* Returns true if the frustum contains a bonding sphere.
|
||||
* @public
|
||||
* @param {bv.Sphere} sphere - Bounding sphere.
|
||||
* @param {Sphere} sphere - Bounding sphere.
|
||||
* @returns {boolean} -
|
||||
*/
|
||||
containsSphere(sphere) {
|
||||
@ -287,7 +287,7 @@ class Frustum {
|
||||
/**
|
||||
* Returns true if the frustum contains a bounding box.
|
||||
* @public
|
||||
* @param {bv.Box} box - Bounding box.
|
||||
* @param {Box} box - Bounding box.
|
||||
* @returns {boolean} -
|
||||
*/
|
||||
containsBox(box) {
|
||||
|
||||
@ -50,7 +50,7 @@ class PlanetCamera extends Camera {
|
||||
/**
|
||||
* Assigned camera's planet.
|
||||
* @public
|
||||
* @type {scene.Planet}
|
||||
* @type {Planet}
|
||||
*/
|
||||
this.planet = planet;
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ class Sun extends Control {
|
||||
/**
|
||||
* Earth planet node.
|
||||
* @public
|
||||
* @type {scene.Planet}
|
||||
* @type {Planet}
|
||||
*/
|
||||
this.planet = null;
|
||||
|
||||
|
||||
@ -85,7 +85,7 @@ class EntityCollection {
|
||||
/**
|
||||
* Render node context.
|
||||
* @public
|
||||
* @type {scene.RenderNode}
|
||||
* @type {RenderNode}
|
||||
*/
|
||||
this.renderNode = null;
|
||||
|
||||
@ -468,7 +468,7 @@ class EntityCollection {
|
||||
/**
|
||||
* Adds this collection to render node.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Render node.
|
||||
* @param {RenderNode} renderNode - Render node.
|
||||
* @param {boolean} [isHidden] - Uses in vector layers that render in planet render specific function.
|
||||
* @returns {EntityCollection} -
|
||||
*/
|
||||
|
||||
@ -68,7 +68,7 @@ class PointCloud {
|
||||
/**
|
||||
* Parent collection render node.
|
||||
* @private
|
||||
* @type {scene.RenderNode}
|
||||
* @type {RenderNode}
|
||||
*/
|
||||
this._renderNode = null;
|
||||
|
||||
@ -189,7 +189,7 @@ class PointCloud {
|
||||
/**
|
||||
* Assign rendering scene node.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Assigned render node.
|
||||
* @param {RenderNode} renderNode - Assigned render node.
|
||||
*/
|
||||
setRenderNode(renderNode) {
|
||||
this._renderNode = renderNode;
|
||||
|
||||
@ -1752,7 +1752,7 @@ class Polyline {
|
||||
/**
|
||||
* Assign with render node.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode -
|
||||
* @param {RenderNode} renderNode -
|
||||
*/
|
||||
setRenderNode(renderNode) {
|
||||
if (renderNode) {
|
||||
|
||||
@ -57,7 +57,7 @@ class Strip {
|
||||
/**
|
||||
* Parent collection render node.
|
||||
* @private
|
||||
* @type {scene.RenderNode}
|
||||
* @type {RenderNode}
|
||||
*/
|
||||
this._renderNode = null;
|
||||
|
||||
@ -177,7 +177,7 @@ class Strip {
|
||||
/**
|
||||
* Assign rendering scene node.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Assigned render node.
|
||||
* @param {RenderNode} renderNode - Assigned render node.
|
||||
*/
|
||||
setRenderNode(renderNode) {
|
||||
this._renderNode = renderNode;
|
||||
|
||||
@ -118,7 +118,7 @@ class Layer {
|
||||
/**
|
||||
* Planet node.
|
||||
* @protected
|
||||
* @type {scene.Planet}
|
||||
* @type {Planet}
|
||||
*/
|
||||
this._planet = null;
|
||||
|
||||
@ -321,7 +321,7 @@ class Layer {
|
||||
* Assign the planet.
|
||||
* @protected
|
||||
* @virtual
|
||||
* @param {scene.Planet} planet - Planet render node.
|
||||
* @param {Planet} planet - Planet render node.
|
||||
*/
|
||||
_assignPlanet(planet) {
|
||||
planet.layers.push(this);
|
||||
@ -348,7 +348,7 @@ class Layer {
|
||||
/**
|
||||
* Adds layer to the planet.
|
||||
* @public
|
||||
* @param {scene.Planet} planet - Adds layer to the planet.
|
||||
* @param {Planet} planet - Adds layer to the planet.
|
||||
*/
|
||||
addTo(planet) {
|
||||
if (!this._planet) {
|
||||
|
||||
@ -42,7 +42,7 @@ class LightSource {
|
||||
/**
|
||||
* Render node where light is shines.
|
||||
* @protected
|
||||
* @type {scene.RenderNode}
|
||||
* @type {RenderNode}
|
||||
*/
|
||||
this._renderNode = null;
|
||||
|
||||
@ -320,7 +320,7 @@ class LightSource {
|
||||
/**
|
||||
* Adds current light to the render node scene.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Render node scene.
|
||||
* @param {RenderNode} renderNode - Render node scene.
|
||||
* @returns {LightSource}
|
||||
*/
|
||||
addTo(renderNode) {
|
||||
|
||||
@ -171,7 +171,7 @@ export class Ray {
|
||||
/**
|
||||
* Returns a ray hit sphere coordiante. If there isn't hit returns null.
|
||||
* @public
|
||||
* @param {bv.Sphere} sphere - Sphere object.
|
||||
* @param {Sphere} sphere - Sphere object.
|
||||
* @returns {Vec3}
|
||||
*/
|
||||
hitSphere(sphere) {
|
||||
|
||||
@ -56,7 +56,7 @@ let BOUNDS = {
|
||||
* Quad tree planet segment node.
|
||||
* @constructor
|
||||
* @param {planetSegment.Segment|og.planetSegment.SegmentLonLat} segmentPrototype - Planet segment node constructor.
|
||||
* @param {scene.RenderNode} planet - Planet render node.
|
||||
* @param {RenderNode} planet - Planet render node.
|
||||
* @param {number} partId - NorthEast, SouthWest etc.
|
||||
* @param {quadTree.Node} parent - Parent of this node.
|
||||
* @param {number} id - Tree node identifier (id * 4 + 1);
|
||||
|
||||
@ -564,7 +564,7 @@ class Renderer {
|
||||
/**
|
||||
* Adds render node to the renderer.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Render node.
|
||||
* @param {RenderNode} renderNode - Render node.
|
||||
*/
|
||||
addNode(renderNode) {
|
||||
if (!this.renderNodes[renderNode.name]) {
|
||||
@ -579,7 +579,7 @@ class Renderer {
|
||||
/**
|
||||
* Adds render node to the renderer before specific node.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Render node.
|
||||
* @param {RenderNode} renderNode - Render node.
|
||||
*/
|
||||
addNodeBefore(renderNode, renderNodeBefore) {
|
||||
if (!this.renderNodes[renderNode.name]) {
|
||||
|
||||
@ -163,7 +163,7 @@ export class Planet extends RenderNode {
|
||||
/**
|
||||
* Terrain provider.
|
||||
* @public
|
||||
* @type {terrain.Terrain}
|
||||
* @type {Terrain}
|
||||
*/
|
||||
this.terrain = null;
|
||||
|
||||
@ -560,7 +560,7 @@ export class Planet extends RenderNode {
|
||||
/**
|
||||
* Sets terrain provider
|
||||
* @public
|
||||
* @param {terrain.Terrain} terrain - Terrain provider.
|
||||
* @param {Terrain} terrain - Terrain provider.
|
||||
*/
|
||||
setTerrain(terrain) {
|
||||
this._renderCompletedActivated = false;
|
||||
|
||||
@ -121,7 +121,7 @@ class RenderNode extends BaseNode {
|
||||
* @public
|
||||
* @param {EntityCollection} entityCollection - Entity collection.
|
||||
* @param {boolean} [isHidden] - If it's true that this collection has specific rendering.
|
||||
* @returns {scene.RenderNode} -
|
||||
* @returns {RenderNode} -
|
||||
*/
|
||||
addEntityCollection(entityCollection, isHidden) {
|
||||
entityCollection.addTo(this, isHidden);
|
||||
@ -141,7 +141,7 @@ class RenderNode extends BaseNode {
|
||||
* Adds point light source.
|
||||
* @public
|
||||
* @param {LightSource} light - Light source.
|
||||
* @returns {scene.RenderNode}
|
||||
* @returns {RenderNode}
|
||||
*/
|
||||
addLight(light) {
|
||||
light.addTo(this);
|
||||
|
||||
@ -59,14 +59,14 @@ window.BBSC = 100;
|
||||
* Planet segment Web Mercator tile class that stored and rendered with quad tree.
|
||||
* @class
|
||||
* @param {quadTree.Node} node - Segment node.
|
||||
* @param {scene.Planet} planet - Current planet scene.
|
||||
* @param {Planet} planet - Current planet scene.
|
||||
* @param {Number} tileZoom - Zoom index.
|
||||
* @param {Extent} extent - Segment extent.
|
||||
*/
|
||||
class Segment {
|
||||
/**
|
||||
* @param {quadTree.Node} node - Segment node.
|
||||
* @param {scene.Planet} planet - Current planet scene.
|
||||
* @param {Planet} planet - Current planet scene.
|
||||
* @param {number} tileZoom - Zoom index.
|
||||
* @param {Extent} extent - Segment extent.
|
||||
*/
|
||||
@ -85,7 +85,7 @@ class Segment {
|
||||
|
||||
/**
|
||||
* Planet pointer.
|
||||
* @type {scene.Planet}
|
||||
* @type {Planet}
|
||||
*/
|
||||
this.planet = planet;
|
||||
|
||||
@ -97,7 +97,7 @@ class Segment {
|
||||
|
||||
/**
|
||||
* Segment bounding sphere
|
||||
* @type {bv.Sphere}
|
||||
* @type {Sphere}
|
||||
*/
|
||||
this.bsphere = new Sphere();
|
||||
|
||||
@ -105,7 +105,7 @@ class Segment {
|
||||
|
||||
/**
|
||||
* Segment bounding box.
|
||||
* @type {bv.Box}
|
||||
* @type {Box}
|
||||
*/
|
||||
this.bbox = new Box();
|
||||
|
||||
|
||||
@ -21,14 +21,14 @@ let _tempHigh = new Vec3(),
|
||||
* @class
|
||||
* @extends {Segment}
|
||||
* @param {quadNode.Node} node - Quad tree segment node.
|
||||
* @param {scene.Planet} planet - Scene planet.
|
||||
* @param {Planet} planet - Scene planet.
|
||||
* @param {Number} tileZoom - Segment tile zoom index.
|
||||
* @param {Extent} extent - Segment WGS84 extent.
|
||||
*/
|
||||
class SegmentLonLat extends Segment {
|
||||
/**
|
||||
* @param {quadTree.Node} node - Segment node.
|
||||
* @param {scene.Planet} planet - Current planet scene.
|
||||
* @param {Planet} planet - Current planet scene.
|
||||
* @param {number} tileZoom - Zoom index.
|
||||
* @param {Extent} extent - Segment extent.
|
||||
*/
|
||||
|
||||
@ -157,7 +157,7 @@ class BaseShape {
|
||||
/**
|
||||
* Assigned render node.
|
||||
* @protected
|
||||
* @type {scene.RenderNode}
|
||||
* @type {RenderNode}
|
||||
*/
|
||||
this._renderNode = null;
|
||||
|
||||
@ -296,7 +296,7 @@ class BaseShape {
|
||||
/**
|
||||
* Assign render node.
|
||||
* @public
|
||||
* @param {scene.RenderNode} renderNode - Render node to assign.
|
||||
* @param {RenderNode} renderNode - Render node to assign.
|
||||
*/
|
||||
setRenderNode(renderNode) {
|
||||
this._renderNode = renderNode;
|
||||
|
||||
@ -58,7 +58,7 @@ class EmptyTerrain {
|
||||
/**
|
||||
* Planet node.
|
||||
* @protected
|
||||
* @type {scene.Planet}
|
||||
* @type {Planet}
|
||||
*/
|
||||
this._planet = null;
|
||||
|
||||
|
||||
@ -426,7 +426,7 @@ class GlobusTerrain extends EmptyTerrain {
|
||||
/**
|
||||
* Sets url rewrite callback, used for custom url rewriting for every tile laoding.
|
||||
* @public
|
||||
* @param {terrain.GlobusTerrain~_urlRewriteCallback} ur - The callback that returns tile custom created url.
|
||||
* @param {GlobusTerrain~_urlRewriteCallback} ur - The callback that returns tile custom created url.
|
||||
*/
|
||||
setUrlRewriteCallback(ur) {
|
||||
this._urlRewriteCallback = ur;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user