From d7e1ecd19e321afaba631f9365b31e0a728a61c3 Mon Sep 17 00:00:00 2001 From: John Firebaugh Date: Mon, 25 Apr 2016 13:14:34 -0700 Subject: [PATCH] [core] Generalize Map::{add,remove}CustomLayer --- include/mbgl/layer/custom_layer.hpp | 39 +++++++++++++++++++ include/mbgl/map/map.hpp | 11 ++---- include/mbgl/map/view.hpp | 4 +- include/mbgl/style/types.hpp | 39 ------------------- platform/android/src/example_custom_layer.cpp | 2 +- platform/android/src/jni.cpp | 9 +++-- platform/ios/src/MGLMapView.mm | 9 +++-- platform/qt/src/qmapboxgl.cpp | 9 +++-- src/mbgl/map/map.cpp | 13 ++----- test/api/custom_layer.cpp | 4 +- 10 files changed, 65 insertions(+), 74 deletions(-) diff --git a/include/mbgl/layer/custom_layer.hpp b/include/mbgl/layer/custom_layer.hpp index 81e91ddf5..9782d9593 100644 --- a/include/mbgl/layer/custom_layer.hpp +++ b/include/mbgl/layer/custom_layer.hpp @@ -4,6 +4,45 @@ namespace mbgl { +/** + * Initialize any GL state needed by the custom layer. This method is called once, from the + * rendering thread, at a point when the GL context is active but before rendering for the + * first time. + * + * Resources that are acquired in this method must be released in the UninitializeFunction. + */ +using CustomLayerInitializeFunction = void (*)(void* context); + +/** + * Parameters that define the current camera position for a CustomLayerRenderFunction. + */ +struct CustomLayerRenderParameters { + double width; + double height; + double latitude; + double longitude; + double zoom; + double bearing; + double pitch; + double altitude; +}; + +/** + * Render the layer. This method is called once per frame. The implementation should not make + * any assumptions about the GL state (other than that the correct context is active). It may + * make changes to the state, and is not required to reset values such as the depth mask, stencil + * mask, and corresponding test flags to their original values. + */ +using CustomLayerRenderFunction = void (*)(void* context, const CustomLayerRenderParameters&); + +/** + * Destroy any GL state needed by the custom layer, and deallocate context, if necessary. This + * method is called once, from the rendering thread, at a point when the GL context is active. + * + * Note that it may be called even when the InitializeFunction has not been called. + */ +using CustomLayerDeinitializeFunction = void (*)(void* context); + class CustomLayer : public Layer { public: CustomLayer(const std::string& id, diff --git a/include/mbgl/map/map.hpp b/include/mbgl/map/map.hpp index a728e2dd6..aadfdf9ad 100644 --- a/include/mbgl/map/map.hpp +++ b/include/mbgl/map/map.hpp @@ -9,7 +9,6 @@ #include #include #include -#include #include #include @@ -23,6 +22,7 @@ namespace mbgl { class FileSource; class View; class SpriteImage; +class Layer; struct CameraOptions; struct AnimationOptions; @@ -146,13 +146,8 @@ public: AnnotationIDs getPointAnnotationsInBounds(const LatLngBounds&); - void addCustomLayer(const std::string& id, - CustomLayerInitializeFunction, - CustomLayerRenderFunction, - CustomLayerDeinitializeFunction, - void* context, - const char* before = nullptr); - void removeCustomLayer(const std::string& id); + void addLayer(std::unique_ptr, const optional& beforeLayerID = {}); + void removeLayer(const std::string& layerID); // Feature queries std::vector queryRenderedFeatures(const ScreenCoordinate&, const optional>& layerIDs = {}); diff --git a/include/mbgl/map/view.hpp b/include/mbgl/map/view.hpp index 4431e2b33..9f12ee5fb 100644 --- a/include/mbgl/map/view.hpp +++ b/include/mbgl/map/view.hpp @@ -36,8 +36,8 @@ public: // as a matched pair, in four situations: // // 1. When releasing GL resources during Map destruction - // 2. When calling a CustomLayerInitializeFunction, during Map::addCustomLayer - // 3. When calling a CustomLayerDeinitializeFunction, during Map::removeCustomLayer + // 2. When calling a CustomLayerInitializeFunction, during Map::addLayer + // 3. When calling a CustomLayerDeinitializeFunction, during Map::removeLayer // 4. When rendering for Map::renderStill // // They are *not* called for Map::render; it is assumed that the correct context is already diff --git a/include/mbgl/style/types.hpp b/include/mbgl/style/types.hpp index a852a09a1..ea09ccfb0 100644 --- a/include/mbgl/style/types.hpp +++ b/include/mbgl/style/types.hpp @@ -125,44 +125,5 @@ enum class TextTransformType : uint8_t { Lowercase, }; -/** - * Initialize any GL state needed by the custom layer. This method is called once, from the - * rendering thread, at a point when the GL context is active but before rendering for the - * first time. - * - * Resources that are acquired in this method must be released in the UninitializeFunction. - */ -using CustomLayerInitializeFunction = void (*)(void* context); - -/** - * Parameters that define the current camera position for a CustomLayerRenderFunction. - */ -struct CustomLayerRenderParameters { - double width; - double height; - double latitude; - double longitude; - double zoom; - double bearing; - double pitch; - double altitude; -}; - -/** - * Render the layer. This method is called once per frame. The implementation should not make - * any assumptions about the GL state (other than that the correct context is active). It may - * make changes to the state, and is not required to reset values such as the depth mask, stencil - * mask, and corresponding test flags to their original values. - */ -using CustomLayerRenderFunction = void (*)(void* context, const CustomLayerRenderParameters&); - -/** - * Destroy any GL state needed by the custom layer, and deallocate context, if necessary. This - * method is called once, from the rendering thread, at a point when the GL context is active. - * - * Note that it may be called even when the InitializeFunction has not been called. - */ -using CustomLayerDeinitializeFunction = void (*)(void* context); - } // namespace mbgl diff --git a/platform/android/src/example_custom_layer.cpp b/platform/android/src/example_custom_layer.cpp index a513b7faf..99b6d7223 100644 --- a/platform/android/src/example_custom_layer.cpp +++ b/platform/android/src/example_custom_layer.cpp @@ -1,7 +1,7 @@ #include #include -#include +#include static const GLchar * vertexShaderSource = "attribute vec2 a_pos; void main() { gl_Position = vec4(a_pos, 0, 1); }"; static const GLchar * fragmentShaderSource = "void main() { gl_FragColor = vec4(0, 1, 0, 1); }"; diff --git a/platform/android/src/jni.cpp b/platform/android/src/jni.cpp index ed2563cf7..2b6b4429f 100755 --- a/platform/android/src/jni.cpp +++ b/platform/android/src/jni.cpp @@ -14,6 +14,7 @@ #include #include #include +#include #include #include #include @@ -1111,20 +1112,20 @@ void nativeAddCustomLayer(JNIEnv *env, jni::jobject* obj, jlong nativeMapViewPtr mbgl::Log::Debug(mbgl::Event::JNI, "nativeAddCustomLayer"); assert(nativeMapViewPtr != 0); NativeMapView *nativeMapView = reinterpret_cast(nativeMapViewPtr); - nativeMapView->getMap().addCustomLayer( + nativeMapView->getMap().addLayer(std::make_unique( std_string_from_jstring(env, reinterpret_cast(jni::GetField(*env, customLayer, *customLayerIdId))), reinterpret_cast(jni::GetField(*env, customLayer, *customLayerInitializeFunctionId)), reinterpret_cast(jni::GetField(*env, customLayer, *customLayerRenderFunctionId)), reinterpret_cast(jni::GetField(*env, customLayer, *customLayerDeinitializeFunctionId)), - reinterpret_cast(jni::GetField(*env, customLayer, *customLayerContextId)), - before ? std_string_from_jstring(env, before).c_str() : nullptr); + reinterpret_cast(jni::GetField(*env, customLayer, *customLayerContextId))), + before ? mbgl::optional(std_string_from_jstring(env, before)) : mbgl::optional()); } void nativeRemoveCustomLayer(JNIEnv *env, jni::jobject* obj, jlong nativeMapViewPtr, jni::jstring* id) { mbgl::Log::Debug(mbgl::Event::JNI, "nativeRemoveCustomLayer"); assert(nativeMapViewPtr != 0); NativeMapView *nativeMapView = reinterpret_cast(nativeMapViewPtr); - nativeMapView->getMap().removeCustomLayer(std_string_from_jstring(env, id)); + nativeMapView->getMap().removeLayer(std_string_from_jstring(env, id)); } // Offline calls begin diff --git a/platform/ios/src/MGLMapView.mm b/platform/ios/src/MGLMapView.mm index 87d821fba..338dd4805 100644 --- a/platform/ios/src/MGLMapView.mm +++ b/platform/ios/src/MGLMapView.mm @@ -17,6 +17,7 @@ #include #include #include +#include #include #include #include @@ -5004,14 +5005,14 @@ void MGLFinishCustomStyleLayer(void *context) { NSAssert(identifier, @"Style layer needs an identifier"); MGLCustomStyleLayerHandlers *context = new MGLCustomStyleLayerHandlers(preparation, drawing, completion); - _mbglMap->addCustomLayer(identifier.UTF8String, MGLPrepareCustomStyleLayer, - MGLDrawCustomStyleLayer, MGLFinishCustomStyleLayer, - context, otherIdentifier.UTF8String); + _mbglMap->addLayer(std::make_unique(identifier.UTF8String, MGLPrepareCustomStyleLayer, + MGLDrawCustomStyleLayer, MGLFinishCustomStyleLayer, context), + otherIdentifier ? mbgl::optional(otherIdentifier.UTF8String) : mbgl::optional()); } - (void)removeCustomStyleLayerWithIdentifier:(NSString *)identifier { - _mbglMap->removeCustomLayer(identifier.UTF8String); + _mbglMap->removeLayer(identifier.UTF8String); } - (void)setCustomStyleLayersNeedDisplay diff --git a/platform/qt/src/qmapboxgl.cpp b/platform/qt/src/qmapboxgl.cpp index 1f8657c04..4354eac75 100644 --- a/platform/qt/src/qmapboxgl.cpp +++ b/platform/qt/src/qmapboxgl.cpp @@ -4,6 +4,7 @@ #include #include #include +#include #include #include #include @@ -556,20 +557,20 @@ void QMapboxGL::addCustomLayer(const QString &id, void *context_, char *before) { - d_ptr->mapObj->addCustomLayer( + d_ptr->mapObj->addLayer(std::make_unique( id.toStdString(), reinterpret_cast(initFn), // This cast is safe as long as both mbgl:: and QMapbox:: // CustomLayerRenderParameters members remains the same. (mbgl::CustomLayerRenderFunction)renderFn, reinterpret_cast(deinitFn), - context_, - before == NULL ? nullptr : before); + context_), + before ? mbgl::optional(before) : mbgl::optional()); } void QMapboxGL::removeCustomLayer(const QString& id) { - d_ptr->mapObj->removeCustomLayer(id.toStdString()); + d_ptr->mapObj->removeLayer(id.toStdString()); } void QMapboxGL::render() diff --git a/src/mbgl/map/map.cpp b/src/mbgl/map/map.cpp index aee677752..4f1c4634c 100644 --- a/src/mbgl/map/map.cpp +++ b/src/mbgl/map/map.cpp @@ -740,24 +740,17 @@ std::vector Map::queryRenderedFeatures(const ScreenBox& box, const opti #pragma mark - Style API -void Map::addCustomLayer(const std::string& id, - CustomLayerInitializeFunction initialize, - CustomLayerRenderFunction render_, - CustomLayerDeinitializeFunction deinitialize, - void* context_, - const char* before) { +void Map::addLayer(std::unique_ptr layer, const optional& before) { impl->view.activate(); - impl->style->addLayer( - std::make_unique(id, initialize, render_, deinitialize, context_), - before ? std::string(before) : optional()); + impl->style->addLayer(std::move(layer), before); impl->updateFlags |= Update::Classes; impl->asyncUpdate.send(); impl->view.deactivate(); } -void Map::removeCustomLayer(const std::string& id) { +void Map::removeLayer(const std::string& id) { impl->view.activate(); impl->style->removeLayer(id); diff --git a/test/api/custom_layer.cpp b/test/api/custom_layer.cpp index 4ad25bbfd..b3ff335d4 100644 --- a/test/api/custom_layer.cpp +++ b/test/api/custom_layer.cpp @@ -77,7 +77,7 @@ TEST(CustomLayer, Basic) { Map map(view, fileSource, MapMode::Still); map.setStyleJSON(util::read_file("test/fixtures/api/empty.json"), ""); - map.addCustomLayer( + map.addLayer(std::make_unique( "custom", [] (void* context) { reinterpret_cast(context)->initialize(); @@ -87,7 +87,7 @@ TEST(CustomLayer, Basic) { }, [] (void* context) { delete reinterpret_cast(context); - }, new TestLayer()); + }, new TestLayer())); test::checkImage("test/fixtures/custom_layer/basic", test::render(map)); }