Source: formats/geojson/GeoJSONGeometryCollection.js

  1. /*
  2.  * Copyright 2003-2006, 2009, 2017, 2020 United States Government, as represented
  3.  * by the Administrator of the National Aeronautics and Space Administration.
  4.  * All rights reserved.
  5.  *
  6.  * The NASAWorldWind/WebWorldWind platform is licensed under the Apache License,
  7.  * Version 2.0 (the "License"); you may not use this file except in compliance
  8.  * with the License. You may obtain a copy of the License
  9.  * at http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software distributed
  12.  * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  13.  * CONDITIONS OF ANY KIND, either express or implied. See the License for the
  14.  * specific language governing permissions and limitations under the License.
  15.  *
  16.  * NASAWorldWind/WebWorldWind also contains the following 3rd party Open Source
  17.  * software:
  18.  *
  19.  *    ES6-Promise – under MIT License
  20.  *    libtess.js – SGI Free Software License B
  21.  *    Proj4 – under MIT License
  22.  *    JSZip – under MIT License
  23.  *
  24.  * A complete listing of 3rd Party software notices and licenses included in
  25.  * WebWorldWind can be found in the WebWorldWind 3rd-party notices and licenses
  26.  * PDF found in code  directory.
  27.  */
  28. /**
  29.  * @exports GeoJSONGeometryCollection
  30.  */
  31. define(['../../error/ArgumentError',
  32.         './GeoJSONConstants',
  33.         '../../util/Logger'
  34.     ],
  35.     function (ArgumentError,
  36.               GeoJSONConstants,
  37.               Logger) {
  38.         "use strict";
  40.         /**
  41.          * Constructs a GeoJSON geometry for a GeometryCollection. Applications typically do not call this constructor.
  42.          * It is called by {@link GeoJSON} as GeoJSON geometries are read.
  43.          * @alias GeoJSONGeometryCollection
  44.          * @constructor
  45.          * @classdesc Contains the data associated with a GeoJSON GeometryCollection geometry.
  46.          * A geometry collection must have a member with the name "geometries".
  47.          * The value corresponding to "geometries" is an array. Each element in this array is a GeoJSON
  48.          * geometry object. To include information on the coordinate range for features, a GeoJSON object may have a
  49.          * member named "bbox".
  50.          * @param {Object} geometries An array containing GeoJSONGeometry objects.
  51.          * @param {Object} bbox An object containing the value of GeoJSON GeometryCollection bbox member.
  52.          * @throws {ArgumentError} If the specified mandatory geometries is null or undefined or if the geometries
  53.          * parameter is not an array of GeoJSONGeometry.
  54.          */
  55.         var GeoJSONGeometryCollection = function (geometries, bbox) {
  56.             if (!geometries) {
  57.                 throw new ArgumentError(
  58.                     Logger.logMessage(Logger.LEVEL_SEVERE, "GeoJSONGeometryCollection", "constructor",
  59.                         "missingGeometries"));
  60.             }
  62.             if (Object.prototype.toString.call(geometries) !== '[object Array]') {
  63.                 throw new ArgumentError(
  64.                     Logger.logMessage(Logger.LEVEL_SEVERE, "GeoJSONGeometryCollection", "constructor",
  65.                         "invalidGeometries"));
  66.             }
  68.             // Documented in defineProperties below.
  69.             this._geometries = geometries;
  71.             // Documented in defineProperties below.
  72.             this._bbox = bbox;
  73.         };
  75.         Object.defineProperties(GeoJSONGeometryCollection.prototype, {
  76.             /**
  77.              * The GeoJSON GeometryCollection geometries as specified to this GeoJSON GeometryCollection's constructor.
  78.              * @memberof GeoJSONGeometryCollection.prototype
  79.              * @type {Object}
  80.              * @readonly
  81.              */
  82.             geometries: {
  83.                 get: function () {
  84.                     return this._geometries;
  85.                 }
  86.             },
  88.             /**
  89.              * The GeoJSON GeometryCollection bbox member as specified to this GeoJSONGeometryCollection's constructor.
  90.              * @memberof GeoJSONGeometryCollection.prototype
  91.              * @type {Object}
  92.              * @readonly
  93.              */
  94.             bbox: {
  95.                 get: function () {
  96.                     return this._bbox;
  97.                 }
  98.             }
  99.         });
  101.         return GeoJSONGeometryCollection;
  102.     }
  103. );