Source: formats/kml/styles/KmlStyle.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/Color',
  30.     '../../../util/Font',
  31.     './KmlStyleSelector',
  32.     './../KmlElements',
  33.     './KmlPolyStyle',
  34.     './KmlIconStyle',
  35.     './KmlLabelStyle',
  36.     './KmlLineStyle',
  37.     './KmlListStyle',
  38.     './KmlBalloonStyle',
  39.     '../../../util/Offset',
  40.     '../../../util/Promise',
  41.     '../../../shapes/ShapeAttributes',
  42.     '../../../shapes/TextAttributes'
  43. ], function (
  44.     Color,
  45.     Font,
  46.     KmlStyleSelector,
  47.     KmlElements,
  48.     KmlPolyStyle,
  49.     KmlIconStyle,
  50.     KmlLabelStyle,
  51.     KmlLineStyle,
  52.     KmlListStyle,
  53.     KmlBalloonStyle,
  54.     Offset,
  55.     Promise,
  56.     ShapeAttributes,
  57.     TextAttributes
  58. ) {
  59.     "use strict";
  61.     /**
  62.      * Constructs an KmlStyle. Application usually don't call this constructor. It is called by {@link KmlFile} as
  63.      * Objects from KmlFile are read. It is concrete implementation.
  64.      * Style can contain any amount of different styles. At most one from each of these styles.
  65.      * Possible children styles: IconStyle, LabelStyle, LineStyle, PolyStyle, BalloonStyle
  66.      * @alias KmlStyle
  67.      * @constructor
  68.      * @classdesc Contains the data associated with Kml style
  69.      * @param options {Object}
  70.      * @param options.objectNode {Node} Node representing the Kml style.
  71.      * @throws {ArgumentError} If either the node is null or undefined.
  72.      * @see https://developers.google.com/kml/documentation/kmlreference#style
  73.      * @augments KmlStyleSelector
  74.      */
  75.     var KmlStyle = function (options) {
  76.         KmlStyleSelector.call(this, options);
  77.     };
  79.     KmlStyle.prototype = Object.create(KmlStyleSelector.prototype);
  81.     Object.defineProperties(KmlStyle.prototype, {
  82.         /**
  83.          * Style used for icons in current node and all children nodes.
  84.          * @memberof KmlStyle.prototype
  85.          * @readonly
  86.          * @type {KmlIconStyle|null}
  87.          */
  88.         kmlIconStyle: {
  89.             get: function() {
  90.                 return this._factory.any(this, {
  91.                     name: KmlIconStyle.prototype.getTagNames()
  92.                 });
  93.             }
  94.         },
  96.         /**
  97.          * Style used for labels in current node and all children nodes.
  98.          * @memberof KmlStyle.prototype
  99.          * @readonly
  100.          * @type {KmlLabelStyle|null}
  101.          */
  102.         kmlLabelStyle: {
  103.             get: function() {
  104.                 return this._factory.any(this, {
  105.                     name: KmlLabelStyle.prototype.getTagNames()
  106.                 });
  107.             }
  108.         },
  110.         /**
  111.          * Style used for line in current node and all children nodes.
  112.          * @memberof KmlStyle.prototype
  113.          * @readonly
  114.          * @type {KmlLineStyle|null}
  115.          */
  116.         kmlLineStyle: {
  117.             get: function() {
  118.                 return this._factory.any(this, {
  119.                     name: KmlLineStyle.prototype.getTagNames()
  120.                 });
  121.             }
  122.         },
  124.         /**
  125.          * Style used for polygon in current node and all children nodes.
  126.          * @memberof KmlStyle.prototype
  127.          * @readonly
  128.          * @type {KmlPolyStyle|null}
  129.          */
  130.         kmlPolyStyle: {
  131.             get: function() {
  132.                 return this._factory.any(this, {
  133.                     name: KmlPolyStyle.prototype.getTagNames()
  134.                 });
  135.             }
  136.         },
  138.         /**
  139.          * Style used for balloons in current node and all children nodes.
  140.          * @memberof KmlStyle.prototype
  141.          * @readonly
  142.          * @type {KmlBalloonStyle|null}
  143.          */
  144.         kmlBalloonStyle: {
  145.             get: function() {
  146.                 return this._factory.any(this, {
  147.                     name: KmlBalloonStyle.prototype.getTagNames()
  148.                 });
  149.             }
  150.         },
  152.         /**
  153.          * Style used for lists in current node and all children nodes.
  154.          * @memberof KmlStyle.prototype
  155.          * @readonly
  156.          * @type {KmlListStyle|null}
  157.          */
  158.         kmlListStyle: {
  159.             get: function() {
  160.                 return this._factory.any(this, {
  161.                     name: KmlListStyle.prototype.getTagNames()
  162.                 });
  163.             }
  164.         }
  165.     });
  167.     KmlStyle.prototype.generate = function(options, fileCache) {
  168.         options = options || {};
  169.         var style = this || {};
  171.         if(style.kmlIconStyle) {
  172.             KmlIconStyle.update(style.kmlIconStyle, options, fileCache);
  173.         }
  174.         if(style.kmlListStyle) {
  175.             KmlListStyle.update(style.kmlListStyle, options);
  176.         }
  177.         if(style.kmlBalloonStyle) {
  178.             KmlBalloonStyle.update(style.kmlBalloonStyle, options);
  179.         }
  180.         if(style.kmlLabelStyle) {
  181.             KmlLabelStyle.update(style.kmlLabelStyle, options);
  182.         }
  183.         if(style.kmlPolyStyle) {
  184.             KmlPolyStyle.update(style.kmlPolyStyle, options);
  185.         }
  186.         if(style.kmlLineStyle) {
  187.             KmlLineStyle.update(style.kmlLineStyle, options);
  188.         }
  190.         return options;
  191.     };
  193.     /**
  194.      * @inheritDoc
  195.      */
  196.     KmlStyle.prototype.getStyle = function() {
  197.         var self = this;
  198.         return new Promise(function(resolve){
  199.             window.setTimeout(function(){
  200.                 resolve(self);
  201.             }, 0);
  202.         });
  203.     };
  205.     /**
  206.      * @inheritDoc
  207.      */
  208.     KmlStyle.prototype.getTagNames = function () {
  209.         return ['Style'];
  210.     };
  212.     KmlElements.addKey(KmlStyle.prototype.getTagNames()[0], KmlStyle);
  214.     /**
  215.      * Prepare default values for the placemark Attributes.
  216.      * @param attributes
  217.      * @returns {Object}
  218.      */
  219.     KmlStyle.placemarkAttributes = function(attributes) {
  220.         attributes = attributes || {};
  221.         // These are all documented with their property accessors below.
  222.         attributes._imageColor = attributes._imageColor || new Color(1, 1, 1, 1);
  223.         attributes._imageOffset = attributes._imageOffset||
  224.             new Offset(WorldWind.OFFSET_FRACTION, 0.5, WorldWind.OFFSET_FRACTION, 0.5);
  225.         attributes._imageScale = attributes._imageScale || 1;
  226.         attributes._imageSource = attributes._imageSource || null;
  227.         attributes._depthTest = attributes._depthTest || true;
  228.         attributes._labelAttributes = attributes._labelAttributes || new TextAttributes(KmlStyle.textAttributes());
  229.         attributes._drawLeaderLine = attributes._drawLeaderLine || false;
  230.         attributes._leaderLineAttributes = attributes._leaderLineAttributes || new ShapeAttributes(KmlStyle.shapeAttributes());
  232.         return attributes;
  233.     };
  235.     /**
  236.      * Prepare default values for text attributes
  237.      * @param attributes
  238.      * @returns {Object}
  239.      */
  240.     KmlStyle.textAttributes = function(attributes) {
  241.         attributes = attributes || {};
  242.         attributes._color = attributes._color || new Color(1, 1, 1, 1);
  243.         attributes._font = attributes._font || new Font(14);
  244.         attributes._offset = attributes._offset || new Offset(WorldWind.OFFSET_FRACTION, 0.5, WorldWind.OFFSET_FRACTION, 0.0);
  245.         attributes._scale = attributes._scale || 1;
  246.         attributes._depthTest = attributes._depthTest || false;
  247.         attributes._outlineColor = attributes._outlineColor || Color.RED;
  249.         return attributes;
  250.     };
  252.     /**
  253.      * Prepare default values for shape attributes
  254.      * @param attributes
  255.      * @returns {*|{}}
  256.      */
  257.     KmlStyle.shapeAttributes = function(attributes) {
  258.         attributes = attributes || {};
  259.         // All these are documented with their property accessors below.
  260.         attributes._drawInterior = attributes._drawInterior || true;
  261.         attributes._drawOutline = attributes._drawOutline || true;
  262.         attributes._enableLighting = attributes._enableLighting || false;
  263.         attributes._interiorColor = attributes._interiorColor || Color.WHITE;
  264.         attributes._outlineColor = attributes._outlineColor || Color.RED;
  265.         attributes._outlineWidth = attributes._outlineWidth || 1.0;
  266.         attributes._outlineStippleFactor = attributes._outlineStippleFactor || 0;
  267.         attributes._outlineStipplePattern = attributes._outlineStipplePattern || 0xF0F0;
  268.         attributes._imageSource = attributes._imageSource || null;
  269.         attributes._depthTest = attributes._depthTest || true;
  270.         attributes._drawVerticals = attributes._drawVerticals || false;
  271.         attributes._applyLighting = attributes._applyLighting || false;
  273.         return attributes;
  274.     };
  276.     /**
  277.      * It returns default KmlStyle, which doesn't contain any custom information.
  278.      * @returns {KmlStyle}
  279.      */
  280.     KmlStyle.default = function() {
  281.         return new KmlStyle({
  282.             objectNode: document.createElement('Style')
  283.         });
  284.     };
  286.     return KmlStyle;
  287. });