@openglobus/og 0.28.7 → 1.0.0-rc2

package/lib/control/timeline/TimelineView.d.ts

@@ -1,9 +1,9 @@
 import type { EventsHandler } from "../../Events";
 import { ButtonGroup } from "../../ui/ButtonGroup";
-import { View } from '../../ui/View';
-import type { IViewParams, ViewEventsList } from '../../ui/View';
+import { View } from "../../ui/View";
+import type { IViewParams, ViewEventsList } from "../../ui/View";
 import { ToggleButton } from "../../ui/ToggleButton";
-import { TimelineModel } from './TimelineModel';
+import { TimelineModel } from "./TimelineModel";
 import type { MouseEventExt } from "../../input/MouseHandler";
 interface ITimelineViewParams extends IViewParams {
     currentDate?: Date;
@@ -13,18 +13,28 @@ interface ITimelineViewParams extends IViewParams {
     maxDate?: Date;
     fillStyle?: string;
 }
+declare const TOUCH_MODE_NONE = 0;
+declare const TOUCH_MODE_CURRENT = 1;
+declare const TOUCH_MODE_PINCH = 2;
+declare const TOUCH_MODE_SCALE = 3;
 type TimelineViewEventsList = [
-    'startdrag',
-    'stopdrag',
-    'startdragcurrent',
-    'stopdragcurrent',
-    'setcurrent',
-    'reset',
-    'play',
-    'playback',
-    'pause',
-    'visibility'
+    "startdrag",
+    "stopdrag",
+    "startdragcurrent",
+    "stopdragcurrent",
+    "setcurrent",
+    "reset",
+    "play",
+    "playback",
+    "pause",
+    "visibility"
 ];
+type TimelineTouchMode = typeof TOUCH_MODE_NONE | typeof TOUCH_MODE_CURRENT | typeof TOUCH_MODE_PINCH | typeof TOUCH_MODE_SCALE;
+interface ITimelineTouchPointer {
+    pointerId: number;
+    clientX: number;
+    clientY: number;
+}
 declare class TimelineView extends View<TimelineModel> {
     events: EventsHandler<TimelineViewEventsList> & EventsHandler<ViewEventsList>;
     fillStyle: string;
@@ -46,6 +56,12 @@ declare class TimelineView extends View<TimelineModel> {
     protected _clickCurrentDate: Date;
     protected _clickTime: number;
     protected _clickDelay: number;
+    protected _clickMoveTolerance: number;
+    protected _touchMode: TimelineTouchMode;
+    protected _touchPinchDistance: number;
+    protected _touchPointers: Map<number, ITimelineTouchPointer>;
+    protected _touchScalePointerId: number | null;
+    protected _touchCurrentPointerId: number | null;
     protected _onResizeObserver_: () => void;
     protected _resizeObserver: ResizeObserver;
     protected _pauseBtn: ToggleButton;
@@ -67,17 +83,40 @@ declare class TimelineView extends View<TimelineModel> {
     protected _onMouseWheel: (e: MouseEventExt) => void;
     protected _onMouseWheelFF: (e: MouseEventExt) => void;
     protected _zoom(pointerTime: number, pointerCenterOffsetX: number, dir: number): void;
+    protected _zoomByScale(pointerTime: number, pointerCenterOffsetX: number, scale: number): void;
+    protected _startScaleDrag(clientX: number, sourceEvent: Event, allowClick?: boolean, pointerId?: number | null): void;
+    protected _moveScaleDrag(clientX: number): void;
+    protected _stopScaleDrag(clientX: number | null, allowClick?: boolean): void;
+    protected _startCurrentDrag(clientX: number, sourceEvent: Event, pointerId?: number | null): void;
+    protected _moveCurrentDrag(clientX: number): void;
+    protected _stopCurrentDrag(): void;
+    protected _isClickGesture(clientX: number): boolean;
+    protected _setCurrentByClientX(clientX: number): Date;
+    protected _captureTouchPointer(e: PointerEvent): void;
+    protected _updateTouchPointer(e: PointerEvent): void;
+    protected _releaseTouchPointerCapture(pointerId: number): void;
+    protected _getFirstTouchPointer(): ITimelineTouchPointer | null;
+    protected _getTwoTouchPointers(): [ITimelineTouchPointer, ITimelineTouchPointer] | null;
+    protected _getTouchPointer(pointerId: number | null): ITimelineTouchPointer | null;
+    protected _getTouchDistance(t0: ITimelineTouchPointer, t1: ITimelineTouchPointer): number;
+    protected _startPinchGesture(t0: ITimelineTouchPointer, t1: ITimelineTouchPointer, sourceEvent: Event): void;
+    protected _movePinchGesture(t0: ITimelineTouchPointer, t1: ITimelineTouchPointer): void;
     protected _onMouseDown: (e: MouseEvent) => void;
     protected _onMouseUp: (e: MouseEvent) => void;
     protected _onMouseEnter: () => void;
     protected _onMouseOut: () => void;
     protected _onCurrentMouseEnter: () => void;
     protected _onCurrentMouseOut: () => void;
+    protected _onScalePointerDown: (e: PointerEvent) => void;
+    protected _onCurrentPointerDown: (e: PointerEvent) => void;
+    protected _onPointerMove: (e: PointerEvent) => void;
+    protected _onPointerUp: (e: PointerEvent) => void;
     protected _onMouseMove: (e: MouseEvent) => void;
     get clientWidth(): number;
     get clientHeight(): number;
     protected _resize(): void;
     getOffsetByTime(milliseconds: number): number;
+    protected _clearEvents(): void;
     remove(): void;
     protected _clearCanvas(): void;
     protected _drawCurrent(): void;

package/lib/control/visibleExtent/segment.d.ts

@@ -0,0 +1,7 @@
+import { ShaderProgram } from "../../webgl/ShaderProgram";
+export declare function segment_screen_nl(): ShaderProgram;
+export declare function segment_screen_wl(): ShaderProgram;
+export declare function segment_screen_wl_webgl2(): ShaderProgram;
+export declare function segment_colorPicking(): ShaderProgram;
+export declare function segment_heightPicking(): ShaderProgram;
+export declare function segment_depth(): ShaderProgram;

package/lib/ellipsoid/index.d.ts

@@ -1,4 +1,4 @@
-export * from './Ellipsoid';
-export * from './wgs84';
-export * from './mars';
-export * from './moon';
+export * from "./Ellipsoid";
+export * from "./wgs84";
+export * from "./mars";
+export * from "./moon";

package/lib/entity/Entity.d.ts

@@ -1,33 +1,31 @@
-import { Billboard } from "./Billboard";
-import { EntityCollection } from "./EntityCollection";
-import type { IBillboardParams } from "./Billboard";
+import { Billboard } from "./billboard/Billboard";
+import type { EntityCollection } from "./EntityCollection";
+import type { IBillboardParams } from "./billboard/Billboard";
 import type { EntityCollectionEvents } from "./EntityCollection";
 import { Extent } from "../Extent";
-import { Geometry } from "./Geometry";
-import { GeoObject } from "./GeoObject";
-import type { IGeometryParams } from "./Geometry";
-import type { IGeoObjectParams } from "./GeoObject";
+import { Geometry } from "./geometry/Geometry";
+import { GeoObject } from "./geoObject/GeoObject";
+import type { IGeometryParams } from "./geometry/Geometry";
+import type { IGeoObjectParams } from "./geoObject/GeoObject";
 import { LonLat } from "../LonLat";
-import { Label } from "./Label";
-import type { ILabelParams } from "./Label";
+import { Label } from "./label/Label";
+import type { ILabelParams } from "./label/Label";
 import { Vec3 } from "../math/Vec3";
 import type { NumberArray3 } from "../math/Vec3";
 import type { NumberArray2 } from "../math/Vec2";
-import { PointCloud } from "./PointCloud";
-import { Polyline } from "./Polyline";
-import type { IPointCloudParams } from "./PointCloud";
-import type { IPolylineParams } from "./Polyline";
-import { Ray } from "./Ray";
-import type { IRayParams } from "./Ray";
-import { Strip } from "./Strip";
-import type { IStripParams } from "./Strip";
-import { Vector } from "../layer/Vector";
-import type { VectorEventsType } from "../layer/Vector";
-import { EntityCollectionNode } from "../quadTree/EntityCollectionNode";
+import { PointCloud } from "./pointCloud/PointCloud";
+import { Polyline } from "./polyline/Polyline";
+import type { IPointCloudParams } from "./pointCloud/PointCloud";
+import type { IPolylineParams } from "./polyline/Polyline";
+import { Ray } from "./ray/Ray";
+import type { IRayParams } from "./ray/Ray";
+import { Strip } from "./strip/Strip";
+import type { IStripParams } from "./strip/Strip";
+import type { Vector, VectorEventsType } from "../layer/Vector";
+import type { EntityCollectionNode } from "../quadTree/EntityCollectionNode";
 import { Quat } from "../math/Quat";
 /**
- * Interface for Entity parameters.
- * @typedef {Object} IEntityParams
+ * Options for creating an {@link Entity}.
  * @property {string} [name] - Name of the entity.
  * @property {any} [properties] - Additional properties of the entity.
  * @property {Vec3 | NumberArray3} [cartesian] - Cartesian position.
@@ -43,13 +41,15 @@ import { Quat } from "../math/Quat";
  * @property {GeoObject | IGeoObjectParams} [geoObject] - Geo object or parameters.
  * @property {Strip | IStripParams} [strip] - Strip object or parameters.
  * @property {boolean} [independentPicking] - Independent picking flag.
- * @property {boolean} [relativePosition] - Parent relative position flag, otherwise position is absolute.
+ * @property {boolean} [relativePosition] - When `true`, the entity position is relative to its parent.
  * @property {number} [pitch] - Rotation around local X-axis.
  * @property {number} [yaw] - Rotation around local Y-axis.
  * @property {number} [roll] - Rotation around local Z-axis.
  * @property {number | Vec3 | NumberArray3} [scale] - Scaling factor.
- * @property {boolean} [forceGlobalPosition] - Forces global position for entity make the same position as its parent.
- * @property {boolean} [forceGlobalRotation] - Forces global rotation for the entity make the same rotation as its parent.
+ * @property {boolean} [forceGlobalPosition] - Forces the entity to use the same world position as its parent.
+ * @property {boolean} [forceGlobalRotation] - Forces the entity to use the same world rotation as its parent.
+ * @property {boolean} [forceGlobalScale] - Forces the entity to use the same world scale as its parent.
+ * @property {Vec3 | NumberArray3} [localPosition] - Local position offset.
  */
 export interface IEntityParams {
     name?: string;
@@ -78,11 +78,11 @@ export interface IEntityParams {
     localPosition?: Vec3 | NumberArray3;
 }
 /**
- * Entity instances aggregate multiple forms of visualization into a single high-level object.
- * They can be created manually and added to entity collection.
+ * Entity combines multiple visual features into one object.
+ * You can create it manually and add it to an entity collection.
  *
  * @class
- * @param {IEntityParams} [options] - Entity options:
+ * @param {IEntityParams} [options] - Entity options.
  * @param {string} [options.name] - Name of the entity.
  * @param {any} [options.properties] - Additional properties of the entity.
  * @param {Vec3 | NumberArray3} [options.cartesian] - Cartesian position.
@@ -98,26 +98,27 @@ export interface IEntityParams {
  * @param {GeoObject | IGeoObjectParams} [options.geoObject] - Geo object or parameters.
  * @param {Strip | IStripParams} [options.strip] - Strip object or parameters.
  * @param {boolean} [options.independentPicking] - Independent picking flag.
- * @param {boolean} [options.relativePosition] - Parent relative position flag, otherwise position is absolute.
+ * @param {boolean} [options.relativePosition] - When `true`, the entity position is relative to its parent.
  * @param {number} [options.pitch] - Rotation around local X-axis in radians.
  * @param {number} [options.yaw] - Rotation around local Y-axis in radians.
  * @param {number} [options.roll] - Rotation around local Z-axis in radians.
  * @param {number | Vec3 | NumberArray3} [options.scale] - Scaling factor.
- * @param {boolean} [options.forceGlobalPosition] - Forces global position for the entity make the same position as its parent.
- * @param {boolean} [options.forceGlobalRotation] - Forces global rotation for the entity make the same rotation as its parent.
- * @param {boolean} [options.forceGlobalScale] - Forces global scale for the entity make the same scale as its parent.
+ * @param {boolean} [options.forceGlobalPosition] - Forces the entity to use the same world position as its parent.
+ * @param {boolean} [options.forceGlobalRotation] - Forces the entity to use the same world rotation as its parent.
+ * @param {boolean} [options.forceGlobalScale] - Forces the entity to use the same world scale as its parent.
+ * @param {Vec3 | NumberArray3} [options.localPosition] - Local position offset.
  */
 declare class Entity {
     static __counter__: number;
     protected _name: string;
     /**
-     * Uniq identifier.
+     * Unique identifier.
      * @public
      * @readonly
      */
     protected __id: number;
     /**
-     * Entity user defined properties.
+     * User-defined entity properties.
      * @public
      * @type {Object}
      */
@@ -144,7 +145,7 @@ declare class Entity {
      */
     _cartesian: Vec3;
     /**
-     * Entity cartesian is equal root entity absolute cartesian.
+     * Absolute cartesian position of the root entity.
      * @protected
      * @type {Vec3}
      */
@@ -164,7 +165,7 @@ declare class Entity {
      */
     _lonLatMerc: LonLat;
     /**
-     * Entity visible terrain altitude.
+     * Entity altitude.
      * @public
      * @type {number}
      */
@@ -182,19 +183,19 @@ declare class Entity {
      */
     _entityCollection: EntityCollection | null;
     /**
-     * Entity collection array store index.
+     * Index of this entity in the collection array.
      * @public
      * @type {number}
      */
     _entityCollectionIndex: number;
     /**
-     * Assigned vector layer pointer.
+     * Assigned vector layer.
      * @public
      * @type {Vector}
      */
     _layer: Vector | null;
     /**
-     * Assigned vector layer entity array index.
+     * Index of this entity in the layer array.
      * @public
      * @type {number}
      */
@@ -232,21 +233,21 @@ declare class Entity {
      */
     ray: Ray | null;
     /**
-     * PointCloud entity.
+     * Point cloud entity.
      * @public
      * @type {PointCloud | null}
      */
     pointCloud: PointCloud | null;
     /**
-     * Geometry entity(available for vector layer only).
+     * Geometry entity (available only in vector layers).
      * @public
      * @type {Geometry | null}
      */
     geometry: Geometry | null;
     /**
-     * Geo object entity
+     * Geo object entity.
      * @public
-     * @type {Geometry | null}
+     * @type {GeoObject | null}
      */
     geoObject: GeoObject | null;
     /**
@@ -266,25 +267,26 @@ declare class Entity {
     protected _qRot: Quat;
     _absoluteQRot: Quat;
     protected _useDirectQuaternion: boolean;
+    protected _opacity: number | null;
     constructor(options?: IEntityParams);
     get name(): string;
     set name(name: string);
     get isEmpty(): boolean;
     /**
-     * Returns root entity object.
+     * Returns the root entity.
      * @public
-     * @return {Entity}
+     * @returns {Entity} Root entity.
      */
     get rootEntity(): Entity;
     /**
-     * Sets relative position property
-     * @param isRelative
+     * Sets whether the entity position is relative to its parent.
+     * @param {boolean} isRelative - Relative-position flag.
      */
     set relativePosition(isRelative: boolean);
     /**
-     * Gets relative position property
+     * Returns whether the entity position is relative to its parent.
      * @public
-     * @returns{boolean}
+     * @returns {boolean}
      */
     get relativePosition(): boolean;
     /**
@@ -294,7 +296,7 @@ declare class Entity {
      */
     get entityCollection(): EntityCollection | null;
     /**
-     * Gets entity uniq id
+     * Returns the entity id.
      * @public
      * @returns {number}
      */
@@ -311,8 +313,8 @@ declare class Entity {
      */
     get layerIndex(): number;
     /**
-     * Gets the instance class name of the entity.
-     * @returns {string} The instance name "Entity".
+     * Returns the instance class name.
+     * @returns {string} Always `"Entity"`.
      */
     get instanceName(): string;
     protected _createOptionFeature<T, K>(featureName: string, options?: T | K): T | null;
@@ -322,14 +324,14 @@ declare class Entity {
      */
     getCollectionIndex(): number;
     /**
-     * Adds current entity into the specified entity collection.
+     * Adds the entity to a collection or vector layer.
      * @public
-     * @param {EntityCollection | Vector} collection - Specified entity collection or vector layer.
-     * @returns {Entity} - This object.
+     * @param {EntityCollection | Vector} collection - Target collection or vector layer.
+     * @returns {Entity} This object.
      */
     addTo(collection: EntityCollection | Vector): Entity;
     /**
-     * Removes current entity from its collection or layer.
+     * Removes the entity from its collection or layer.
      * @public
      */
     remove(): this;
@@ -339,34 +341,46 @@ declare class Entity {
      * @param {boolean} visibility - Entity visibility.
      */
     setVisibility(visibility: boolean): void;
+    /**
+     * Sets entity opacity for all available features.
+     * @public
+     * @param {number} opacity - Entity opacity.
+     */
+    setOpacity(opacity: number): void;
+    /**
+     * Returns entity opacity.
+     * @public
+     * @returns {number} Entity opacity.
+     */
+    getOpacity(): number;
     /**
      * Returns entity visibility.
      * @public
-     * @returns {boolean} -
+     * @returns {boolean} Entity visibility flag.
      */
     getVisibility(): boolean;
     /**
      * Sets entity cartesian position.
      * @public
-     * @param {Vec3} cartesian - Cartesian position in 3d space.
+     * @param {Vec3} cartesian - Cartesian position in 3D space.
      */
     setCartesian3v(cartesian: Vec3): void;
     /**
-     * Gets scale factor
+     * Returns the local scale.
      * @public
      * @returns {Vec3}
      */
     getScale(): Vec3;
     /**
-     * Sets XYZ axis scale for the inner object such as GeoObject
+     * Sets per-axis local scale.
      * @public
-     * @param {Vec3} scale - Scale factor
+     * @param {Vec3} scale - Scale vector.
      */
     setScale3v(scale: Vec3): void;
     /**
-     * Sets scale for the inner object such as GeoObject
+     * Sets uniform local scale.
      * @public
-     * @param {number} val - Scale factor
+     * @param {number} val - Scale value.
      */
     setScale(val: number): void;
     /**
@@ -406,9 +420,9 @@ declare class Entity {
     setRotation(rot: Quat): void;
     /**
      * Sets rotation directly from glTF quaternion with common coordinate system conversion.
-     * This method avoids current pitch/yaw/roll airplane like conversion.
+     * This method avoids the current pitch/yaw/roll conversion.
      * @public
-     * @param {Quat} rot - Quaternion from glTF
+     * @param {Quat} rot - Quaternion from glTF.
      */
     setDirectQuaternionRotation(rot: Quat): void;
     /**
@@ -491,53 +505,53 @@ declare class Entity {
      */
     setAbsoluteCartesian(x: number, y: number, z: number): void;
     /**
-     * Sets the absolute cartesian position of the entity using a Vec3.
+     * Sets absolute cartesian position using a vector.
      * @public
-     * @param {Vec3} absolutCartesian - The absolute cartesian position.
+     * @param {Vec3} absolutCartesian - Absolute cartesian position.
      */
     setAbsoluteCartesian3v(absolutCartesian: Vec3): void;
     /**
      * Returns absolute cartesian position.
      * @public
-     * @returns {Vec3} -
+     * @returns {Vec3} Absolute cartesian position.
      */
     getAbsoluteCartesian(): Vec3;
     /**
-     * Sets entity cartesian position.
+     * Sets local cartesian position.
      * @public
-     * @param {number} x - 3d space X - position.
-     * @param {number} y - 3d space Y - position.
-     * @param {number} z - 3d space Z - position.
+     * @param {number} x - X coordinate in 3D space.
+     * @param {number} y - Y coordinate in 3D space.
+     * @param {number} z - Z coordinate in 3D space.
      */
     setCartesian(x: number, y: number, z: number): void;
     protected _updatePitchYawRoll(): void;
     _updateAbsolutePosition(): void;
     /**
-     * Sets entity cartesian position without event dispatching.
+     * Sets local cartesian position without dispatching events.
      * @public
-     * @param {Vec3} cartesian - Cartesian position in 3d space.
-     * @param {boolean} skipLonLat - skip geodetic calculation.
+     * @param {Vec3} cartesian - Cartesian position in 3D space.
+     * @param {boolean} skipLonLat - Skip geodetic conversion.
      */
     _setCartesian3vSilent(cartesian: Vec3, skipLonLat?: boolean): void;
     protected _updateLonLat(): void;
     /**
-     * Gets entity geodetic coordinates.
+     * Returns geodetic coordinates.
      * @public
-     * @returns {LonLat} -
+     * @returns {LonLat} Entity geodetic coordinates.
      */
     getLonLat(): LonLat;
     /**
-     * Sets geodetic coordinates of the entity point object.
+     * Sets geodetic coordinates.
      * @public
-     * @param {LonLat} lonlat - coordinates.
+     * @param {LonLat} lonlat - Geodetic coordinates.
      */
     setLonLat(lonlat: LonLat): void;
     /**
-     * Sets geodetic coordinates of the entity point object.
+     * Sets geodetic coordinates.
      * @public
      * @param {number} lon - Longitude.
-     * @param {number} lat - Latitude
-     * @param {number} [height] - Height
+     * @param {number} lat - Latitude.
+     * @param {number} [height] - Height.
      */
     setLonLat2(lon: number, lat: number, height?: number): void;
     /**
@@ -547,102 +561,102 @@ declare class Entity {
      */
     setAltitude(altitude: number): void;
     /**
-     * Sets entity altitude over the planet.
+     * Returns entity altitude over the planet.
      * @public
-     * @return {number} Altitude.
+     * @returns {number} Altitude.
      */
     getAltitude(): number;
     /**
      * Returns cartesian position.
      * @public
-     * @returns {Vec3} -
+     * @returns {Vec3} Cartesian position.
      */
     getCartesian(): Vec3;
     /**
      * Sets entity billboard.
      * @public
      * @param {Billboard} billboard - Billboard object.
-     * @returns {Billboard} -
+     * @returns {Billboard} Assigned billboard object.
      */
     setBillboard(billboard: Billboard): Billboard;
     /**
      * Sets entity label.
      * @public
      * @param {Label} label - Text label.
-     * @returns {Label} -
+     * @returns {Label} Assigned label object.
      */
     setLabel(label: Label): Label;
     /**
      * Sets entity ray.
      * @public
      * @param {Ray} ray - Ray object.
-     * @returns {Ray} -
+     * @returns {Ray} Assigned ray object.
      */
     setRay(ray: Ray): Ray;
     /**
      * Sets entity polyline.
      * @public
      * @param {Polyline} polyline - Polyline object.
-     * @returns {Polyline} -
+     * @returns {Polyline} Assigned polyline object.
      */
     setPolyline(polyline: Polyline): Polyline;
     /**
      * Sets entity pointCloud.
      * @public
      * @param {PointCloud} pointCloud - PointCloud object.
-     * @returns {PointCloud} -
+     * @returns {PointCloud} Assigned point cloud object.
      */
     setPointCloud(pointCloud: PointCloud): PointCloud;
     /**
      * Sets entity geometry.
      * @public
      * @param {Geometry} geometry - Geometry object.
-     * @returns {Geometry} -
+     * @returns {Geometry} Assigned geometry object.
      */
     setGeometry(geometry: Geometry): Geometry;
     /**
      * Sets entity geoObject.
      * @public
      * @param {GeoObject} geoObject - GeoObject.
-     * @returns {GeoObject} -
+     * @returns {GeoObject} Assigned geo object.
      */
     setGeoObject(geoObject: GeoObject): GeoObject;
     /**
      * Sets entity strip.
      * @public
      * @param {Strip} strip - Strip object.
-     * @returns {Strip} -
+     * @returns {Strip} Assigned strip object.
      */
     setStrip(strip: Strip): Strip;
     /**
-     * Gets layer container
+     * Returns the assigned vector layer.
      * @public
      * @returns {Vector | null}
      */
     get layer(): Vector | null;
     get rendererEvents(): VectorEventsType | EntityCollectionEvents | null;
     /**
-     * Append child entity.
+     * Appends child entities.
      * @public
      * @param {Entity[]} entities - Child entities.
-     * @param {boolean} [forceRelativePosition] - Force relative position property.
+     * @param {boolean} [forceRelativePosition] - If defined, sets `relativePosition` for each child.
      */
     appendChildren(entities: Entity[], forceRelativePosition?: boolean): void;
     /**
-     * Append child entity.
+     * Appends a child entity.
      * @public
      * @param {Entity} entity - Child entity.
      */
     appendChild(entity: Entity): void;
     /**
-     * Appends entity items(billboard, label etc.) picking color.
+     * Applies entity picking color to all supported features.
      * @public
      */
     setPickingColor(): void;
     /**
-     * Return geodetic extent.
+     * Returns geodetic extent.
      * @public
-     * @returns {Extent} -
+     * @returns {Extent} Geodetic extent.
      */
     getExtent(): Extent;
 }