Add extra observer hooks for interesting internal processes (#2694)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
mwilsnd
2024-09-03 17:48:03 -04:00
committed by GitHub
parent b90b2df920
commit bb34568af2
93 changed files with 1951 additions and 177 deletions

View File

@@ -189,7 +189,8 @@ add_library(maplibre SHARED
${PROJECT_SOURCE_DIR}/style/transition_options.hpp
${PROJECT_SOURCE_DIR}/style/value.cpp
${PROJECT_SOURCE_DIR}/style/value.hpp
${PROJECT_SOURCE_DIR}/util/default_style.cpp
${PROJECT_SOURCE_DIR}/tile/tile_operation.cpp
${PROJECT_SOURCE_DIR}/util/default_style.cpp
${PROJECT_SOURCE_DIR}/util/tile_server_options.cpp
${PROJECT_SOURCE_DIR}/util/default_style.hpp
${PROJECT_SOURCE_DIR}/util/tile_server_options.hpp)

View File

@@ -1,5 +1,6 @@
#include "android_renderer_frontend.hpp"
#include <mbgl/tile/tile_operation.hpp>
#include <mbgl/actor/scheduler.hpp>
#include <mbgl/renderer/renderer.hpp>
#include <mbgl/renderer/renderer_observer.hpp>
@@ -52,6 +53,40 @@ public:
delegate.invoke(&RendererObserver::onRemoveUnusedStyleImages, ids);
}
void onPreCompileShader(mbgl::shaders::BuiltIn id,
mbgl::gfx::Backend::Type type,
const std::string& additionalDefines) override {
delegate.invoke(&RendererObserver::onPreCompileShader, id, type, additionalDefines);
}
void onPostCompileShader(mbgl::shaders::BuiltIn id,
mbgl::gfx::Backend::Type type,
const std::string& additionalDefines) override {
delegate.invoke(&RendererObserver::onPostCompileShader, id, type, additionalDefines);
}
void onShaderCompileFailed(mbgl::shaders::BuiltIn id,
mbgl::gfx::Backend::Type type,
const std::string& additionalDefines) override {
delegate.invoke(&RendererObserver::onShaderCompileFailed, id, type, additionalDefines);
}
void onGlyphsLoaded(const mbgl::FontStack& stack, const mbgl::GlyphRange& range) override {
delegate.invoke(&RendererObserver::onGlyphsLoaded, stack, range);
}
void onGlyphsError(const mbgl::FontStack& stack, const mbgl::GlyphRange& range, std::exception_ptr ex) override {
delegate.invoke(&RendererObserver::onGlyphsError, stack, range, ex);
}
void onGlyphsRequested(const mbgl::FontStack& stack, const mbgl::GlyphRange& range) override {
delegate.invoke(&RendererObserver::onGlyphsRequested, stack, range);
}
void onTileAction(TileOperation op, const OverscaledTileID& id, const std::string& sourceID) override {
delegate.invoke(&RendererObserver::onTileAction, op, id, sourceID);
}
private:
std::shared_ptr<Mailbox> mailbox;
ActorRef<RendererObserver> delegate;

View File

