Add fill-extrude-height, fill-extrude-base, and light root property

docs/_generate/item.html

@@ -31,6 +31,8 @@
           } else {
             if (req['!']) {
               return '<em>Disabled by</em> <var>' + req['!'] + '</var>.';
+            } else if (req['<=']) {
+              return '<em>Must be less than or equal to</em> <var>' + req['<='] + '</var>.';
             } else {
               var requiredValue = _.toPairs(req)[0][1];
               var requiredDisplay = _.isArray(requiredValue)

lib/diff.js

@@ -87,7 +87,12 @@ var operations = {
     /*
      * { command: 'setTransition', args: [transition] }
      */
-    setTransition: 'setTransition'
+    setTransition: 'setTransition',
+
+    /*
+     * { command: 'setLighting', args: [lightProperties] }
+     */
+    setLight: 'setLight'
 
 };
 
@@ -292,6 +297,9 @@ function diffStyles(before, after) {
         if (!isEqual(before.transition, after.transition)) {
             commands.push({ command: operations.setTransition, args: [after.transition] });
         }
+        if (!isEqual(before.light, after.light)) {
+            commands.push({ command: operations.setLight, args: [after.light] });
+        }
         diffSources(before.sources, after.sources, commands);
         diffLayers(before.layers, after.layers, commands);
     } catch (e) {

lib/validate/validate_light.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var ValidationError = require('../error/validation_error');
+var getType = require('../util/get_type');
+var validate = require('./validate');
+var validateTypes = {
+    enum: require('./validate_enum'),
+    color: require('./validate_color'),
+    array: require('./validate_array'),
+    number: require('./validate_number'),
+    function: require('./validate_function')
+};
+
+module.exports = function validateLight(options) {
+    var light = options.value;
+    var styleSpec = options.styleSpec;
+    var lightSpec = styleSpec.$root.light;
+    var style = options.style;
+
+    var errors = [];
+
+    var type;
+    for (var key in light) {
+        var transitionMatch = key.match(/^(.*)-transition$/);
+
+        if (transitionMatch && lightSpec[transitionMatch[1]] && lightSpec[transitionMatch[1]].transition) {
+            var baseKey = transitionMatch[1];
+
+            type = lightSpec[baseKey].type;
+            errors = errors.concat(validate({
+                key: key,
+                value: light[key],
+                valueSpec: styleSpec.transition,
+                style: style,
+                styleSpec: styleSpec
+            }));
+        } else if (lightSpec[key]) {
+            type = lightSpec[key].type;
+            if (lightSpec[key].function && getType(light[key]) === 'object') type = 'function';
+            errors = errors.concat(validateTypes[type]({
+                key: key,
+                value: light[key],
+                valueSpec: lightSpec[key],
+                style: style,
+                styleSpec: styleSpec
+            }));
+        } else {
+            errors = errors.concat([new ValidationError(key, light[key], 'unknown property "%s"', key)]);
+        }
+    }
+
+    return errors;
+};

lib/validate_style.js

@@ -36,6 +36,7 @@ module.exports = function validateStyle(style, styleSpec) {
 };
 
 exports.source = validateStyleMin.source;
+exports.light = validateStyleMin.light;
 exports.layer = validateStyleMin.layer;
 exports.filter = validateStyleMin.filter;
 exports.paintProperty = validateStyleMin.paintProperty;

lib/validate_style.min.js

@@ -48,6 +48,7 @@ function validateStyleMin(style, styleSpec) {
 }
 
 validateStyleMin.source = wrapCleanErrors(require('./validate/validate_source'));
+validateStyleMin.light = wrapCleanErrors(require('./validate/validate_light'));
 validateStyleMin.layer = wrapCleanErrors(require('./validate/validate_layer'));
 validateStyleMin.filter = wrapCleanErrors(require('./validate/validate_filter'));
 validateStyleMin.paintProperty = wrapCleanErrors(require('./validate/validate_paint_property'));

reference/v8.json

@@ -43,6 +43,55 @@
       "doc": "Default pitch, in degrees. Zero is perpendicular to the surface, for a look straight down at the map, while a greater value like 60 looks ahead towards the horizon. The style pitch will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
       "example": 50
     },
+    "light": {
+      "anchor": {
+        "type": "enum",
+        "default": "viewport",
+        "values": {
+          "map": {
+            "doc": "The position of the light source is aligned to the rotation of the map."
+          },
+          "viewport": {
+            "doc": "The position of the light source is aligned to the rotation of the viewport."
+          }
+        },
+        "transition": false,
+        "doc": "Whether extruded geometries are lit relative to the map or viewport.",
+        "example": "map"
+      },
+      "position": {
+        "type": "array",
+        "default": [1.15, 210, 30],
+        "length": 3,
+        "value": "number",
+        "transition": true,
+        "function": "interpolated",
+        "zoom-function": true,
+        "property-function": false,
+        "doc": "Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when `light.anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `light.anchor` is set to `map` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).",
+        "example": [1.5, 90, 80]
+      },
+      "color": {
+        "type": "color",
+        "default": "#ffffff",
+        "function": "interpolated",
+        "zoom-function": true,
+        "property-function": false,
+        "transition": true,
+        "doc": "Color tint for lighting extruded geometries."
+      },
+      "intensity": {
+        "type": "number",
+        "default": 0.5,
+        "minimum": 0,
+        "maximum": 1,
+        "function": "interpolated",
+        "zoom-function": true,
+        "property-function": false,
+        "transition": true,
+        "doc": "Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast."
+      }
+    },
     "sources": {
       "required": true,
       "type": "sources",
@@ -1513,7 +1562,7 @@
       "default": 1,
       "minimum": 0,
       "maximum": 1,
-      "doc": "The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used.",
+      "doc": "The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used. If a fill layer is extruded, opacity will be per-layer rather than per-feature (and will thus not support property functions).",
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -1638,6 +1687,31 @@
           "android": "2.0.1"
         }
       }
+    },
+    "fill-extrude-height": {
+      "type": "number",
+      "function": "interpolated",
+      "zoom-function": true,
+      "property-function": true,
+      "default": 0,
+      "minimum": 0,
+      "doc": "The height with which to extrude this fill layer.",
+      "transition": true
+    },
+    "fill-extrude-base": {
+      "type": "number",
+      "function": "interpolated",
+      "zoom-function": true,
+      "property-function": true,
+      "default": 0,
+      "minimum": 0,
+      "doc": "The height with which to extrude the base of this layer.",
+      "transition": true,
+      "requires": [
+        {
+          "<=": "fill-extrude-height"
+        }
+      ]
     }
   },
   "paint_line": {

test/diff.js

@@ -153,5 +153,77 @@ t('diff', function (t) {
       { command: 'setPitch', args: [1] }
     ], 'pitch change');
 
+    t.deepEqual(diffStyles({
+        light: {
+            anchor: 'map',
+            color: 'white',
+            position: [0, 1, 0],
+            intensity: 1
+        }
+    }, {
+        light: {
+            anchor: 'map',
+            color: 'white',
+            position: [0, 1, 0],
+            intensity: 1
+        }
+    }), [
+    ], 'light no change');
+
+    t.deepEqual(diffStyles({
+        light: { anchor: 'map' }
+    }, {
+        light: { anchor: 'viewport' }
+    }), [
+      { command: 'setLight', args: [{'anchor': 'viewport'}] }
+    ], 'light anchor change');
+
+    t.deepEqual(diffStyles({
+        light: { color: 'white' }
+    }, {
+        light: { color: 'red' }
+    }), [
+      { command: 'setLight', args: [{'color': 'red'}] }
+    ], 'light color change');
+
+    t.deepEqual(diffStyles({
+        light: { position: [0, 1, 0] }
+    }, {
+        light: { position: [1, 0, 0] }
+    }), [
+      { command: 'setLight', args: [{'position': [1, 0, 0]}] }
+    ], 'light position change');
+
+    t.deepEqual(diffStyles({
+        light: { intensity: 1 }
+    }, {
+        light: { intensity: 10 }
+    }), [
+      { command: 'setLight', args: [{'intensity': 10}] }
+    ], 'light intensity change');
+
+    t.deepEqual(diffStyles({
+        light: {
+            anchor: 'map',
+            color: 'orange',
+            position: [2, 80, 30],
+            intensity: 1.0
+        }
+    }, {
+        light: {
+            anchor: 'map',
+            color: 'red',
+            position: [1, 40, 30],
+            intensity: 1.0
+        }
+    }), [
+      { command: 'setLight', args: [{
+            anchor: 'map',
+            color: 'red',
+            position: [1, 40, 30],
+            intensity: 1.0
+      }] }
+    ], 'multiple light properties change');
+
     t.end();
 });

