Source: formats/kml/controls/KmlTreeVisibility.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. define([
  29.     '../../../util/WWUtil',
  30.     './KmlControls'
  31. ], function (WWUtil,
  32.              KmlControls
  33.     ) {
  34.     "use strict";
  36.     /**
  37.      * This class represents the structure of Documents, Folders and Features in the document. It renders them into
  38.      * some of the outside area with defined classes, so that user can specify the look and feel.
  39.      * Important part of this effort is to allow user show/hide subset of the Features present in the document.
  40.      * Implementing this functionality also simplifies the manual testing.
  41.      * @param visualElementId {String} Id of the element into which this will be rendered.
  42.      * @param wwd {WorldWindow} WorldWindow instance necessary to control the redraw in the framework.
  43.      * @constructor
  44.      * @augments KmlControls
  45.      * @alias KmlTreeVisibility
  46.      * @classdesc Class for controlling the visibility of features.
  47.      */
  48.     var KmlTreeVisibility = function (visualElementId, wwd) {
  49.         KmlControls.apply(this);
  51.         this._visualElementId = visualElementId;
  52.         this._wwd = wwd;
  53.     };
  55.     KmlTreeVisibility.prototype = Object.create(KmlControls.prototype);
  57.     /**
  58.      * @inheritDoc
  59.      */
  60.     KmlTreeVisibility.prototype.hook = function (node, options) {
  61.         if(options.isFeature) {
  62.             this.createControls(node);
  63.         }
  64.     };
  66.     // For internal use only.
  67.     KmlTreeVisibility.prototype.createControls = function (node) {
  68.         var name = node.kmlName || node.id || WWUtil.guid();
  69.         var enabled = node.enabled && node.kmlVisibility === true;
  71.         var controlsForSingleElement = document.createElement("div");
  73.         var toggleVisibility = document.createElement("input");
  74.         toggleVisibility.setAttribute("type", "checkbox");
  75.         if (enabled) {
  76.             toggleVisibility.setAttribute("checked", "checked");
  77.         }
  78.         toggleVisibility.addEventListener("click", toggleVisibilityOfElement, true);
  80.         controlsForSingleElement.appendChild(toggleVisibility);
  82.         var lookAtName;
  83.         if (node.kmlAbstractView) {
  84.             lookAtName = document.createElement("a");
  85.         } else {
  86.             lookAtName = document.createElement("span");
  87.         }
  88.         lookAtName.appendChild(document.createTextNode(name));
  89.         lookAtName.addEventListener("click", lookAt, true);
  91.         controlsForSingleElement.appendChild(lookAtName);
  93.         document.getElementById(this._visualElementId).appendChild(controlsForSingleElement);
  95.         var self = this;
  97.         function toggleVisibilityOfElement() {
  98.             enabled = !enabled;
  99.             self.updateDescendants(node, enabled);
  100.         }
  102.         function lookAt() {
  103.             if (node.kmlAbstractView) {
  104.                 node.kmlAbstractView.update({wwd: self._wwd});
  105.             }
  106.         }
  107.     };
  109.     // Internal use only. Updates all descendants of given Feature.
  110.     KmlTreeVisibility.prototype.updateDescendants = function (node, enabled) {
  111.         node.controlledVisibility = enabled;
  112.         this._wwd.redraw();
  113.     };
  115.     return KmlTreeVisibility;
  116. });