@@ -56,6 +56,7 @@
#include "i18n/number_format_jni.hpp"
#include "logger.hpp"
#include "text/local_glyph_rasterizer_jni.hpp"
#include "tile/tile_operation.hpp"
namespace mbgl {
namespace android {
@@ -158,6 +159,9 @@ void registerNatives(JavaVM* vm) {
StringUtils::registerNative(env);
NumberFormat::registerNative(env);
// Tile
TileOperation::registerNative(env);
// Logger
Logger::registerNative(env);

View File

@@ -53,6 +53,7 @@
#include "map_renderer.hpp"
#include "run_loop_impl.hpp"
#include "style/light.hpp"
#include "tile/tile_operation.hpp"
namespace mbgl {
namespace android {
@@ -1341,5 +1342,199 @@ void NativeMapView::registerNative(jni::JNIEnv& env) {
METHOD(&NativeMapView::triggerRepaint, "nativeTriggerRepaint"));
}
void NativeMapView::onRegisterShaders(gfx::ShaderRegistry&) {};
// Shader compilation
void NativeMapView::onPreCompileShader(shaders::BuiltIn id,
gfx::Backend::Type type,
const std::string& additionalDefines) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onPreCompileShader = javaClass.GetMethod<void(jni::jint, jni::jint, jni::String)>(*_env,
"onPreCompileShader");
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env,
onPreCompileShader,
static_cast<jni::jint>(id),
static_cast<jni::jint>(type),
jni::Make<jni::String>(*_env, additionalDefines));
}
}
void NativeMapView::onPostCompileShader(shaders::BuiltIn id,
gfx::Backend::Type type,
const std::string& additionalDefines) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onPostCompileShader = javaClass.GetMethod<void(jni::jint, jni::jint, jni::String)>(
*_env, "onPostCompileShader");
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env,
onPostCompileShader,
static_cast<jni::jint>(id),
static_cast<jni::jint>(type),
jni::Make<jni::String>(*_env, additionalDefines));
}
}
void NativeMapView::onShaderCompileFailed(shaders::BuiltIn id,
gfx::Backend::Type type,
const std::string& additionalDefines) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onShaderCompileFailed = javaClass.GetMethod<void(jni::jint, jni::jint, jni::String)>(
*_env, "onShaderCompileFailed");
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env,
onShaderCompileFailed,
static_cast<jni::jint>(id),
static_cast<jni::jint>(type),
jni::Make<jni::String>(*_env, additionalDefines));
}
}
// Glyph requests
void NativeMapView::onGlyphsLoaded(const FontStack& stack, const GlyphRange& range) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onGlyphsLoaded = javaClass.GetMethod<void(jni::Array<jni::String>, jni::jint, jni::jint)>(
*_env, "onGlyphsLoaded");
auto fontStack = jni::Array<jni::String>::New(*_env, stack.size());
for (std::size_t i = 0; i < stack.size(); i++) {
fontStack.Set(*_env, i, jni::Make<jni::String>(*_env, stack.at(i)));
}
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env, onGlyphsLoaded, fontStack, range.first, range.second);
}
}
void NativeMapView::onGlyphsError(const FontStack& stack, const GlyphRange& range, std::exception_ptr) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onGlyphsError = javaClass.GetMethod<void(jni::Array<jni::String>, jni::jint, jni::jint)>(
*_env, "onGlyphsError");
auto fontStack = jni::Array<jni::String>::New(*_env, stack.size());
for (std::size_t i = 0; i < stack.size(); i++) {
fontStack.Set(*_env, i, jni::Make<jni::String>(*_env, stack.at(i)));
}
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env, onGlyphsError, fontStack, range.first, range.second);
}
}
void NativeMapView::onGlyphsRequested(const FontStack& stack, const GlyphRange& range) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onGlyphsRequested = javaClass.GetMethod<void(jni::Array<jni::String>, jni::jint, jni::jint)>(
*_env, "onGlyphsRequested");
auto fontStack = jni::Array<jni::String>::New(*_env, stack.size());
for (std::size_t i = 0; i < stack.size(); i++) {
fontStack.Set(*_env, i, jni::Make<jni::String>(*_env, stack.at(i)));
}
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env, onGlyphsRequested, fontStack, range.first, range.second);
}
}
// Tile requests
void NativeMapView::onTileAction(mbgl::TileOperation op, const OverscaledTileID& id, const std::string& sourceID) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onTileAction = javaClass.GetMethod<void(
jni::Object<mbgl::android::TileOperation>, jni::jint, jni::jint, jni::jint, jni::jint, jni::jint, jni::String)>(
*_env, "onTileAction");
auto weakReference = javaPeer.get(*_env);
if (weakReference) {
weakReference.Call(*_env,
onTileAction,
mbgl::android::TileOperation::Create(*_env, op),
static_cast<jni::jint>(id.canonical.x),
static_cast<jni::jint>(id.canonical.y),
static_cast<jni::jint>(id.canonical.z),
static_cast<jni::jint>(id.wrap),
static_cast<jni::jint>(id.overscaledZ),
jni::Make<jni::String>(*_env, sourceID));
}
}
// Sprite requests
void NativeMapView::onSpriteLoaded(const std::optional<style::Sprite>& sprite) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onSpriteLoaded = javaClass.GetMethod<void(jni::String, jni::String)>(*_env, "onSpriteLoaded");
auto weakReference = javaPeer.get(*_env);
if (weakReference && sprite) {
weakReference.Call(*_env,
onSpriteLoaded,
jni::Make<jni::String>(*_env, sprite->id),
jni::Make<jni::String>(*_env, sprite->spriteURL));
} else {
weakReference.Call(*_env, onSpriteLoaded, jni::Make<jni::String>(*_env, ""), jni::Make<jni::String>(*_env, ""));
}
}
void NativeMapView::onSpriteError(const std::optional<style::Sprite>& sprite, std::exception_ptr ex) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onSpriteError = javaClass.GetMethod<void(jni::String, jni::String)>(*_env, "onSpriteError");
auto weakReference = javaPeer.get(*_env);
if (weakReference && sprite) {
weakReference.Call(*_env,
onSpriteError,
jni::Make<jni::String>(*_env, sprite->id),
jni::Make<jni::String>(*_env, sprite->spriteURL));
} else {
weakReference.Call(*_env, onSpriteError, jni::Make<jni::String>(*_env, ""), jni::Make<jni::String>(*_env, ""));
}
}
void NativeMapView::onSpriteRequested(const std::optional<style::Sprite>& sprite) {
assert(vm != nullptr);
android::UniqueEnv _env = android::AttachEnv();
static auto& javaClass = jni::Class<NativeMapView>::Singleton(*_env);
static auto onSpriteRequested = javaClass.GetMethod<void(jni::String, jni::String)>(*_env, "onSpriteRequested");
auto weakReference = javaPeer.get(*_env);
if (weakReference && sprite) {
weakReference.Call(*_env,
onSpriteRequested,
jni::Make<jni::String>(*_env, sprite->id),
jni::Make<jni::String>(*_env, sprite->spriteURL));
} else {
weakReference.Call(
*_env, onSpriteRequested, jni::Make<jni::String>(*_env, ""), jni::Make<jni::String>(*_env, ""));
}
}
} // namespace android
} // namespace mbgl

