Heatmap layer #11046

mourner · 2018-01-25T11:15:47Z

Closes #10146. Remaining things:

friedbunny · 2018-01-25T16:32:26Z

Looks like the current build issues on iOS can be fixed by adding MGLHeatmapStyleLayer.h/m to the framework targets in the iOS project — see these instructions.

kkaefer · 2018-01-26T01:02:37Z

src/mbgl/gl/context.hpp

@@ -144,6 +144,8 @@ class Context : private util::noncopyable {
        return { size, createTexture(size, nullptr, format, unit) };
    }

+    UniqueTexture createTexture(Size size, const void* data, TextureFormat, TextureUnit);


I'd prefer if we kept this method private and use a more high level createTexture call instead.

kkaefer · 2018-01-26T01:03:37Z

include/mbgl/style/conversion/heatmap_color_property_value.hpp

+        if (isUndefined(value)) {
+            return HeatmapColorPropertyValue();
+        } else if (isExpression(value)) {
+            optional<std::unique_ptr<Expression>> expression = convert<std::unique_ptr<Expression>>(value, error, expression::type::Color);


Can the unique_ptr in this optional be ever be empty? If so, we should check for that to avoid null dereferences further down.

It should never be null (we use the optional to represent parsing failure). It's a bug rather than a recoverable failure if the pointer is null, so if we want to check here, it should be with an assert

kkaefer · 2018-01-26T01:03:46Z

include/mbgl/style/conversion/heatmap_color_property_value.hpp

+} // namespace conversion
+} // namespace style
+} // namespace mbgl
+


Nit: stray whitespace

kkaefer · 2018-01-26T01:04:33Z

include/mbgl/style/layer_type.hpp