test/fixture/light.input.json

@@ -0,0 +1,16 @@
+{
+  "version": 8,
+  "sources": {
+    "vector": {
+      "type": "vector",
+      "url": "mapbox://mapbox.mapbox-streets-v5"
+    }
+  },
+  "light": {
+    "anchor": true,
+    "position": [1, 2],
+    "color": [255, 255, 255, 1],
+    "intensity": 1.5
+  },
+  "layers": []
+}

test/fixture/light.output.json

@@ -0,0 +1,18 @@
+[
+  {
+    "message": "light.anchor: expected one of [map, viewport], true found",
+    "line": 10
+  },
+  {
+    "message": "light.position: array length 3 expected, length 2 found",
+    "line": 11
+  },
+  {
+    "message": "light.color: color expected, array found",
+    "line": 12
+  },
+  {
+    "message": "light.intensity: 1.5 is greater than the maximum value 1",
+    "line": 13
+  }
+]

test/fixture/root-properties.input.json

@@ -7,5 +7,6 @@
   "modified": "",
   "name": "Test",
   "owner": "peterqliu",
-  "id": "peterqliu.test"
+  "id": "peterqliu.test",
+  "light": true
 }

test/fixture/root-properties.output.json

@@ -14,5 +14,9 @@
   {
     "message": "layers: array expected, object found",
     "line": 5
+  },
+  {
+    "message": "light: object expected, boolean found",
+    "line": 11
   }
 ]