View File

@@ -5,6 +5,7 @@
#include <mbgl/map/map.hpp>
#include <mbgl/util/noncopyable.hpp>
#include <mbgl/util/run_loop.hpp>
#include <mbgl/tile/tile_operation.hpp>
#include <mbgl/storage/network_status.hpp>
#include "annotation/marker.hpp"
@@ -298,6 +299,25 @@ public:
void triggerRepaint(JNIEnv&);
// Shader compilation
void onRegisterShaders(mbgl::gfx::ShaderRegistry&) override;
void onPreCompileShader(mbgl::shaders::BuiltIn, mbgl::gfx::Backend::Type, const std::string&) override;
void onPostCompileShader(mbgl::shaders::BuiltIn, mbgl::gfx::Backend::Type, const std::string&) override;
void onShaderCompileFailed(mbgl::shaders::BuiltIn, mbgl::gfx::Backend::Type, const std::string&) override;
// Glyph requests
void onGlyphsLoaded(const mbgl::FontStack&, const mbgl::GlyphRange&) override;
void onGlyphsError(const mbgl::FontStack&, const mbgl::GlyphRange&, std::exception_ptr) override;
void onGlyphsRequested(const mbgl::FontStack&, const mbgl::GlyphRange&) override;
// Tile requests
void onTileAction(mbgl::TileOperation, const mbgl::OverscaledTileID&, const std::string&) override;
// Sprite requests
void onSpriteLoaded(const std::optional<mbgl::style::Sprite>&) override;
void onSpriteError(const std::optional<mbgl::style::Sprite>&, std::exception_ptr) override;
void onSpriteRequested(const std::optional<mbgl::style::Sprite>&) override;
private:
std::unique_ptr<AndroidRendererFrontend> rendererFrontend;

View File

@@ -0,0 +1,35 @@
#include "tile_operation.hpp"
namespace mbgl {
namespace android {
jni::Local<jni::Object<TileOperation>> TileOperation::Create(jni::JNIEnv& env, mbgl::TileOperation op) {
static auto& _class = jni::Class<mbgl::android::TileOperation>::Singleton(env);
switch (op) {
case mbgl::TileOperation::RequestedFromNetwork:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "RequestedFromNetwork"));
case mbgl::TileOperation::RequestedFromCache:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "RequestedFromCache"));
case mbgl::TileOperation::LoadFromCache:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "LoadFromCache"));
case mbgl::TileOperation::LoadFromNetwork:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "LoadFromNetwork"));
case mbgl::TileOperation::StartParse:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "StartParse"));
case mbgl::TileOperation::EndParse:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "EndParse"));
case mbgl::TileOperation::Error:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "Error"));
case mbgl::TileOperation::Cancelled:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "Cancelled"));
case mbgl::TileOperation::NullOp:
return _class.Get(env, _class.GetStaticField<jni::Object<TileOperation>>(env, "NullOp"));
}
}
void TileOperation::registerNative(jni::JNIEnv& env) {
jni::Class<TileOperation>::Singleton(env);
}
} // namespace android
} // namespace mbgl

View File

@@ -0,0 +1,20 @@
#pragma once
#include <mbgl/tile/tile_operation.hpp>
#include <jni/jni.hpp>
namespace mbgl {
namespace android {
class TileOperation {
public:
static constexpr auto Name() { return "org/maplibre/android/tile/TileOperation"; };
static jni::Local<jni::Object<TileOperation>> Create(jni::JNIEnv&, mbgl::TileOperation);
static void registerNative(jni::JNIEnv& env);
};
} // namespace android
} // namespace mbgl

View File