@@ -13,6 +13,7 @@ enum class LayerType {
    Background,
    Custom,
    FillExtrusion,
+    Heatmap


Nit: let's add trailing commas

kkaefer · 2018-01-26T01:05:15Z

platform/darwin/scripts/generate-style-code.js

@@ -414,6 +414,7 @@ global.describeValue = function (value, property, layerType) {
            }
            return displayValue;
        case 'color':
+            if (property.name === 'heatmap-color') value = 'red';


TODO: remove this before merging

kkaefer · 2018-01-26T01:06:26Z

platform/darwin/src/MGLStyle.mm

@@ -214,7 +216,7 @@ - (MGLSource *)memberOfSources:(MGLSource *)object {
 - (MGLSource *)sourceWithIdentifier:(NSString *)identifier
 {
    auto rawSource = self.rawStyle->getSource(identifier.UTF8String);
-    
+


Let's remove all of these whitespace changes. The convention for Objective-C files (and Xcode's default formatting behavior) is to indent empty lines like the last block.

Is there any way to format whitespace of a whole file according Xcode conventions? Adding those back by hand will be super-tedious... (update: nevermind, updated manually since most of the updated files have mixed indentation)

Editor ‣ Structure ‣ Re-Indent (⌃I) reindents the selection. You can use it on wide swaths of the code, but probably not the entire file, because the file contains some hand-indented macros.

kkaefer · 2018-01-26T01:07:50Z

platform/node/src/node_map.cpp

@@ -529,7 +530,7 @@ void NodeMap::release() {
    uv_close(reinterpret_cast<uv_handle_t *>(async), [] (uv_handle_t *h) {
        delete reinterpret_cast<uv_async_t *>(h);
    });
-    
+


Let's try to remove whitespace changes to make this PR less unwieldy.

kkaefer · 2018-01-26T01:08:10Z

scripts/style-spec.js

@@ -1,5 +1 @@
 var spec = module.exports = require('../mapbox-gl-js/src/style-spec/reference/v8');
-
-// Make temporary modifications here when Native doesn't have all features that JS has.


Please keep this comment

kkaefer · 2018-01-26T01:09:26Z

src/mbgl/renderer/buckets/heatmap_bucket.cpp

+    } else {
+        return *it->second.statistics<Property>().max();
+    }
+}


We don't need this function

What is the function for, and why do we need it for circle layer then? The code isn't very clear about its purpose...

In CircleBucket, it's an internal helper that's used by getQueryRadius. You're right, it should have a clarifying comment.

kkaefer · 2018-01-26T01:11:55Z

src/mbgl/renderer/layers/render_heatmap_layer.cpp

+
+        if (!colorRampTexture) {
+            const auto colorRampSize = Size{256, 1};
+            colorRampTexture = gl::Texture{colorRampSize, parameters.context.createTexture(colorRampSize, colorRamp.data(), gl::TextureFormat::RGBA, 1)};


Let's use context.createTexture(...) instead of directly initializing a gl::Texture object

kkaefer · 2018-01-26T17:16:34Z

src/mbgl/renderer/layers/render_heatmap_layer.hpp

+
+    const style::HeatmapLayer::Impl& impl() const;
+
+    std::array<uint8_t, 1024> colorRamp;


Let's use an AlphaImage instead of a plain std::array. The image stores it's dimensions internally and allows us to use it without changing the Context::createTexture API. This is the same pattern that we're also using for the LineAtlas:

mapbox-gl-native/src/mbgl/geometry/line_atlas.hpp

Line 48 in f075cdb

const AlphaImage image;

and

mapbox-gl-native/src/mbgl/geometry/line_atlas.cpp

Lines 124 to 132 in f075cdb

void LineAtlas::upload(gl::Context& context, gl::TextureUnit unit) {

if (!texture) {

texture = context.createTexture(image, unit);

} else if (dirty) {

context.updateTexture(*texture, image, unit);

}

dirty = false;

}

1ec5 · 2018-01-27T07:38:06Z

platform/darwin/src/MGLHeatmapStyleLayer.h

+
+ You can set this property to an expression containing any of the following:
+
+ * Constant numeric values


FYI, the next time we merge the release-boba branch to master, we’ll need to rerun make darwin-style-code so that #11018 can mention the minimum value here.

1ec5 · 2018-01-27T10:59:58Z

#11074 and #11075 take care of various changes needed to make this feature work on iOS and macOS.

1ec5 · 2018-02-07T16:58:16Z

platform/darwin/src/MGLHeatmapStyleLayer.h

+ * Interpolation and step functions applied to the `$heatmapDensity` variable
+
+ This property does not support applying interpolation or step functions to
+ feature attributes.


Apparently this property does support data-driven styling, but the codegen script inserts this line because property-function is false for heatmap-color. Should we special-case heatmap-color?

We resolved this (I think in chat), but just noting here for reference that heatmap-color does not, in fact, support data-driven styling, so the above is correct.

asheemmamoowala · 2018-02-09T17:26:33Z

src/mbgl/renderer/layers/render_heatmap_layer.cpp

+                try {
+                    renderTexture->bind();
+                } catch (const std::runtime_error& ex) {
+                    // can't render to a half-float texture; falling back to unsigned byte one


Can context.supportsHalfFlooatTextures be updated in this case, so we don't need to have this kind of expensive try..catch in other parts of the code.

Yes! What's the best way to do it? Add a setter like disableHalfFloatTextures(), or maybe expose supportsHalfFloat as a public property?

I don't think a disableHalFloatTextures() setter makes sense. It may be better to make the supprtsHalfFloat member variable public, similar to whats done in

mapbox-gl-native/src/mbgl/gl/context.hpp

Lines 291 to 298 in fcc3808

public:

// For testing and Windows because Qt + ANGLE

// crashes with VAO enabled.

#if defined(_WINDOWS)

bool disableVAOExtension = true;

#else

bool disableVAOExtension = false;

#endif

@asheemmamoowala how does 3726c58 look?

1ec5 · 2018-02-10T22:27:10Z

platform/macos/macos.xcodeproj/project.pbxproj

@@ -369,6 +376,9 @@
 		55D9B4B01D005D3900C1CCE2 /* libz.tbd */ = {isa = PBXFileReference; lastKnownFileType = "sourcecode.text-based-dylib-definition"; name = libz.tbd; path = usr/lib/libz.tbd; sourceTree = SDKROOT; };
 		55E2AD101E5B0A6900E8C587 /* MGLOfflineStorageTests.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; name = MGLOfflineStorageTests.mm; path = ../../darwin/test/MGLOfflineStorageTests.mm; sourceTree = "<group>"; };
 		55FE0E8D1D100A0900FD240B /* config.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = config.xcconfig; path = ../../build/macos/config.xcconfig; sourceTree = "<group>"; };
+		89462398200D199100DA8EF2 /* heatmap.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = heatmap.json; sourceTree = "<group>"; };


FYI, this file isn’t used anywhere. Did you want help hooking up a command for displaying heatmaps in macosapp, or did you only intend for the style to be used with the Custom Style dialog? (wms.json is included for the same reason, so that would be fine.)

Exactly, same case as wms.json.

1ec5 · 2018-02-10T22:55:21Z

9264e27 adds an icon to macosapp’s Layers sidebar for heatmap layers:

tobrun · 2018-02-12T14:13:58Z

platform/android/src/style/layers/heatmap_layer.cpp

+            METHOD(&HeatmapLayer::getHeatmapIntensity, "nativeGetHeatmapIntensity"),
+            METHOD(&HeatmapLayer::getHeatmapOpacityTransition, "nativeGetHeatmapOpacityTransition"),
+            METHOD(&HeatmapLayer::setHeatmapOpacityTransition, "nativeSetHeatmapOpacityTransition"),
+            METHOD(&HeatmapLayer::getHeatmapOpacity, "nativeGetHeatmapOpacity"));


heatmap color seems to be missing from above list. Will look into why this is missing (seems to be supported on iOS though)

@tobrun I disabled any code generation for heatmap-color on the Android side because it requires being able to pass expressions as its values — as far as I remember, we had some bits missing about expressions which made it very hard to make it work.

thank you for the context, will ticket it for now. Update: ticket here.

kkaefer

Nit: can we rearrange includes etc. so that the layer order is always the same? E.g. raster, hillshade, heatmap, ... should always be in the same order.

kkaefer · 2018-02-15T11:44:54Z

platform/android/scripts/generate-style-code.js

@@ -28,6 +28,7 @@ var layers = Object.keys(spec.layer.type.values).map((type) => {
  }, []);

  const paintProperties = Object.keys(spec[`paint_${type}`]).reduce((memo, name) => {
+    if (name === 'heatmap-color') return memo;


Can you please create a ticket that tracks removal of this special casing?

The ticket is here #11172

kkaefer · 2018-02-15T11:49:45Z

platform/darwin/scripts/style-spec-overrides-v8.json

@@ -79,6 +82,11 @@
      "doc": "The base color of this layer. The extrusion's surfaces will be shaded differently based on this color in combination with the `light` settings. If this color is specified with an alpha component, the alpha component will be ignored; use `fill-extrusion-opacity` to set layer opacityco."
    }
  },
+  "paint_heatmap": {
+    "heatmap-color": {
+      "doc": "Defines the color of each pixel based on its density value in a heatmap.  Should be an expression that uses `$heatmapDensity` as input."


Nit: remove double space

kkaefer · 2018-02-15T11:54:34Z

include/mbgl/style/heatmap_color_property_value.hpp

+ * Special-case implementation of (a subset of) the PropertyValue<T> interface
+ * used for building the HeatmapColor paint property traits class.
+ */
+class HeatmapColorPropertyValue {


Instead of naming this after heatmaps, can we find a more generic name for this in light of other code that might use these color ramps too?

Yes! In fact @lbud's line gradient branch, which reuses it, renames it to ColorRampPropertyValue. However I'd leave it as is for now to be consistent with GL JS, and only rename when we land another feature that uses it such as line gradients.

anandthakker

🔥 Looking great!

A couple of questions below, but deferring to your judgment on them @mourner

anandthakker · 2018-02-15T13:49:18Z

platform/darwin/src/MGLHeatmapStyleLayer.h

+ * Interpolation and step functions applied to the `$heatmapDensity` variable
+
+ This property does not support applying interpolation or step functions to
+ feature attributes.


We resolved this (I think in chat), but just noting here for reference that heatmap-color does not, in fact, support data-driven styling, so the above is correct.

anandthakker · 2018-02-15T14:02:39Z

src/mbgl/programs/uniforms.hpp

+namespace heatmap {
+MBGL_DEFINE_UNIFORM_SCALAR(float, u_extrude_scale);
+} // namespace heatmap
+


Other program-specific uniforms are defined in xxx_program.hpp -- should we move this one to heatmap_program.hpp?

I would leave it here until we refactor #11026 so that it's clear why we namespace it and that there's a collision.

anandthakker · 2018-02-15T14:30:16Z

src/mbgl/renderer/renderer_impl.cpp

+
+            if (layer.is<RenderHeatmapLayer>()) {
+                layer.as<RenderHeatmapLayer>()->updateColorRamp();
+            }


This means we're updating the color ramp every time a heatmap-color layer changes, even if the change was to some other property. Should we check the diff more granularly here?

mourner added GL JS parity For feature parity with Mapbox GL JS Core The cross-platform C++ core, aka mbgl in progress labels Jan 25, 2018

mourner requested review from kkaefer and anandthakker January 25, 2018 11:15

mourner force-pushed the heatmap branch from 8a1a003 to ca99c40 Compare January 25, 2018 16:48

kkaefer reviewed Jan 26, 2018

View reviewed changes

jmkiley mentioned this pull request Jan 26, 2018

Add heatmap layer example mapbox/ios-sdk-examples#145

Closed

1ec5 reviewed Jan 27, 2018

View reviewed changes

1ec5 mentioned this pull request Jan 27, 2018

Integrate MGLHeatmapStyleLayer into iOS/macOS SDK #11075

Merged

1ec5 force-pushed the heatmap branch from 1fccc00 to a5f4c06 Compare February 6, 2018 17:00

1ec5 reviewed Feb 7, 2018

View reviewed changes

mourner mentioned this pull request Feb 7, 2018

Conditional render tests #11144

Closed

1ec5 mentioned this pull request Feb 8, 2018

Merge master into release-boba #11152

Merged

asheemmamoowala reviewed Feb 9, 2018

View reviewed changes

1ec5 reviewed Feb 10, 2018

View reviewed changes

tobrun reviewed Feb 12, 2018

View reviewed changes

tobrun mentioned this pull request Feb 12, 2018

Add heatmap-color support on Android #11172

Closed

mourner mentioned this pull request Feb 14, 2018

Improve heatmap render tests; support multiple expected images mapbox/mapbox-gl-js#6162

Merged

[core] add heatmap layer

b2c7bec

mourner force-pushed the heatmap branch from 308984d to b2c7bec Compare February 14, 2018 22:42

added changelog entries for heatmaps

a572b28

kkaefer approved these changes Feb 15, 2018

View reviewed changes

anandthakker approved these changes Feb 15, 2018

View reviewed changes

reorder include order for consistency

ffc9677

mourner merged commit 82de856 into master Feb 15, 2018

mourner deleted the heatmap branch February 15, 2018 15:47

		@@ -1,5 +1 @@
		var spec = module.exports = require('../mapbox-gl-js/src/style-spec/reference/v8');

		// Make temporary modifications here when Native doesn't have all features that JS has.


		const style::HeatmapLayer::Impl& impl() const;

		std::array<uint8_t, 1024> colorRamp;

	void LineAtlas::upload(gl::Context& context, gl::TextureUnit unit) {
	if (!texture) {
	texture = context.createTexture(image, unit);
	} else if (dirty) {
	context.updateTexture(*texture, image, unit);
	}

	dirty = false;
	}


		You can set this property to an expression containing any of the following:

		* Constant numeric values

	public:
	// For testing and Windows because Qt + ANGLE
	// crashes with VAO enabled.
	#if defined(_WINDOWS)
	bool disableVAOExtension = true;
	#else
	bool disableVAOExtension = false;
	#endif

Heatmap layer #11046

Heatmap layer #11046

Conversation

mourner commented Jan 25, 2018 • edited Loading

friedbunny commented Jan 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mourner Jan 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 commented Jan 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 commented Feb 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobrun Feb 12, 2018 • edited Loading

Choose a reason for hiding this comment

kkaefer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anandthakker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mourner commented Jan 25, 2018 •

edited

Loading

mourner Jan 26, 2018 •

edited

Loading

1ec5 commented Jan 27, 2018 •

edited

Loading

tobrun Feb 12, 2018 •

edited

Loading