@@ -1,6 +1,7 @@
package org.maplibre.android.maps;
import org.maplibre.android.log.Logger;
import org.maplibre.android.tile.TileOperation;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
@@ -35,6 +36,26 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
= new CopyOnWriteArrayList<>();
private final List<MapView.OnCanRemoveUnusedStyleImageListener> onCanRemoveUnusedStyleImageListenerList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnPreCompileShaderListener> onPreCompileShaderList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnPostCompileShaderListener> onPostCompileShaderList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnShaderCompileFailedListener> onShaderCompileFailedList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnGlyphsLoadedListener> onGlyphsLoadedList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnGlyphsErrorListener> onGlyphsErrorList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnGlyphsRequestedListener> onGlyphsRequestedList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnTileActionListener> onTileActionList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnSpriteLoadedListener> onSpriteLoadedList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnSpriteErrorListener> onSpriteErrorList
= new CopyOnWriteArrayList<>();
private final List<MapView.OnSpriteRequestedListener> onSpriteRequestedList
= new CopyOnWriteArrayList<>();
@Override
public void onCameraWillChange(boolean animated) {
@@ -255,6 +276,146 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
return true;
}
@Override
public void onPreCompileShader(int id, int type, String additionalDefines) {
try {
if (!onPreCompileShaderList.isEmpty()) {
for (MapView.OnPreCompileShaderListener listener : onPreCompileShaderList) {
listener.onPreCompileShader(id, type, additionalDefines);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onPreCompileShader", err);
throw err;
}
}
@Override
public void onPostCompileShader(int id, int type, String additionalDefines) {
try {
if (!onPostCompileShaderList.isEmpty()) {
for (MapView.OnPostCompileShaderListener listener : onPostCompileShaderList) {
listener.onPostCompileShader(id, type, additionalDefines);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onPostCompileShader", err);
throw err;
}
}
@Override
public void onShaderCompileFailed(int id, int type, String additionalDefines) {
try {
if (!onShaderCompileFailedList.isEmpty()) {
for (MapView.OnShaderCompileFailedListener listener : onShaderCompileFailedList) {
listener.onShaderCompileFailed(id, type, additionalDefines);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onShaderCompileFailed", err);
throw err;
}
}
@Override
public void onGlyphsLoaded(String[] stack, int rangeStart, int rangeEnd) {
try {
if (!onGlyphsLoadedList.isEmpty()) {
for (MapView.OnGlyphsLoadedListener listener : onGlyphsLoadedList) {
listener.onGlyphsLoaded(stack, rangeStart, rangeEnd);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onGlyphsLoaded", err);
throw err;
}
}
@Override
public void onGlyphsError(String[] stack, int rangeStart, int rangeEnd) {
try {
if (!onGlyphsErrorList.isEmpty()) {
for (MapView.OnGlyphsErrorListener listener : onGlyphsErrorList) {
listener.onGlyphsError(stack, rangeStart, rangeEnd);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onGlyphsError", err);
throw err;
}
}
@Override
public void onGlyphsRequested(String[] stack, int rangeStart, int rangeEnd) {
try {
if (!onGlyphsRequestedList.isEmpty()) {
for (MapView.OnGlyphsRequestedListener listener : onGlyphsRequestedList) {
listener.onGlyphsRequested(stack, rangeStart, rangeEnd);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onGlyphsRequested", err);
throw err;
}
}
@Override
public void onTileAction(TileOperation op, int x, int y, int z, int wrap, int overscaledZ, String sourceID) {
try {
if (!onTileActionList.isEmpty()) {
for (MapView.OnTileActionListener listener : onTileActionList) {
listener.onTileAction(op, x, y, z, wrap, overscaledZ, sourceID);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onTileAction", err);
throw err;
}
}
@Override
public void onSpriteLoaded(String id, String url) {
try {
if (!onSpriteLoadedList.isEmpty()) {
for (MapView.OnSpriteLoadedListener listener : onSpriteLoadedList) {
listener.onSpriteLoaded(id, url);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onSpriteLoaded", err);
throw err;
}
}
@Override
public void onSpriteError(String id, String url) {
try {
if (!onSpriteErrorList.isEmpty()) {
for (MapView.OnSpriteErrorListener listener : onSpriteErrorList) {
listener.onSpriteError(id, url);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onSpriteError", err);
throw err;
}
}
@Override
public void onSpriteRequested(String id, String url) {
try {
if (!onSpriteRequestedList.isEmpty()) {
for (MapView.OnSpriteRequestedListener listener : onSpriteRequestedList) {
listener.onSpriteRequested(id, url);
}
}
} catch (Throwable err) {
Logger.e(TAG, "Exception in onSpriteRequested", err);
throw err;
}
}
void addOnCameraWillChangeListener(MapView.OnCameraWillChangeListener listener) {
onCameraWillChangeListenerList.add(listener);
}
@@ -375,6 +536,86 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
onCanRemoveUnusedStyleImageListenerList.remove(listener);
}
public void addOnPreCompileShaderListener(MapView.OnPreCompileShaderListener callback) {
onPreCompileShaderList.add(callback);
}
public void addOnPostCompileShaderListener(MapView.OnPostCompileShaderListener callback) {
onPostCompileShaderList.add(callback);
}
public void addOnShaderCompileFailedListener(MapView.OnShaderCompileFailedListener callback) {
onShaderCompileFailedList.add(callback);
}
public void addOnGlyphsLoadedListener(MapView.OnGlyphsLoadedListener callback) {
onGlyphsLoadedList.add(callback);
}
public void addOnGlyphsErrorListener(MapView.OnGlyphsErrorListener callback) {
onGlyphsErrorList.add(callback);
}
public void addOnGlyphsRequestedListener(MapView.OnGlyphsRequestedListener callback) {
onGlyphsRequestedList.add(callback);
}
public void addOnTileActionListener(MapView.OnTileActionListener callback) {
onTileActionList.add(callback);
}
public void addOnSpriteLoadedListener(MapView.OnSpriteLoadedListener callback) {
onSpriteLoadedList.add(callback);
}
public void addOnSpriteErrorListener(MapView.OnSpriteErrorListener callback) {
onSpriteErrorList.add(callback);
}
public void addOnSpriteRequestedListener(MapView.OnSpriteRequestedListener callback) {
onSpriteRequestedList.add(callback);
}
public void removeOnPreCompileShaderListener(MapView.OnPreCompileShaderListener callback) {
onPreCompileShaderList.remove(callback);
}
public void removeOnPostCompileShaderListener(MapView.OnPostCompileShaderListener callback) {
onPostCompileShaderList.remove(callback);
}
public void removeOnShaderCompileFailedListener(MapView.OnShaderCompileFailedListener callback) {
onShaderCompileFailedList.remove(callback);
}
public void removeOnGlyphsLoadedListener(MapView.OnGlyphsLoadedListener callback) {
onGlyphsLoadedList.remove(callback);
}
public void removeOnGlyphsErrorListener(MapView.OnGlyphsErrorListener callback) {
onGlyphsErrorList.remove(callback);
}
public void removeOnGlyphsRequestedListener(MapView.OnGlyphsRequestedListener callback) {
onGlyphsRequestedList.remove(callback);
}
public void removeOnTileActionListener(MapView.OnTileActionListener callback) {
onTileActionList.remove(callback);
}
public void removeOnSpriteLoadedListener(MapView.OnSpriteLoadedListener callback) {
onSpriteLoadedList.remove(callback);
}
public void removeOnSpriteErrorListener(MapView.OnSpriteErrorListener callback) {
onSpriteErrorList.remove(callback);
}
public void removeOnSpriteRequestedListener(MapView.OnSpriteRequestedListener callback) {
onSpriteRequestedList.remove(callback);
}
void clear() {
onCameraWillChangeListenerList.clear();
onCameraIsChangingListenerList.clear();
@@ -391,5 +632,15 @@ class MapChangeReceiver implements NativeMapView.StateCallback {
onSourceChangedListenerList.clear();
onStyleImageMissingListenerList.clear();
onCanRemoveUnusedStyleImageListenerList.clear();
onPreCompileShaderList.clear();
onPostCompileShaderList.clear();
onShaderCompileFailedList.clear();
onGlyphsLoadedList.clear();
onGlyphsErrorList.clear();
onGlyphsRequestedList.clear();
onTileActionList.clear();
onSpriteLoadedList.clear();
onSpriteErrorList.clear();
onSpriteRequestedList.clear();
}
}

View File

@@ -37,6 +37,7 @@ import org.maplibre.android.maps.widgets.CompassView;
import org.maplibre.android.net.ConnectivityReceiver;
import org.maplibre.android.storage.FileSource;
import org.maplibre.android.utils.BitmapUtils;
import org.maplibre.android.tile.TileOperation;
import java.util.ArrayList;
import java.util.Iterator;
@@ -906,6 +907,186 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback {
mapChangeReceiver.removeOnCanRemoveUnusedStyleImageListener(listener);
}
/**
* Set a callback that's invoked before a shader is compiled.
*
* @param listener The callback that's invoked before a shader is compiled
*/
public void addOnPreCompileShaderListener(MapView.OnPreCompileShaderListener callback) {
mapChangeReceiver.addOnPreCompileShaderListener(callback);
}
/**
* Removes a callback that's invoked before a shader is compiled.
*
* @param listener The callback that's invoked before a shader is compiled
*/
public void removeOnPreCompileShaderListener(MapView.OnPreCompileShaderListener callback) {
mapChangeReceiver.removeOnPreCompileShaderListener(callback);
}
/**
* Set a callback that's invoked after a shader is compiled.
*
* @param listener The callback that's invoked after a shader is compiled
*/
public void addOnPostCompileShaderListener(MapView.OnPostCompileShaderListener callback) {
mapChangeReceiver.addOnPostCompileShaderListener(callback);
}
/**
* Removes a callback that's invoked after a shader is compiled.
*
* @param listener The callback that's invoked after a shader is compiled
*/
public void removeOnPostCompileShaderListener(MapView.OnPostCompileShaderListener callback) {
mapChangeReceiver.removeOnPostCompileShaderListener(callback);
}
/**
* Set a callback that's invoked after a shader failed to compile.
*
* @param listener The callback that's invoked after a shader failes to compile
*/
public void addOnShaderCompileFailedListener(MapView.OnShaderCompileFailedListener callback) {
mapChangeReceiver.addOnShaderCompileFailedListener(callback);
}
/**
* Removes a callback that's invoked after a shader failed to compile.
*
* @param listener The callback that's invoked after a shader failes to compile
*/
public void removeOnShaderCompileFailedListener(MapView.OnShaderCompileFailedListener callback) {
mapChangeReceiver.removeOnShaderCompileFailedListener(callback);
}
/**
* Set a callback that's invoked after a range of glyphs are loaded.
*
* @param listener The callback that's invoked after a range of glyphs are loaded
*/
public void addOnGlyphsLoadedListener(MapView.OnGlyphsLoadedListener callback) {
mapChangeReceiver.addOnGlyphsLoadedListener(callback);
}
/**
* Removes a callback that's invoked after a range of glyphs are loaded.
*
* @param listener The callback that's invoked after a range of glyphs are loaded
*/
public void removeOnGlyphsLoadedListener(MapView.OnGlyphsLoadedListener callback) {
mapChangeReceiver.removeOnGlyphsLoadedListener(callback);
}
/**
* Set a callback that's invoked after a range of glyphs fail to load.
*
* @param listener The callback that's invoked after a range of glyphs fail to load
*/
public void addOnGlyphsErrorListener(MapView.OnGlyphsErrorListener callback) {
mapChangeReceiver.addOnGlyphsErrorListener(callback);
}
/**
* Removes a callback that's invoked after a range of glyphs fail to load.
*
* @param listener The callback that's invoked after a range of glyphs fail to load
*/
public void removeOnGlyphsErrorListener(MapView.OnGlyphsErrorListener callback) {
mapChangeReceiver.removeOnGlyphsErrorListener(callback);
}
/**
* Set a callback that's invoked after a range of glyphs are requested.
*
* @param listener The callback that's invoked after a range of glyphs are requested
*/
public void addOnGlyphsRequestedListener(MapView.OnGlyphsRequestedListener callback) {
mapChangeReceiver.addOnGlyphsRequestedListener(callback);
}
/**
* Removes a callback that's invoked after a range of glyphs are requested.
*
* @param listener The callback that's invoked after a range of glyphs are requested
*/
public void removeOnGlyphsRequestedListener(MapView.OnGlyphsRequestedListener callback) {
mapChangeReceiver.removeOnGlyphsRequestedListener(callback);
}
/**
* Set a callback that's invoked after a tile action occurs.
*
* @param listener The callback that's invoked after a tile action occurs
*/
public void addOnTileActionListener(MapView.OnTileActionListener callback) {
mapChangeReceiver.addOnTileActionListener(callback);
}
/**
* Remove's a callback that's invoked after a tile action occurs.
*
* @param listener The callback that's invoked after a tile action occurs
*/
public void removeOnTileActionListener(MapView.OnTileActionListener callback) {
mapChangeReceiver.removeOnTileActionListener(callback);
}
/**
* Set a callback that's invoked after a sprite is loaded.
*
* @param listener The callback that's invoked after a sprite is loaded
*/
public void addOnSpriteLoadedListener(MapView.OnSpriteLoadedListener callback) {
mapChangeReceiver.addOnSpriteLoadedListener(callback);
}
/**
* Removes a callback that's invoked after a sprite is loaded.
*
* @param listener The callback that's invoked after a sprite is loaded
*/
public void removeOnSpriteLoadedListener(MapView.OnSpriteLoadedListener callback) {
mapChangeReceiver.removeOnSpriteLoadedListener(callback);
}
/**
* Set a callback that's invoked after a sprite fails to laod.
*
* @param listener The callback that's invoked after a sprite fails to load
*/
public void addOnSpriteErrorListener(MapView.OnSpriteErrorListener callback) {
mapChangeReceiver.addOnSpriteErrorListener(callback);
}
/**
* Removes a callback that's invoked after a sprite fails to laod.
*
* @param listener The callback that's invoked after a sprite fails to load
*/
public void removeOnSpriteErrorListener(MapView.OnSpriteErrorListener callback) {
mapChangeReceiver.removeOnSpriteErrorListener(callback);
}
/**
* Set a callback that's invoked after a sprite is requested.
*
* @param listener The callback that's invoked after a sprite is requested
*/
public void addOnSpriteRequestedListener(MapView.OnSpriteRequestedListener callback) {
mapChangeReceiver.addOnSpriteRequestedListener(callback);
}
/**
* Removes a callback that's invoked after a sprite is requested.
*
* @param listener The callback that's invoked after a sprite is requested
*/
public void removeOnSpriteRequestedListener(MapView.OnSpriteRequestedListener callback) {
mapChangeReceiver.removeOnSpriteRequestedListener(callback);
}
/**
* Interface definition for a callback to be invoked when the camera will change.
* <p>
@@ -1123,6 +1304,183 @@ public class MapView extends FrameLayout implements NativeMapView.ViewCallback {
boolean onCanRemoveUnusedStyleImage(@NonNull String id);
}
/**
* Interface definition for a callback to be invoked before a shader is compiled.
* <p>
* {@link MapView#addOnPreCompileShaderListener(OnPreCompileShaderListener)}
* </p>
*/
public interface OnPreCompileShaderListener {
/**
* Called before a shader is compiled.
*
* @param id of a shader type enumeration. See `mbgl::shaders::BuiltIn` for a list
* of possible values.
* @param type of graphics backend the shader is being compiled for. See
* `mbgl::gfx::Backend::Type` for a list of possible values.
* @param additionalDefines that specify the permutaion of the shader.
*/
void onPreCompileShader(int id, int type, String additionalDefines);
}
/**
* Interface definition for a callback to be invoked after a shader is compiled.
* <p>
* {@link MapView#addOnPostCompileShaderListener(OnPostCompileShaderListener)}
* </p>
*/
public interface OnPostCompileShaderListener {
/**
* Called after a shader is compiled.
*
* @param id of a shader type enumeration. See `mbgl::shaders::BuiltIn` for a list
* of possible values.
* @param type of graphics backend the shader is being compiled for. See
* `mbgl::gfx::Backend::Type` for a list of possible values.
* @param additionalDefines that specify the permutation of the shader.
*/
void onPostCompileShader(int id, int type, String additionalDefines);
}
/**
* Interface definition for a callback to be invoked after a shader failed to compile.
* <p>
* {@link MapView#addOnShaderCompileFailedListener(OnShaderCompileFailedListener)}
* </p>
*/
public interface OnShaderCompileFailedListener {
/**
* Called when a shader fails to compile.
*
* @param id of a shader type enumeration. See `mbgl::shaders::BuiltIn` for a list
* of possible values.
* @param type of graphics backend the shader is being compiled for. See
* `mbgl::gfx::Backend::Type` for a list of possible values.
* @param additionalDefines that specify the permutation of the shader.
*/
void onShaderCompileFailed(int id, int type, String additionalDefines);
}
/**
* Interface definition for a callback to be invoked after a range of glyphs are loaded.
* <p>
* {@link MapView#addOnGlyphsLoadedListener(OnGlyphsLoadedListener)}
* </p>
*/
public interface OnGlyphsLoadedListener {
/**
* Called when a range of glyphs for a font stack are loaded.
*
* @param stack of font names.
* @param rangeStart of glyph indices being loaded.
* @param rangeEnd of glyph indices being loaded.
*/
void onGlyphsLoaded(@NonNull String[] stack, int rangeStart, int rangeEnd);
}
/**
* Interface definition for a callback to be invoked after a range of glyphs fail to load.
* <p>
* {@link MapView#addOnGlyphsErrorListener(OnGlyphsErrorListener)}
* </p>
*/
public interface OnGlyphsErrorListener {
/**
* Called when a range of glyphs for a font stack failed to load.
*
* @param stack of font names.
* @param rangeStart of glyph indices that failed to load.
* @param rangeEnd of glyph indices that failed to load.
*/
void onGlyphsError(@NonNull String[] stack, int rangeStart, int rangeEnd);
}
/**
* Interface definition for a callback to be invoked after a range of glyphs are requested.
* <p>
* {@link MapView#addOnGlyphsRequestedListener(OnGlyphsRequestedListener)}
* </p>
*/
public interface OnGlyphsRequestedListener {
/**
* Called when a range of glyphs for a font stack are requested.
*
* @param stack of font names.
* @param rangeStart of glyph indices that are being requested.
* @param rangeEnd of glyph indices that are being requested.
*/
void onGlyphsRequested(@NonNull String[] stack, int rangeStart, int rangeEnd);
}
/**
* Interface definition for a callback to be invoked after a tile action occurs.
* <p>
* {@link MapView#addOnTileActionListener(OnTileActionListener)}
* </p>
*/
public interface OnTileActionListener {
/**
* Called when a tile action occurs.
*
* @param op identifying the tile action that occurred.
* @param x coordinate of the tile.
* @param y coordinate of the tile.
* @param z coordinate of the tile.
* @param wrap coordinate of the tile.
* @param overscaledZ coordinate of the tile.
* @param sourceID of the tile.
*/
void onTileAction(TileOperation op, int x, int y, int z, int wrap, int overscaledZ, String sourceID);
}
/**
* Interface definition for a callback to be invoked after a sprite is requested.
* <p>
* {@link MapView#addOnSpriteLoadedListener(OnSpriteLoadedListener)}
* </p>
*/
public interface OnSpriteLoadedListener {
/**
* Called when a sprite is loaded.
*
* @param id of the sprite.
* @param url of the sprite.
*/
void onSpriteLoaded(@NonNull String id, @NonNull String url);
}
/**
* Interface definition for a callback to be invoked after a sprite fails to load.
* <p>
* {@link MapView#addOnSpriteErrorListener(OnSpriteErrorListener)}
* </p>
*/
public interface OnSpriteErrorListener {
/**
* Called when a sprite fails to load.
*
* @param id of the sprite.
* @param url of the sprite.
*/
void onSpriteError(@NonNull String id, @NonNull String url);
}
/**
* Interface definition for a callback to be invoked after a sprite is requested.
* <p>
* {@link MapView#addOnSpriteRequestedListener(OnSpriteRequestedListener)}
* </p>
*/
public interface OnSpriteRequestedListener {
/**
* Called when a sprite is requested.
*
* @param id of the sprite.
* @param url of the sprite.
*/
void onSpriteRequested(@NonNull String id, @NonNull String url);
}
/**
* Sets a callback object which will be triggered when the {@link MapLibreMap} instance is ready to be used.
*

View File

@@ -37,6 +37,7 @@ import org.maplibre.android.style.light.Light;
import org.maplibre.android.style.sources.CannotAddSourceException;
import org.maplibre.android.style.sources.Source;
import org.maplibre.android.utils.BitmapUtils;
import org.maplibre.android.tile.TileOperation;
import java.util.ArrayList;
import java.util.Arrays;
@@ -1194,6 +1195,76 @@ final class NativeMapView implements NativeMap {
}
}
@Keep
private void onPreCompileShader(int id, int type, String additionalDefines) {
if (stateCallback != null) {
stateCallback.onPreCompileShader(id, type, additionalDefines);
}
}
@Keep
private void onPostCompileShader(int id, int type, String additionalDefines) {
if (stateCallback != null) {
stateCallback.onPostCompileShader(id, type, additionalDefines);
}
}
@Keep
private void onShaderCompileFailed(int id, int type, String additionalDefines) {
if (stateCallback != null) {
stateCallback.onShaderCompileFailed(id, type, additionalDefines);
}
}
@Keep
private void onGlyphsLoaded(String[] stack, int rangeStart, int rangeEnd) {
if (stateCallback != null) {
stateCallback.onGlyphsLoaded(stack, rangeStart, rangeEnd);
}
}
@Keep
private void onGlyphsError(String[] stack, int rangeStart, int rangeEnd) {
if (stateCallback != null) {
stateCallback.onGlyphsError(stack, rangeStart, rangeEnd);
}
}
@Keep
private void onGlyphsRequested(String[] stack, int rangeStart, int rangeEnd) {
if (stateCallback != null) {
stateCallback.onGlyphsRequested(stack, rangeStart, rangeEnd);
}
}
@Keep
private void onTileAction(TileOperation op, int x, int y, int z, int wrap, int overscaledZ, String sourceID) {
if (stateCallback != null) {
stateCallback.onTileAction(op, x, y, z, wrap, overscaledZ, sourceID);
}
}
@Keep
private void onSpriteLoaded(String id, String url) {
if (stateCallback != null) {
stateCallback.onSpriteLoaded(id, url);
}
}
@Keep
private void onSpriteError(String id, String url) {
if (stateCallback != null) {
stateCallback.onSpriteError(id, url);
}
}
@Keep
private void onSpriteRequested(String id, String url) {
if (stateCallback != null) {
stateCallback.onSpriteRequested(id, url);
}
}
//
// JNI methods
//
@@ -1621,5 +1692,25 @@ final class NativeMapView implements NativeMap {
void onStyleImageMissing(String imageId);
boolean onCanRemoveUnusedStyleImage(String imageId);
void onPreCompileShader(int id, int type, String additionalDefines);
void onPostCompileShader(int id, int type, String additionalDefines);
void onShaderCompileFailed(int id, int type, String additionalDefines);
void onGlyphsLoaded(String[] stack, int rangeStart, int rangeEnd);
void onGlyphsError(String[] stack, int rangeStart, int rangeEnd);
void onGlyphsRequested(String[] stack, int rangeStart, int rangeEnd);
void onTileAction(TileOperation op, int x, int y, int z, int wrap, int overscaledZ, String sourceID);
void onSpriteLoaded(String id, String url);
void onSpriteError(String id, String url);
void onSpriteRequested(String id, String url);
}
}

View File

@@ -0,0 +1,13 @@
package org.maplibre.android.tile;
public enum TileOperation {
RequestedFromCache,
RequestedFromNetwork,
LoadFromNetwork,
LoadFromCache,
StartParse,
EndParse,
Error,
Cancelled,
NullOp,
}