diff --git a/CHANGELOG.md b/CHANGELOG.md index 413447b..f0cc6d8 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,36 @@ +## [5.0.0-dev.1] +- FEATURE: Add maxClusterZoom option to prevent clusters from being formed + above a certain zoom. +- FEATURE: Added SuperclusterScope and SuperclusterState.of(context) methods. + This allows accessing of the supercluster layer state from children of the + relevant SuperclusterScope. For example if you wrap your Scaffold in + SuperclusterScope() and the scaffold contains a FlutterMap with a + SuperclusterLayer you will be able to access the state of the layer from + children of Scaffold. +- FEATURE: Added addAll() and removeAll() to SuperclusterMutableController for + efficiently adding/removing multiple markers at once. +- FEATURE: SuperclusterMutableController's add/remove methods now fully + recluster markers affected by an addition/removal. +- FEATURE: The indexBuilder option now defaults to building in the root index. +- FEATURE: Popups will now be hidden automatically when removing their Marker. +- FEATURE: Splayed clusters will now be collapsed automatically when removing + one of their points or inserting a point which causes the splay cluster to + change. +- FEATURE: flutter_map 6.0.0-dev.1. +- FEATURE: flutter_map_marker_popup v5.3.0-dev.1 +- FEATURE: supercluster v3.0.0. +- DEPRECATION: SuperclusterLayer's anchor has been renamed to clusterAnchorPos. +- CHORE: Example app tidy-up. Added desktop platforms and renamed/simplified + examples. + +Note that this version included major changes internally. I was close to +completing this verison before I noticed some issues with how FlutterMap works +which required a huge refactor of FlutterMap. That PR has taken quite some time +which put this version on hold. As a result I have come back to some incomplete +changes and there may be breaking changes or deprecations missing in the +CHANGELOG despite my best efforts to list them all. If you notice something +don't hesitate to open an issue. + ## [4.3.0] - FEATURE: flutter_map 5.0.0 diff --git a/README.md b/README.md index 6718c75..7c58bd6 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ -# Flutter Map Supercluster (previously `flutter_map_fast_cluster`) +# Flutter Map Supercluster Two different Marker clustering layers for [flutter_map](https://github.com/fleaflet/flutter_map): -- `SuperclusterImmutableLayer`: An extremely fast Marker clustering layer, Markers may not be +- `SuperclusterLayer.immutable`: An extremely fast Marker clustering layer, Markers may not be added/removed. -- `SuperclusterMutableLayer`: An slightly slower (but still very fast) Marker clustering layer. +- `SuperclusterLayer.mutable`: A slightly slower (but still very fast) Marker clustering layer. Markers can be added/removed. -If you want beautiful clustering animations check out `flutter_map_marker_plugin`. It will perform -well for quite a lot of Markers on most devices. If you are running in to performance issues and are -happy to sacrifice animations then this package may be for you. +![Example](https://github.com/rorystephenson/project_gifs/blob/master/flutter_map_supercluster/demo.gif) ## Usage diff --git a/example/.metadata b/example/.metadata index c74e7ef..30d90a7 100755 --- a/example/.metadata +++ b/example/.metadata @@ -1,10 +1,45 @@ # This file tracks properties of this Flutter project. # Used by Flutter tool to assess capabilities and perform upgrades etc. # -# This file should be version controlled and should not be manually edited. +# This file should be version controlled. version: - revision: 824b1ad3f862d4c9661f7d1e601d8df8915400a6 - channel: master + revision: 796c8ef79279f9c774545b3771238c3098dbefab + channel: stable project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + - platform: android + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + - platform: ios + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + - platform: linux + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + - platform: macos + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + - platform: web + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + - platform: windows + create_revision: 796c8ef79279f9c774545b3771238c3098dbefab + base_revision: 796c8ef79279f9c774545b3771238c3098dbefab + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle index ac1586d..f5caada 100755 --- a/example/android/app/build.gradle +++ b/example/android/app/build.gradle @@ -33,8 +33,7 @@ android { } defaultConfig { - // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). - applicationId "com.example.flutter_map_supercluster_example" + applicationId "ng.balanci.flutter_map_supercluster_example" minSdkVersion 16 targetSdkVersion 30 versionCode flutterVersionCode.toInteger() diff --git a/example/android/app/src/debug/AndroidManifest.xml b/example/android/app/src/debug/AndroidManifest.xml index 91e0f08..e71a55f 100755 --- a/example/android/app/src/debug/AndroidManifest.xml +++ b/example/android/app/src/debug/AndroidManifest.xml @@ -1,5 +1,5 @@ + package="ng.balanci.flutter_map_supercluster_example"> diff --git a/example/android/app/src/main/AndroidManifest.xml b/example/android/app/src/main/AndroidManifest.xml index 45d4053..d939baf 100755 --- a/example/android/app/src/main/AndroidManifest.xml +++ b/example/android/app/src/main/AndroidManifest.xml @@ -1,5 +1,5 @@ + package="ng.balanci.flutter_map_supercluster_example"> + + diff --git a/example/android/app/src/main/kotlin/com/example/flutter_map_marker_cluster_example/MainActivity.kt b/example/android/app/src/main/kotlin/com/example/flutter_map_marker_cluster_example/MainActivity.kt index dd9d928..6314125 100755 --- a/example/android/app/src/main/kotlin/com/example/flutter_map_marker_cluster_example/MainActivity.kt +++ b/example/android/app/src/main/kotlin/com/example/flutter_map_marker_cluster_example/MainActivity.kt @@ -1,4 +1,4 @@ -package com.example.flutter_map_supercluster_example +package ng.balanci.flutter_map_supercluster_example import io.flutter.embedding.android.FlutterActivity diff --git a/example/android/app/src/main/kotlin/ng/balanci/example/MainActivity.kt b/example/android/app/src/main/kotlin/ng/balanci/example/MainActivity.kt new file mode 100644 index 0000000..18fecbd --- /dev/null +++ b/example/android/app/src/main/kotlin/ng/balanci/example/MainActivity.kt @@ -0,0 +1,6 @@ +package ng.balanci.example + +import io.flutter.embedding.android.FlutterActivity + +class MainActivity: FlutterActivity() { +} diff --git a/example/android/app/src/profile/AndroidManifest.xml b/example/android/app/src/profile/AndroidManifest.xml index 91e0f08..e71a55f 100755 --- a/example/android/app/src/profile/AndroidManifest.xml +++ b/example/android/app/src/profile/AndroidManifest.xml @@ -1,5 +1,5 @@ + package="ng.balanci.flutter_map_supercluster_example"> diff --git a/example/android/gradle.properties b/example/android/gradle.properties index 94adc3a..9410ec1 100755 --- a/example/android/gradle.properties +++ b/example/android/gradle.properties @@ -1,3 +1,3 @@ -org.gradle.jvmargs=-Xmx1536M +org.gradle.jvmargs=-Xmx1536M --add-exports=java.base/sun.nio.ch=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-exports=jdk.unsupported/sun.misc=ALL-UNNAMED android.useAndroidX=true android.enableJetifier=true diff --git a/example/ios/Runner.xcodeproj/project.pbxproj b/example/ios/Runner.xcodeproj/project.pbxproj index 8764d9e..0db93f9 100755 --- a/example/ios/Runner.xcodeproj/project.pbxproj +++ b/example/ios/Runner.xcodeproj/project.pbxproj @@ -291,7 +291,7 @@ ENABLE_BITCODE = NO; INFOPLIST_FILE = Runner/Info.plist; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterMapMarkerClusterExample; + PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.flutterMapMarkerClusterExample; PRODUCT_NAME = "$(TARGET_NAME)"; SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; SWIFT_VERSION = 5.0; @@ -415,7 +415,7 @@ ENABLE_BITCODE = NO; INFOPLIST_FILE = Runner/Info.plist; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterMapMarkerClusterExample; + PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.flutterMapMarkerClusterExample; PRODUCT_NAME = "$(TARGET_NAME)"; SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; @@ -434,7 +434,7 @@ ENABLE_BITCODE = NO; INFOPLIST_FILE = Runner/Info.plist; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterMapMarkerClusterExample; + PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.flutterMapMarkerClusterExample; PRODUCT_NAME = "$(TARGET_NAME)"; SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; SWIFT_VERSION = 5.0; diff --git a/example/ios/RunnerTests/RunnerTests.swift b/example/ios/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..86a7c3b --- /dev/null +++ b/example/ios/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Flutter +import UIKit +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/example/lib/basic_example_page.dart b/example/lib/basic_example_page.dart new file mode 100644 index 0000000..864e5b1 --- /dev/null +++ b/example/lib/basic_example_page.dart @@ -0,0 +1,70 @@ +import 'dart:math'; + +import 'package:flutter/material.dart'; +import 'package:flutter_map/plugin_api.dart'; +import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; +import 'package:flutter_map_supercluster_example/drawer.dart'; +import 'package:flutter_map_supercluster_example/main.dart'; +import 'package:latlong2/latlong.dart'; + +class BasicExamplePage extends StatelessWidget { + static const String route = 'basicExamplePage'; + + static const _totalMarkers = 3000; + static final _random = Random(42); + static const _initialCenter = LatLng(42.0, 10.0); + static final _markers = List.generate( + _totalMarkers, + (_) => Marker( + builder: (context) => const Icon(Icons.location_on), + point: LatLng( + _random.nextDouble() * 3 - 1.5 + _initialCenter.latitude, + _random.nextDouble() * 3 - 1.5 + _initialCenter.longitude, + ), + ), + ); + + const BasicExamplePage({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar(title: const Text('Basic Example')), + drawer: buildDrawer(context, route), + body: FlutterMap( + options: const MapOptions( + initialCenter: _initialCenter, + initialZoom: 8, + maxZoom: 19, + ), + children: [ + TileLayer( + urlTemplate: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', + subdomains: const ['a', 'b', 'c'], + userAgentPackageName: tileLayerPackageName, + ), + SuperclusterLayer.immutable( + initialMarkers: _markers, + indexBuilder: IndexBuilders.computeWithOriginalMarkers, + clusterWidgetSize: const Size(40, 40), + maxClusterRadius: 120, + clusterAnchorPos: const AnchorPos.align(AnchorAlign.center), + builder: (context, position, markerCount, extraClusterData) { + return Container( + decoration: BoxDecoration( + borderRadius: BorderRadius.circular(20.0), + color: Colors.blue), + child: Center( + child: Text( + markerCount.toString(), + style: const TextStyle(color: Colors.white), + ), + ), + ); + }, + ), + ], + ), + ); + } +} diff --git a/example/lib/too_close_to_uncluster_page.dart b/example/lib/cluster_splaying_page.dart similarity index 72% rename from example/lib/too_close_to_uncluster_page.dart rename to example/lib/cluster_splaying_page.dart index e9d3e6d..f942d5d 100644 --- a/example/lib/too_close_to_uncluster_page.dart +++ b/example/lib/cluster_splaying_page.dart @@ -7,35 +7,46 @@ import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; import 'package:flutter_map_supercluster_example/drawer.dart'; import 'package:latlong2/latlong.dart'; -class TooCloseToUnclusterPage extends StatefulWidget { - static const String route = 'tooCloseToUnclusterPage'; +class ClusterSplayingPage extends StatefulWidget { + static const String route = 'clusterSplayingPage'; - const TooCloseToUnclusterPage({Key? key}) : super(key: key); + const ClusterSplayingPage({Key? key}) : super(key: key); @override - State createState() => - _TooCloseToUnclusterPageState(); + State createState() => _ClusterSplayingPageState(); } -class _TooCloseToUnclusterPageState extends State +class _ClusterSplayingPageState extends State with TickerProviderStateMixin { late final SuperclusterImmutableController _superclusterController; late final AnimatedMapController _animatedMapController; - static final points = [ - const LatLng(51.4001, -0.08001), - const LatLng(51.4003, -0.08003), - const LatLng(51.4005, -0.08005), - const LatLng(51.4006, -0.08006), - const LatLng(51.4009, -0.08009), - const LatLng(51.5, -0.09), - const LatLng(51.5, -0.09), - const LatLng(51.5, -0.09), - const LatLng(51.5, -0.09), - const LatLng(51.5, -0.09), - const LatLng(51.59, -0.099), + static const points = [ + LatLng(51.4001, -0.08001), + LatLng(51.4003, -0.08003), + LatLng(51.4005, -0.08005), + LatLng(51.4006, -0.08006), + LatLng(51.4009, -0.08009), + LatLng(51.5, -0.09), + LatLng(51.5, -0.09), + LatLng(51.5, -0.09), + LatLng(51.5, -0.09), + LatLng(51.5, -0.09), + LatLng(51.59, -0.099), ]; - late List markers; + static final List markers = points + .map( + (point) => Marker( + anchorPos: const AnchorPos.align(AnchorAlign.top), + rotateAlignment: AnchorAlign.top.rotationAlignment, + height: 30, + width: 30, + point: point, + rotate: true, + builder: (ctx) => const Icon(Icons.pin_drop), + ), + ) + .toList(); @override void initState() { @@ -43,20 +54,6 @@ class _TooCloseToUnclusterPageState extends State _superclusterController = SuperclusterImmutableController(); _animatedMapController = AnimatedMapController(vsync: this); - - markers = points - .map( - (point) => Marker( - anchorPos: AnchorPos.align(AnchorAlign.top), - rotateAlignment: AnchorAlign.top.rotationAlignment, - height: 30, - width: 30, - point: point, - rotate: true, - builder: (ctx) => const Icon(Icons.pin_drop), - ), - ) - .toList(); } @override @@ -70,7 +67,7 @@ class _TooCloseToUnclusterPageState extends State Widget build(BuildContext context) { return PopupScope( child: Scaffold( - appBar: AppBar(title: const Text('Too close to uncluster page')), + appBar: AppBar(title: const Text('Cluster Splaying')), floatingActionButton: Column( mainAxisAlignment: MainAxisAlignment.end, children: [ @@ -87,13 +84,13 @@ class _TooCloseToUnclusterPageState extends State ), ], ), - drawer: buildDrawer(context, TooCloseToUnclusterPage.route), + drawer: buildDrawer(context, ClusterSplayingPage.route), body: FlutterMap( mapController: _animatedMapController.mapController, options: MapOptions( - center: const LatLng(51.4931, -0.1003), - zoom: 10, - maxZoom: 15, + initialCenter: const LatLng(51.4931, -0.1003), + initialZoom: 10, + maxZoom: 16, onTap: (_, __) { _superclusterController.collapseSplayedClusters(); }, @@ -112,7 +109,7 @@ class _TooCloseToUnclusterPageState extends State zoom: zoom, ), clusterWidgetSize: const Size(40, 40), - anchor: AnchorPos.align(AnchorAlign.center), + clusterAnchorPos: const AnchorPos.align(AnchorAlign.center), popupOptions: PopupOptions( selectedMarkerBuilder: (context, marker) => const Icon( Icons.pin_drop, diff --git a/example/lib/drawer.dart b/example/lib/drawer.dart index 8662ea0..146f175 100644 --- a/example/lib/drawer.dart +++ b/example/lib/drawer.dart @@ -1,8 +1,8 @@ import 'package:flutter/material.dart'; -import 'package:flutter_map_supercluster_example/immutable_clustering_page.dart'; -import 'package:flutter_map_supercluster_example/mutable_clustering_page.dart'; +import 'package:flutter_map_supercluster_example/basic_example_page.dart'; +import 'package:flutter_map_supercluster_example/cluster_splaying_page.dart'; +import 'package:flutter_map_supercluster_example/mutable_clusters_page.dart'; import 'package:flutter_map_supercluster_example/normal_and_clustered_markers_with_popups_page.dart'; -import 'package:flutter_map_supercluster_example/too_close_to_uncluster_page.dart'; Widget _buildMenuItem( BuildContext context, Widget title, String routeName, String currentRoute) { @@ -32,26 +32,26 @@ Drawer buildDrawer(BuildContext context, String currentRoute) { ), _buildMenuItem( context, - const Text('Clustering (mutable)'), - MutableClusteringPage.route, + const Text('Basic Example'), + BasicExamplePage.route, currentRoute, ), _buildMenuItem( context, - const Text('Clustering Many Markers (Immutable)'), - ClusteringManyMarkersPage.route, + const Text('Mutable Clustering'), + MutableClustersPage.route, currentRoute, ), _buildMenuItem( context, - const Text('Too close to uncluster'), - TooCloseToUnclusterPage.route, + const Text('Cluster Splaying'), + ClusterSplayingPage.route, currentRoute, ), _buildMenuItem( context, const Text('Normal and Clustered Markers With Popups'), - NormalAndClusteredMarkersWithPopups.route, + NormalAndClusteredMarkersWithPopupsPage.route, currentRoute, ), ], diff --git a/example/lib/immutable_clustering_page.dart b/example/lib/immutable_clustering_page.dart deleted file mode 100644 index 828bbf1..0000000 --- a/example/lib/immutable_clustering_page.dart +++ /dev/null @@ -1,165 +0,0 @@ -import 'dart:math'; - -import 'package:flutter/material.dart'; -import 'package:flutter_map/plugin_api.dart'; -import 'package:flutter_map_animations/flutter_map_animations.dart'; -import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; -import 'package:flutter_map_supercluster_example/drawer.dart'; -import 'package:latlong2/latlong.dart'; - -class ClusteringManyMarkersPage extends StatefulWidget { - static const String route = 'clusteringManyMarkersPage'; - - const ClusteringManyMarkersPage({Key? key}) : super(key: key); - - @override - State createState() => - _ClusteringManyMarkersPageState(); -} - -class _ClusteringManyMarkersPageState extends State - with TickerProviderStateMixin { - static const totalMarkers = 2000.0; - final minLatLng = const LatLng(49.8566, 1.3522); - final maxLatLng = const LatLng(58.3498, -10.2603); - - late final SuperclusterImmutableController _superclusterController; - late final AnimatedMapController _animatedMapController; - - late final List markers; - - @override - void initState() { - _superclusterController = SuperclusterImmutableController(); - _animatedMapController = AnimatedMapController(vsync: this); - - final latitudeRange = maxLatLng.latitude - minLatLng.latitude; - final longitudeRange = maxLatLng.longitude - minLatLng.longitude; - - final stepsInEachDirection = sqrt(totalMarkers).floor(); - final latStep = latitudeRange / stepsInEachDirection; - final lonStep = longitudeRange / stepsInEachDirection; - - markers = []; - for (var i = 0; i < stepsInEachDirection; i++) { - for (var j = 0; j < stepsInEachDirection; j++) { - final latLng = LatLng( - minLatLng.latitude + i * latStep, - minLatLng.longitude + j * lonStep, - ); - - markers.add( - Marker( - anchorPos: AnchorPos.align(AnchorAlign.top), - rotateAlignment: AnchorAlign.top.rotationAlignment, - height: 30, - width: 30, - point: latLng, - builder: (ctx) => const Icon(Icons.pin_drop), - ), - ); - } - } - - super.initState(); - } - - @override - void dispose() { - _superclusterController.dispose(); - _animatedMapController.dispose(); - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return Scaffold( - appBar: AppBar( - title: const Text('Clustering Many Markers Page'), - actions: [ - StreamBuilder( - stream: _superclusterController.stateStream, - builder: (context, snapshot) { - final data = snapshot.data; - final String markerCountLabel; - if (data == null || - data.loading || - data.aggregatedClusterData == null) { - markerCountLabel = '...'; - } else { - markerCountLabel = - data.aggregatedClusterData!.markerCount.toString(); - } - - return Center( - child: Padding( - padding: const EdgeInsets.only(right: 20), - child: Text('Total markers: $markerCountLabel'), - ), - ); - }), - ], - ), - drawer: buildDrawer(context, ClusteringManyMarkersPage.route), - body: FlutterMap( - mapController: _animatedMapController.mapController, - options: MapOptions( - center: LatLng((maxLatLng.latitude + minLatLng.latitude) / 2, - (maxLatLng.longitude + minLatLng.longitude) / 2), - zoom: 6, - maxZoom: 15, - ), - nonRotatedChildren: [ - Builder( - builder: (context) => - Text(FlutterMapState.maybeOf(context)!.zoom.toString()), - ) - ], - children: [ - TileLayer( - urlTemplate: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', - subdomains: const ['a', 'b', 'c'], - ), - SuperclusterLayer.immutable( - initialMarkers: markers, - indexBuilder: IndexBuilders.computeWithOriginalMarkers, - controller: _superclusterController, - moveMap: (center, zoom) => _animatedMapController.animateTo( - dest: center, - zoom: zoom, - ), - calculateAggregatedClusterData: true, - clusterWidgetSize: const Size(40, 40), - anchor: AnchorPos.align(AnchorAlign.center), - popupOptions: PopupOptions( - selectedMarkerBuilder: (context, marker) => const Icon( - Icons.pin_drop, - color: Colors.red, - ), - popupDisplayOptions: PopupDisplayOptions( - builder: (BuildContext context, Marker marker) => Container( - color: Colors.white, - child: Text(marker.point.toString()), - ), - ), - ), - builder: (context, position, markerCount, extraClusterData) { - return Container( - decoration: BoxDecoration( - borderRadius: BorderRadius.circular(20.0), - color: Colors.blue), - child: Center( - child: Text( - markerCount.toString(), - style: const TextStyle(color: Colors.white), - ), - ), - ); - }, - ), - ], - ), - ); - } -} diff --git a/example/lib/main.dart b/example/lib/main.dart index 697225b..e9bba2b 100755 --- a/example/lib/main.dart +++ b/example/lib/main.dart @@ -1,11 +1,13 @@ import 'package:flutter/material.dart'; -import 'package:flutter_map_supercluster_example/immutable_clustering_page.dart'; -import 'package:flutter_map_supercluster_example/mutable_clustering_page.dart'; +import 'package:flutter_map_supercluster_example/basic_example_page.dart'; +import 'package:flutter_map_supercluster_example/cluster_splaying_page.dart'; +import 'package:flutter_map_supercluster_example/mutable_clusters_page.dart'; import 'package:flutter_map_supercluster_example/normal_and_clustered_markers_with_popups_page.dart'; -import 'package:flutter_map_supercluster_example/too_close_to_uncluster_page.dart'; void main() => runApp(const MyApp()); +const tileLayerPackageName = 'ng.balanci.flutter_map_supercluster.example'; + class MyApp extends StatelessWidget { const MyApp({Key? key}) : super(key: key); @@ -16,15 +18,13 @@ class MyApp extends StatelessWidget { theme: ThemeData( primarySwatch: Colors.blue, ), - home: const MutableClusteringPage(), + home: const BasicExamplePage(), routes: { - MutableClusteringPage.route: (context) => const MutableClusteringPage(), - ClusteringManyMarkersPage.route: (context) => - const ClusteringManyMarkersPage(), - TooCloseToUnclusterPage.route: (context) => - const TooCloseToUnclusterPage(), - NormalAndClusteredMarkersWithPopups.route: (context) => - const NormalAndClusteredMarkersWithPopups(), + BasicExamplePage.route: (context) => const BasicExamplePage(), + MutableClustersPage.route: (context) => const MutableClustersPage(), + ClusterSplayingPage.route: (context) => const ClusterSplayingPage(), + NormalAndClusteredMarkersWithPopupsPage.route: (context) => + const NormalAndClusteredMarkersWithPopupsPage(), }, ); } diff --git a/example/lib/mutable_clustering_page.dart b/example/lib/mutable_clustering_page.dart deleted file mode 100644 index f7da667..0000000 --- a/example/lib/mutable_clustering_page.dart +++ /dev/null @@ -1,145 +0,0 @@ -import 'package:flutter/material.dart'; -import 'package:flutter_map/plugin_api.dart'; -import 'package:flutter_map_animations/flutter_map_animations.dart'; -import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; -import 'package:flutter_map_supercluster_example/drawer.dart'; -import 'package:flutter_map_supercluster_example/font/accurate_map_icons.dart'; -import 'package:latlong2/latlong.dart'; - -class MutableClusteringPage extends StatefulWidget { - static const String route = 'mutableClusteringPage'; - - const MutableClusteringPage({Key? key}) : super(key: key); - - @override - State createState() => _MutableClusteringPageState(); -} - -class _MutableClusteringPageState extends State - with TickerProviderStateMixin { - late final SuperclusterMutableController _superclusterController; - late final AnimatedMapController _animatedMapController; - - final List _initialMarkers = [ - const LatLng(51.5, -0.09), - const LatLng(53.3498, -6.2603), - const LatLng(53.3488, -6.2613) - ].map((point) => _createMarker(point, Colors.black)).toList(); - - @override - void initState() { - _superclusterController = SuperclusterMutableController(); - _animatedMapController = AnimatedMapController(vsync: this); - - super.initState(); - } - - @override - void dispose() { - _superclusterController.dispose(); - _animatedMapController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return Scaffold( - appBar: AppBar( - title: const Text('Clustering Page (Mutable)'), - actions: [ - StreamBuilder( - stream: _superclusterController.stateStream, - builder: (context, snapshot) { - final data = snapshot.data; - final String markerCountLabel; - if (data == null || - data.loading || - data.aggregatedClusterData == null) { - markerCountLabel = '...'; - } else { - markerCountLabel = - data.aggregatedClusterData!.markerCount.toString(); - } - - return Center( - child: Padding( - padding: const EdgeInsets.only(right: 20), - child: Text('Total markers: $markerCountLabel'), - ), - ); - }), - ], - ), - drawer: buildDrawer(context, MutableClusteringPage.route), - floatingActionButton: FloatingActionButton( - onPressed: () { - setState(() { - _superclusterController.replaceAll(_initialMarkers); - }); - }, - child: const Icon(Icons.refresh), - ), - body: FlutterMap( - mapController: _animatedMapController.mapController, - options: MapOptions( - center: _initialMarkers[0].point, - zoom: 5, - maxZoom: 15, - onTap: (_, latLng) { - debugPrint(latLng.toString()); - _superclusterController.add(_createMarker(latLng, Colors.blue)); - }, - ), - children: [ - TileLayer( - urlTemplate: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', - subdomains: const ['a', 'b', 'c'], - ), - SuperclusterLayer.mutable( - initialMarkers: _initialMarkers, - indexBuilder: IndexBuilders.rootIsolate, - controller: _superclusterController, - moveMap: (center, zoom) => _animatedMapController.animateTo( - dest: center, - zoom: zoom, - ), - onMarkerTap: (marker) { - _superclusterController.remove(marker); - }, - clusterWidgetSize: const Size(40, 40), - anchor: AnchorPos.align(AnchorAlign.center), - calculateAggregatedClusterData: true, - builder: (context, position, markerCount, extraClusterData) { - return Container( - decoration: BoxDecoration( - borderRadius: BorderRadius.circular(20.0), - color: Colors.blue, - ), - child: Center( - child: Text( - markerCount.toString(), - style: const TextStyle(color: Colors.white), - ), - ), - ); - }, - ), - ], - ), - ); - } - - static Marker _createMarker(LatLng point, Color color) => Marker( - anchorPos: AnchorPos.align(AnchorAlign.top), - rotate: true, - rotateAlignment: AnchorAlign.top.rotationAlignment, - height: 30, - width: 30, - point: point, - builder: (ctx) => Icon( - AccurateMapIcons.locationOnBottomAligned, - color: color, - size: 30, - ), - ); -} diff --git a/example/lib/mutable_clusters_page.dart b/example/lib/mutable_clusters_page.dart new file mode 100644 index 0000000..0f85855 --- /dev/null +++ b/example/lib/mutable_clusters_page.dart @@ -0,0 +1,195 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_map/plugin_api.dart'; +import 'package:flutter_map_animations/flutter_map_animations.dart'; +import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; +import 'package:flutter_map_supercluster_example/drawer.dart'; +import 'package:flutter_map_supercluster_example/font/accurate_map_icons.dart'; +import 'package:flutter_map_supercluster_example/main.dart'; +import 'package:latlong2/latlong.dart'; + +class MutableClustersPage extends StatefulWidget { + static const String route = 'mutableClustersPage'; + + const MutableClustersPage({Key? key}) : super(key: key); + + @override + State createState() => _MutableClustersPageState(); +} + +class _MutableClustersPageState extends State + with TickerProviderStateMixin { + late final SuperclusterMutableController _superclusterController; + late final AnimatedMapController _animatedMapController; + + final List _initialMarkers = [ + const LatLng(51.5, -0.09), + const LatLng(53.3498, -6.2603), + const LatLng(53.3488, -6.2613) + ].map((point) => _createMarker(point, Colors.black)).toList(); + + @override + void initState() { + _superclusterController = SuperclusterMutableController(); + _animatedMapController = AnimatedMapController(vsync: this); + + super.initState(); + } + + @override + void dispose() { + _superclusterController.dispose(); + _animatedMapController.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return SuperclusterScope( + child: Scaffold( + appBar: AppBar( + title: const Text('Mutable Clusters'), + actions: [ + Builder(builder: (context) { + final data = SuperclusterState.of(context); + final String markerCountLabel; + if (data.loading) { + markerCountLabel = '...'; + } else { + markerCountLabel = + (data.aggregatedClusterData?.markerCount ?? 0).toString(); + } + + return Center( + child: Padding( + padding: const EdgeInsets.only(right: 20), + child: Text('Total:\n$markerCountLabel'), + ), + ); + }), + ], + ), + drawer: buildDrawer(context, MutableClustersPage.route), + floatingActionButton: Column( + mainAxisAlignment: MainAxisAlignment.end, + children: [ + FloatingActionButton( + heroTag: 'clear', + onPressed: () { + setState(() { + _superclusterController.clear(); + }); + }, + child: const Icon(Icons.clear_all), + ), + const SizedBox(height: 12), + FloatingActionButton( + heroTag: 'reset', + onPressed: () { + setState(() { + _superclusterController.replaceAll(_initialMarkers); + }); + }, + child: const Icon(Icons.refresh), + ), + ], + ), + body: FlutterMap( + mapController: _animatedMapController.mapController, + options: MapOptions( + initialCenter: _initialMarkers[0].point, + initialZoom: 5, + maxZoom: 15, + onTap: (_, latLng) { + debugPrint(latLng.toString()); + _superclusterController.add(_createMarker(latLng, Colors.blue)); + }, + ), + children: [ + TileLayer( + urlTemplate: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', + subdomains: const ['a', 'b', 'c'], + userAgentPackageName: tileLayerPackageName, + ), + SuperclusterLayer.mutable( + initialMarkers: _initialMarkers, + indexBuilder: IndexBuilders.rootIsolate, + loadingOverlayBuilder: (_) => const SizedBox.shrink(), + controller: _superclusterController, + moveMap: (center, zoom) => _animatedMapController.animateTo( + dest: center, + zoom: zoom, + ), + popupOptions: PopupOptions( + popupDisplayOptions: PopupDisplayOptions( + builder: (context, marker) => GestureDetector( + onTap: () => _superclusterController.remove(marker), + child: Card( + child: SizedBox( + width: 250, + child: Padding( + padding: const EdgeInsets.symmetric( + vertical: 12, + horizontal: 8, + ), + child: Row( + children: [ + Padding( + padding: const EdgeInsets.symmetric( + horizontal: 12, + ), + child: Icon( + Icons.delete, + color: Colors.grey.shade600, + )), + const Expanded( + child: Text( + 'Tap this popup to remove the marker. Tap the marker again to close this popup.', + softWrap: true, + ), + ), + ], + ), + ), + ), + ), + ), + ), + ), + clusterWidgetSize: const Size(40, 40), + clusterAnchorPos: const AnchorPos.align(AnchorAlign.center), + calculateAggregatedClusterData: true, + builder: (context, position, markerCount, extraClusterData) { + return Container( + decoration: BoxDecoration( + borderRadius: BorderRadius.circular(20.0), + color: Colors.blue, + ), + child: Center( + child: Text( + markerCount.toString(), + style: const TextStyle(color: Colors.white), + ), + ), + ); + }, + ), + ], + ), + ), + ); + } + + static Marker _createMarker(LatLng point, Color color) => Marker( + anchorPos: const AnchorPos.align(AnchorAlign.top), + rotate: true, + rotateAlignment: AnchorAlign.top.rotationAlignment, + height: 30, + width: 30, + point: point, + builder: (ctx) => Icon( + AccurateMapIcons.locationOnBottomAligned, + color: color, + size: 30, + ), + ); +} diff --git a/example/lib/normal_and_clustered_markers_with_popups_page.dart b/example/lib/normal_and_clustered_markers_with_popups_page.dart index e0f010b..6d22b3c 100644 --- a/example/lib/normal_and_clustered_markers_with_popups_page.dart +++ b/example/lib/normal_and_clustered_markers_with_popups_page.dart @@ -3,26 +3,27 @@ import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_marker_popup/flutter_map_marker_popup.dart'; import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; import 'package:flutter_map_supercluster_example/drawer.dart'; +import 'package:flutter_map_supercluster_example/main.dart'; import 'package:latlong2/latlong.dart'; -class NormalAndClusteredMarkersWithPopups extends StatefulWidget { - static const String route = 'normalAndClusteredMarkersWithPopupPage'; +class NormalAndClusteredMarkersWithPopupsPage extends StatefulWidget { + static const String route = 'normalAndClusteredMarkersWithPopupsPage'; - const NormalAndClusteredMarkersWithPopups({Key? key}) : super(key: key); + const NormalAndClusteredMarkersWithPopupsPage({Key? key}) : super(key: key); @override - State createState() => - _NormalAndClusteredMarkersWithPopupsState(); + State createState() => + _NormalAndClusteredMarkersWithPopupsPageState(); } -class _NormalAndClusteredMarkersWithPopupsState - extends State { +class _NormalAndClusteredMarkersWithPopupsPageState + extends State { late final SuperclusterImmutableController _superclusterController; late final PopupController _popupController; - static final points = [ - const LatLng(51.5, 0), - const LatLng(51.0, 0.5), + static const points = [ + LatLng(51.5, 0), + LatLng(51.0, 0.5), ]; late List markersA; late List markersB; @@ -42,7 +43,7 @@ class _NormalAndClusteredMarkersWithPopupsState } Marker _createMarker(LatLng point, Color color) => Marker( - anchorPos: AnchorPos.align(AnchorAlign.top), + anchorPos: const AnchorPos.align(AnchorAlign.top), rotateAlignment: AnchorAlign.top.rotationAlignment, height: 30, width: 30, @@ -63,7 +64,8 @@ class _NormalAndClusteredMarkersWithPopupsState return Scaffold( appBar: AppBar(title: const Text('Normal and Clustered Markers With Popups')), - drawer: buildDrawer(context, NormalAndClusteredMarkersWithPopups.route), + drawer: + buildDrawer(context, NormalAndClusteredMarkersWithPopupsPage.route), body: PopupScope( popupController: _popupController, onPopupEvent: (event, selectedMarkers) => debugPrint( @@ -71,8 +73,8 @@ class _NormalAndClusteredMarkersWithPopupsState ), child: FlutterMap( options: MapOptions( - center: points[0], - zoom: 5, + initialCenter: points[0], + initialZoom: 5, maxZoom: 15, onTap: (_, __) { _popupController.hideAllPopups(); @@ -82,13 +84,14 @@ class _NormalAndClusteredMarkersWithPopupsState TileLayer( urlTemplate: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', subdomains: const ['a', 'b', 'c'], + userAgentPackageName: tileLayerPackageName, ), SuperclusterLayer.immutable( initialMarkers: markersA, indexBuilder: IndexBuilders.rootIsolate, controller: _superclusterController, clusterWidgetSize: const Size(40, 40), - anchor: AnchorPos.align(AnchorAlign.center), + clusterAnchorPos: const AnchorPos.align(AnchorAlign.center), popupOptions: PopupOptions( selectedMarkerBuilder: (context, marker) => Icon( Icons.pin_drop, diff --git a/example/linux/.gitignore b/example/linux/.gitignore new file mode 100644 index 0000000..d3896c9 --- /dev/null +++ b/example/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/example/linux/CMakeLists.txt b/example/linux/CMakeLists.txt new file mode 100644 index 0000000..6e718d1 --- /dev/null +++ b/example/linux/CMakeLists.txt @@ -0,0 +1,139 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.10) +project(runner LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "example") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "ng.balanci.example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Load bundled libraries from the lib/ directory relative to the binary. +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Root filesystem for cross-building. +if(FLUTTER_TARGET_PLATFORM_SYSROOT) + set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + +# Define build configuration options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Define the application target. To change its name, change BINARY_NAME above, +# not the value here, or `flutter run` will no longer work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) + +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) + install(FILES "${bundled_library}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endforeach(bundled_library) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/example/linux/flutter/CMakeLists.txt b/example/linux/flutter/CMakeLists.txt new file mode 100644 index 0000000..d5bd016 --- /dev/null +++ b/example/linux/flutter/CMakeLists.txt @@ -0,0 +1,88 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/example/linux/flutter/generated_plugin_registrant.cc b/example/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..e71a16d --- /dev/null +++ b/example/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void fl_register_plugins(FlPluginRegistry* registry) { +} diff --git a/example/linux/flutter/generated_plugin_registrant.h b/example/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..e0f0a47 --- /dev/null +++ b/example/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/linux/flutter/generated_plugins.cmake b/example/linux/flutter/generated_plugins.cmake new file mode 100644 index 0000000..2e1de87 --- /dev/null +++ b/example/linux/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/example/linux/main.cc b/example/linux/main.cc new file mode 100644 index 0000000..e7c5c54 --- /dev/null +++ b/example/linux/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/example/linux/my_application.cc b/example/linux/my_application.cc new file mode 100644 index 0000000..0ba8f43 --- /dev/null +++ b/example/linux/my_application.cc @@ -0,0 +1,104 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen* screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "example"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } else { + gtk_window_set_title(window, "example"); + } + + gtk_window_set_default_size(window, 1280, 720); + gtk_widget_show(GTK_WIDGET(window)); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments(project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, gchar*** arguments, int* exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject* object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = my_application_local_command_line; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, + "flags", G_APPLICATION_NON_UNIQUE, + nullptr)); +} diff --git a/example/linux/my_application.h b/example/linux/my_application.h new file mode 100644 index 0000000..72271d5 --- /dev/null +++ b/example/linux/my_application.h @@ -0,0 +1,18 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, my_application, MY, APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/example/macos/.gitignore b/example/macos/.gitignore new file mode 100644 index 0000000..746adbb --- /dev/null +++ b/example/macos/.gitignore @@ -0,0 +1,7 @@ +# Flutter-related +**/Flutter/ephemeral/ +**/Pods/ + +# Xcode-related +**/dgph +**/xcuserdata/ diff --git a/example/macos/Runner.xcodeproj/project.pbxproj b/example/macos/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..20254b9 --- /dev/null +++ b/example/macos/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,695 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXAggregateTarget section */ + 33CC111A2044C6BA0003C045 /* Flutter Assemble */ = { + isa = PBXAggregateTarget; + buildConfigurationList = 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */; + buildPhases = ( + 33CC111E2044C6BF0003C045 /* ShellScript */, + ); + dependencies = ( + ); + name = "Flutter Assemble"; + productName = FLX; + }; +/* End PBXAggregateTarget section */ + +/* Begin PBXBuildFile section */ + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C80D7294CF71000263BE5 /* RunnerTests.swift */; }; + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; }; + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC10EC2044A3C60003C045; + remoteInfo = Runner; + }; + 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC111A2044C6BA0003C045; + remoteInfo = FLX; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 33CC110E2044A8840003C045 /* Bundle Framework */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Bundle Framework"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 331C80D7294CF71000263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; + 33CC10ED2044A3C60003C045 /* example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "example.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; + 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; + 33CC10F72044A3C60003C045 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Runner/Info.plist; sourceTree = ""; }; + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MainFlutterWindow.swift; sourceTree = ""; }; + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Debug.xcconfig"; sourceTree = ""; }; + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Release.xcconfig"; sourceTree = ""; }; + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = "Flutter-Generated.xcconfig"; path = "ephemeral/Flutter-Generated.xcconfig"; sourceTree = ""; }; + 33E51913231747F40026EE4D /* DebugProfile.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = DebugProfile.entitlements; sourceTree = ""; }; + 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; + 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 331C80D2294CF70F00263BE5 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EA2044A3C60003C045 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C80D6294CF71000263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C80D7294CF71000263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 33BA886A226E78AF003329D5 /* Configs */ = { + isa = PBXGroup; + children = ( + 33E5194F232828860026EE4D /* AppInfo.xcconfig */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */, + ); + path = Configs; + sourceTree = ""; + }; + 33CC10E42044A3C60003C045 = { + isa = PBXGroup; + children = ( + 33FAB671232836740065AC1E /* Runner */, + 33CEB47122A05771004F2AC0 /* Flutter */, + 331C80D6294CF71000263BE5 /* RunnerTests */, + 33CC10EE2044A3C60003C045 /* Products */, + D73912EC22F37F3D000D13A0 /* Frameworks */, + ); + sourceTree = ""; + }; + 33CC10EE2044A3C60003C045 /* Products */ = { + isa = PBXGroup; + children = ( + 33CC10ED2044A3C60003C045 /* example.app */, + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 33CC11242044D66E0003C045 /* Resources */ = { + isa = PBXGroup; + children = ( + 33CC10F22044A3C60003C045 /* Assets.xcassets */, + 33CC10F42044A3C60003C045 /* MainMenu.xib */, + 33CC10F72044A3C60003C045 /* Info.plist */, + ); + name = Resources; + path = ..; + sourceTree = ""; + }; + 33CEB47122A05771004F2AC0 /* Flutter */ = { + isa = PBXGroup; + children = ( + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */, + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */, + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */, + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */, + ); + path = Flutter; + sourceTree = ""; + }; + 33FAB671232836740065AC1E /* Runner */ = { + isa = PBXGroup; + children = ( + 33CC10F02044A3C60003C045 /* AppDelegate.swift */, + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */, + 33E51913231747F40026EE4D /* DebugProfile.entitlements */, + 33E51914231749380026EE4D /* Release.entitlements */, + 33CC11242044D66E0003C045 /* Resources */, + 33BA886A226E78AF003329D5 /* Configs */, + ); + path = Runner; + sourceTree = ""; + }; + D73912EC22F37F3D000D13A0 /* Frameworks */ = { + isa = PBXGroup; + children = ( + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C80D4294CF70F00263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C80D1294CF70F00263BE5 /* Sources */, + 331C80D2294CF70F00263BE5 /* Frameworks */, + 331C80D3294CF70F00263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C80DA294CF71000263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C80D5294CF71000263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 33CC10EC2044A3C60003C045 /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 33CC10E92044A3C60003C045 /* Sources */, + 33CC10EA2044A3C60003C045 /* Frameworks */, + 33CC10EB2044A3C60003C045 /* Resources */, + 33CC110E2044A8840003C045 /* Bundle Framework */, + 3399D490228B24CF009A79C7 /* ShellScript */, + ); + buildRules = ( + ); + dependencies = ( + 33CC11202044C79F0003C045 /* PBXTargetDependency */, + ); + name = Runner; + productName = Runner; + productReference = 33CC10ED2044A3C60003C045 /* example.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 33CC10E52044A3C60003C045 /* Project object */ = { + isa = PBXProject; + attributes = { + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1300; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C80D4294CF70F00263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 33CC10EC2044A3C60003C045; + }; + 33CC10EC2044A3C60003C045 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + SystemCapabilities = { + com.apple.Sandbox = { + enabled = 1; + }; + }; + }; + 33CC111A2044C6BA0003C045 = { + CreatedOnToolsVersion = 9.2; + ProvisioningStyle = Manual; + }; + }; + }; + buildConfigurationList = 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 33CC10E42044A3C60003C045; + productRefGroup = 33CC10EE2044A3C60003C045 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 33CC10EC2044A3C60003C045 /* Runner */, + 331C80D4294CF70F00263BE5 /* RunnerTests */, + 33CC111A2044C6BA0003C045 /* Flutter Assemble */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C80D3294CF70F00263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EB2044A3C60003C045 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */, + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3399D490228B24CF009A79C7 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "echo \"$PRODUCT_NAME.app\" > \"$PROJECT_DIR\"/Flutter/ephemeral/.app_filename && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh embed\n"; + }; + 33CC111E2044C6BF0003C045 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + Flutter/ephemeral/FlutterInputs.xcfilelist, + ); + inputPaths = ( + Flutter/ephemeral/tripwire, + ); + outputFileListPaths = ( + Flutter/ephemeral/FlutterOutputs.xcfilelist, + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C80D1294CF70F00263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10E92044A3C60003C045 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */, + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */, + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C80DA294CF71000263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC10EC2044A3C60003C045 /* Runner */; + targetProxy = 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */; + }; + 33CC11202044C79F0003C045 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC111A2044C6BA0003C045 /* Flutter Assemble */; + targetProxy = 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 33CC10F42044A3C60003C045 /* MainMenu.xib */ = { + isa = PBXVariantGroup; + children = ( + 33CC10F52044A3C60003C045 /* Base */, + ); + name = MainMenu.xib; + path = Runner; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 331C80DB294CF71000263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.example.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/example.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/example"; + }; + name = Debug; + }; + 331C80DC294CF71000263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.example.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/example.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/example"; + }; + name = Release; + }; + 331C80DD294CF71000263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.example.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/example.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/example"; + }; + name = Profile; + }; + 338D0CE9231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.14; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Profile; + }; + 338D0CEA231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Profile; + }; + 338D0CEB231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Profile; + }; + 33CC10F92044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.14; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = macosx; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 33CC10FA2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.14; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Release; + }; + 33CC10FC2044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + }; + name = Debug; + }; + 33CC10FD2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/Release.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Release; + }; + 33CC111C2044C6BA0003C045 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Debug; + }; + 33CC111D2044C6BA0003C045 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C80DB294CF71000263BE5 /* Debug */, + 331C80DC294CF71000263BE5 /* Release */, + 331C80DD294CF71000263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10F92044A3C60003C045 /* Debug */, + 33CC10FA2044A3C60003C045 /* Release */, + 338D0CE9231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10FC2044A3C60003C045 /* Debug */, + 33CC10FD2044A3C60003C045 /* Release */, + 338D0CEA231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC111C2044C6BA0003C045 /* Debug */, + 33CC111D2044C6BA0003C045 /* Release */, + 338D0CEB231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 33CC10E52044A3C60003C045 /* Project object */; +} diff --git a/example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..8fedab6 --- /dev/null +++ b/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/example/macos/Runner.xcworkspace/contents.xcworkspacedata b/example/macos/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..1d526a1 --- /dev/null +++ b/example/macos/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/example/macos/Runner/AppDelegate.swift b/example/macos/Runner/AppDelegate.swift new file mode 100644 index 0000000..d53ef64 --- /dev/null +++ b/example/macos/Runner/AppDelegate.swift @@ -0,0 +1,9 @@ +import Cocoa +import FlutterMacOS + +@NSApplicationMain +class AppDelegate: FlutterAppDelegate { + override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { + return true + } +} diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..a2ec33f --- /dev/null +++ b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,68 @@ +{ + "images" : [ + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_16.png", + "scale" : "1x" + }, + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "2x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "1x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_64.png", + "scale" : "2x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_128.png", + "scale" : "1x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "2x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "1x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "2x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "1x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_1024.png", + "scale" : "2x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png new file mode 100644 index 0000000..82b6f9d Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png differ diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png new file mode 100644 index 0000000..13b35eb Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png differ diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png new file mode 100644 index 0000000..0a3f5fa Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png differ diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png new file mode 100644 index 0000000..bdb5722 Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png differ diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png new file mode 100644 index 0000000..f083318 Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png differ diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png new file mode 100644 index 0000000..326c0e7 Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png differ diff --git a/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png new file mode 100644 index 0000000..2f1632c Binary files /dev/null and b/example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png differ diff --git a/example/macos/Runner/Base.lproj/MainMenu.xib b/example/macos/Runner/Base.lproj/MainMenu.xib new file mode 100644 index 0000000..80e867a --- /dev/null +++ b/example/macos/Runner/Base.lproj/MainMenu.xib @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/example/macos/Runner/Configs/AppInfo.xcconfig b/example/macos/Runner/Configs/AppInfo.xcconfig new file mode 100644 index 0000000..a362f72 --- /dev/null +++ b/example/macos/Runner/Configs/AppInfo.xcconfig @@ -0,0 +1,14 @@ +// Application-level settings for the Runner target. +// +// This may be replaced with something auto-generated from metadata (e.g., pubspec.yaml) in the +// future. If not, the values below would default to using the project name when this becomes a +// 'flutter create' template. + +// The application's name. By default this is also the title of the Flutter window. +PRODUCT_NAME = example + +// The application's bundle identifier +PRODUCT_BUNDLE_IDENTIFIER = ng.balanci.example + +// The copyright displayed in application information +PRODUCT_COPYRIGHT = Copyright © 2023 ng.balanci. All rights reserved. diff --git a/example/macos/Runner/Configs/Debug.xcconfig b/example/macos/Runner/Configs/Debug.xcconfig new file mode 100644 index 0000000..36b0fd9 --- /dev/null +++ b/example/macos/Runner/Configs/Debug.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Debug.xcconfig" +#include "Warnings.xcconfig" diff --git a/example/macos/Runner/Configs/Release.xcconfig b/example/macos/Runner/Configs/Release.xcconfig new file mode 100644 index 0000000..dff4f49 --- /dev/null +++ b/example/macos/Runner/Configs/Release.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Release.xcconfig" +#include "Warnings.xcconfig" diff --git a/example/macos/Runner/Configs/Warnings.xcconfig b/example/macos/Runner/Configs/Warnings.xcconfig new file mode 100644 index 0000000..42bcbf4 --- /dev/null +++ b/example/macos/Runner/Configs/Warnings.xcconfig @@ -0,0 +1,13 @@ +WARNING_CFLAGS = -Wall -Wconditional-uninitialized -Wnullable-to-nonnull-conversion -Wmissing-method-return-type -Woverlength-strings +GCC_WARN_UNDECLARED_SELECTOR = YES +CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES +CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE +CLANG_WARN__DUPLICATE_METHOD_MATCH = YES +CLANG_WARN_PRAGMA_PACK = YES +CLANG_WARN_STRICT_PROTOTYPES = YES +CLANG_WARN_COMMA = YES +GCC_WARN_STRICT_SELECTOR_MATCH = YES +CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES +CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES +GCC_WARN_SHADOW = YES +CLANG_WARN_UNREACHABLE_CODE = YES diff --git a/example/macos/Runner/DebugProfile.entitlements b/example/macos/Runner/DebugProfile.entitlements new file mode 100644 index 0000000..dddb8a3 --- /dev/null +++ b/example/macos/Runner/DebugProfile.entitlements @@ -0,0 +1,12 @@ + + + + + com.apple.security.app-sandbox + + com.apple.security.cs.allow-jit + + com.apple.security.network.server + + + diff --git a/example/macos/Runner/Info.plist b/example/macos/Runner/Info.plist new file mode 100644 index 0000000..4789daa --- /dev/null +++ b/example/macos/Runner/Info.plist @@ -0,0 +1,32 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIconFile + + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSMinimumSystemVersion + $(MACOSX_DEPLOYMENT_TARGET) + NSHumanReadableCopyright + $(PRODUCT_COPYRIGHT) + NSMainNibFile + MainMenu + NSPrincipalClass + NSApplication + + diff --git a/example/macos/Runner/MainFlutterWindow.swift b/example/macos/Runner/MainFlutterWindow.swift new file mode 100644 index 0000000..3cc05eb --- /dev/null +++ b/example/macos/Runner/MainFlutterWindow.swift @@ -0,0 +1,15 @@ +import Cocoa +import FlutterMacOS + +class MainFlutterWindow: NSWindow { + override func awakeFromNib() { + let flutterViewController = FlutterViewController() + let windowFrame = self.frame + self.contentViewController = flutterViewController + self.setFrame(windowFrame, display: true) + + RegisterGeneratedPlugins(registry: flutterViewController) + + super.awakeFromNib() + } +} diff --git a/example/macos/Runner/Release.entitlements b/example/macos/Runner/Release.entitlements new file mode 100644 index 0000000..852fa1a --- /dev/null +++ b/example/macos/Runner/Release.entitlements @@ -0,0 +1,8 @@ + + + + + com.apple.security.app-sandbox + + + diff --git a/example/macos/RunnerTests/RunnerTests.swift b/example/macos/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..5418c9f --- /dev/null +++ b/example/macos/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import FlutterMacOS +import Cocoa +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/example/pubspec.yaml b/example/pubspec.yaml index 4fb6d06..70296b8 100755 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -12,11 +12,11 @@ dependencies: sdk: flutter cupertino_icons: ^1.0.5 - flutter_map: ^5.0.0 + flutter_map: ^6.0.0-dev.1 + flutter_map_animations: ^0.4.1 + flutter_map_marker_popup: ^5.3.0-dev.1 flutter_map_supercluster: path: ../ - flutter_map_animations: ^0.4.1 - flutter_map_marker_popup: ^5.2.0 latlong2: ^0.9.0 dev_dependencies: @@ -30,3 +30,9 @@ flutter: - family: AccurateMapIcon fonts: - asset: fonts/AccurateMapIcon.ttf + +dependency_overrides: + flutter_map_animations: + git: + url: https://github.com/rorystephenson/flutter_map_animations + ref: flutter-map-v6 diff --git a/example/web/icons/Icon-maskable-192.png b/example/web/icons/Icon-maskable-192.png new file mode 100644 index 0000000..eb9b4d7 Binary files /dev/null and b/example/web/icons/Icon-maskable-192.png differ diff --git a/example/web/icons/Icon-maskable-512.png b/example/web/icons/Icon-maskable-512.png new file mode 100644 index 0000000..d69c566 Binary files /dev/null and b/example/web/icons/Icon-maskable-512.png differ diff --git a/example/windows/.gitignore b/example/windows/.gitignore new file mode 100644 index 0000000..d492d0d --- /dev/null +++ b/example/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/example/windows/CMakeLists.txt b/example/windows/CMakeLists.txt new file mode 100644 index 0000000..1378672 --- /dev/null +++ b/example/windows/CMakeLists.txt @@ -0,0 +1,102 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(example LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/example/windows/flutter/CMakeLists.txt b/example/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..930d207 --- /dev/null +++ b/example/windows/flutter/CMakeLists.txt @@ -0,0 +1,104 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + windows-x64 $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/example/windows/flutter/generated_plugin_registrant.cc b/example/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..8b6d468 --- /dev/null +++ b/example/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void RegisterPlugins(flutter::PluginRegistry* registry) { +} diff --git a/example/windows/flutter/generated_plugin_registrant.h b/example/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..dc139d8 --- /dev/null +++ b/example/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/windows/flutter/generated_plugins.cmake b/example/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..b93c4c3 --- /dev/null +++ b/example/windows/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/example/windows/runner/CMakeLists.txt b/example/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..394917c --- /dev/null +++ b/example/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/example/windows/runner/Runner.rc b/example/windows/runner/Runner.rc new file mode 100644 index 0000000..f855b50 --- /dev/null +++ b/example/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "ng.balanci" "\0" + VALUE "FileDescription", "example" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2023 ng.balanci. All rights reserved." "\0" + VALUE "OriginalFilename", "example.exe" "\0" + VALUE "ProductName", "example" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/example/windows/runner/flutter_window.cpp b/example/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..b25e363 --- /dev/null +++ b/example/windows/runner/flutter_window.cpp @@ -0,0 +1,66 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/example/windows/runner/flutter_window.h b/example/windows/runner/flutter_window.h new file mode 100644 index 0000000..6da0652 --- /dev/null +++ b/example/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/example/windows/runner/main.cpp b/example/windows/runner/main.cpp new file mode 100644 index 0000000..a61bf80 --- /dev/null +++ b/example/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/example/windows/runner/resource.h b/example/windows/runner/resource.h new file mode 100644 index 0000000..66a65d1 --- /dev/null +++ b/example/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/example/windows/runner/resources/app_icon.ico b/example/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..c04e20c Binary files /dev/null and b/example/windows/runner/resources/app_icon.ico differ diff --git a/example/windows/runner/runner.exe.manifest b/example/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..a42ea76 --- /dev/null +++ b/example/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/example/windows/runner/utils.cpp b/example/windows/runner/utils.cpp new file mode 100644 index 0000000..b2b0873 --- /dev/null +++ b/example/windows/runner/utils.cpp @@ -0,0 +1,65 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr) + -1; // remove the trailing null character + int input_length = (int)wcslen(utf16_string); + std::string utf8_string; + if (target_length <= 0 || target_length > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/example/windows/runner/utils.h b/example/windows/runner/utils.h new file mode 100644 index 0000000..3879d54 --- /dev/null +++ b/example/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/example/windows/runner/win32_window.cpp b/example/windows/runner/win32_window.cpp new file mode 100644 index 0000000..60608d0 --- /dev/null +++ b/example/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/example/windows/runner/win32_window.h b/example/windows/runner/win32_window.h new file mode 100644 index 0000000..e901dde --- /dev/null +++ b/example/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/lib/flutter_map_supercluster.dart b/lib/flutter_map_supercluster.dart index ffb86a1..0dd6ccd 100755 --- a/lib/flutter_map_supercluster.dart +++ b/lib/flutter_map_supercluster.dart @@ -5,7 +5,6 @@ export 'package:supercluster/supercluster.dart'; export 'src/controller/marker_matcher.dart'; export 'src/controller/supercluster_controller.dart'; -export 'src/controller/supercluster_state.dart'; export 'src/layer/cluster_data.dart'; export 'src/layer/supercluster_layer.dart'; export 'src/options/index_builder.dart'; @@ -14,3 +13,5 @@ export 'src/splay/cluster_splay_delegate.dart'; export 'src/splay/displaced_marker.dart'; export 'src/splay/displaced_marker_offset.dart'; export 'src/splay/spread_cluster_splay_delegate.dart'; +export 'src/state/supercluster_scope.dart'; +export 'src/state/supercluster_state.dart'; diff --git a/lib/src/controller/supercluster_controller.dart b/lib/src/controller/supercluster_controller.dart index c0766b5..18ade8f 100644 --- a/lib/src/controller/supercluster_controller.dart +++ b/lib/src/controller/supercluster_controller.dart @@ -5,23 +5,11 @@ import 'package:flutter_map_supercluster/src/controller/marker_matcher.dart'; import 'package:latlong2/latlong.dart'; import 'supercluster_controller_impl.dart'; -import 'supercluster_state.dart'; abstract class SuperclusterController { /// Clear all of the existing Markers. void clear(); - /// A Future that completes with an Iterable of all Markers in the order that - /// the inner cluster store holds them. The Future will complete when the - /// controller is associated with a layer and the loading of the supercluster - /// finishes. - Future> all(); - - /// A Stream of the [SuperclusterState]. Note that the [SuperclusterState]'s - /// aggregatedClusterData will not be calculated unless [SuperclusterLayer]'s - /// [calculateAggregatedClusterData] is true. - Stream get stateStream; - /// Collapses any splayed clusters. See SuperclusterLayer's /// [clusterSplayDelegate] for more information on splaying. void collapseSplayedClusters(); @@ -107,9 +95,7 @@ abstract class SuperclusterController { } abstract class SuperclusterImmutableController extends SuperclusterController { - factory SuperclusterImmutableController() => SuperclusterControllerImpl( - createdInternally: false, - ); + factory SuperclusterImmutableController() => SuperclusterControllerImpl(); /// Remove all of the existing Markers and replace them with [markers]. Note /// that this requires completely rebuilding the clusters and may be a slow @@ -120,17 +106,23 @@ abstract class SuperclusterImmutableController extends SuperclusterController { } abstract class SuperclusterMutableController extends SuperclusterController { - factory SuperclusterMutableController() => SuperclusterControllerImpl( - createdInternally: false, - ); + factory SuperclusterMutableController() => SuperclusterControllerImpl(); /// Add a single [Marker]. This [Marker] will be clustered if possible. void add(Marker marker); + /// Add multiple [markers]. The markers will be clustered if possible. This + /// method is faster than [add] for multple markers. + void addAll(List markers); + /// Remove a single [Marker]. This may cause some clusters to be split and /// rebuilt. void remove(Marker marker); + /// Remove multiple [markers]. The markers will be clustered if possible. This + /// method is faster than [remove] for multple markers. + void removeAll(List markers); + /// Modify a Marker. Note that [oldMarker] must have the same [pos] as /// [newMarker]. This is an optimised function that skips re-clustering. void modifyMarker( diff --git a/lib/src/controller/supercluster_controller_impl.dart b/lib/src/controller/supercluster_controller_impl.dart index 19682ae..53b4e57 100644 --- a/lib/src/controller/supercluster_controller_impl.dart +++ b/lib/src/controller/supercluster_controller_impl.dart @@ -4,36 +4,26 @@ import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/controller/marker_matcher.dart'; import 'package:flutter_map_supercluster/src/controller/supercluster_event.dart'; import 'package:latlong2/latlong.dart'; -import 'package:supercluster/supercluster.dart'; import 'supercluster_controller.dart'; -import 'supercluster_state.dart'; class SuperclusterControllerImpl implements SuperclusterImmutableController, SuperclusterMutableController { - final bool createdInternally; final StreamController _superclusterEventController; - final StreamController _stateStreamController; - Future> _supercluster = Future.any([]); - SuperclusterControllerImpl({required this.createdInternally}) - : _superclusterEventController = StreamController.broadcast(), - _stateStreamController = - StreamController.broadcast(); + SuperclusterControllerImpl() + : _superclusterEventController = StreamController.broadcast(); Stream get stream => _superclusterEventController.stream; @override - Stream get stateStream => - _stateStreamController.stream.distinct(); - - void setSupercluster(Future> supercluster) { - _supercluster = supercluster; + void add(Marker marker) { + _superclusterEventController.add(AddMarkerEvent(marker)); } @override - void add(Marker marker) { - _superclusterEventController.add(AddMarkerEvent(marker)); + void addAll(List markers) { + _superclusterEventController.add(AddAllMarkerEvent(markers)); } @override @@ -41,6 +31,11 @@ class SuperclusterControllerImpl _superclusterEventController.add(RemoveMarkerEvent(marker)); } + @override + void removeAll(List markers) { + _superclusterEventController.add(RemoveAllMarkerEvent(markers)); + } + @override void modifyMarker( Marker oldMarker, @@ -55,10 +50,6 @@ class SuperclusterControllerImpl )); } - void removeSupercluster() { - _supercluster = Future.any([]); - } - @override void replaceAll(List markers) { _superclusterEventController.add(ReplaceAllMarkerEvent(markers)); @@ -69,11 +60,6 @@ class SuperclusterControllerImpl _superclusterEventController.add(const ReplaceAllMarkerEvent([])); } - @override - Future> all() { - return _supercluster.then((supercluster) => supercluster.getLeaves()); - } - @override void collapseSplayedClusters() { _superclusterEventController.add(const CollapseSplayedClustersEvent()); @@ -94,10 +80,6 @@ class SuperclusterControllerImpl ); } - void updateState(SuperclusterState newState) { - _stateStreamController.add(newState); - } - @override void showPopupsAlsoFor( List markers, { @@ -155,6 +137,5 @@ class SuperclusterControllerImpl @override void dispose() { _superclusterEventController.close(); - _stateStreamController.close(); } } diff --git a/lib/src/controller/supercluster_event.dart b/lib/src/controller/supercluster_event.dart index 8bd610d..5b12630 100644 --- a/lib/src/controller/supercluster_event.dart +++ b/lib/src/controller/supercluster_event.dart @@ -14,12 +14,24 @@ class AddMarkerEvent extends SuperclusterEvent { const AddMarkerEvent(this.marker); } +class AddAllMarkerEvent extends SuperclusterEvent { + final List markers; + + const AddAllMarkerEvent(this.markers); +} + class RemoveMarkerEvent extends SuperclusterEvent { final Marker marker; const RemoveMarkerEvent(this.marker); } +class RemoveAllMarkerEvent extends SuperclusterEvent { + final List markers; + + const RemoveAllMarkerEvent(this.markers); +} + class ReplaceAllMarkerEvent extends SuperclusterEvent { final List markers; diff --git a/lib/src/controller/supercluster_state.dart b/lib/src/controller/supercluster_state.dart deleted file mode 100644 index d61e981..0000000 --- a/lib/src/controller/supercluster_state.dart +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:equatable/equatable.dart'; -import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; - -class SuperclusterState extends Equatable { - final bool loading; - - final ClusterData? aggregatedClusterData; - - const SuperclusterState({ - required this.loading, - required this.aggregatedClusterData, - }); - - @override - List get props => [loading, aggregatedClusterData]; -} diff --git a/lib/src/layer/anchor_util.dart b/lib/src/layer/anchor_util.dart index 3e594c1..92588e2 100644 --- a/lib/src/layer/anchor_util.dart +++ b/lib/src/layer/anchor_util.dart @@ -1,30 +1,8 @@ import 'dart:math'; -import 'dart:ui'; import 'package:flutter_map/plugin_api.dart'; -import 'package:supercluster/supercluster.dart'; class AnchorUtil { - static Point removeClusterAnchor( - CustomPoint pos, - LayerCluster cluster, - AnchorPos? clusterAnchorPos, - Size clusterWidgetSize, - ) { - final anchor = Anchor.fromPos( - clusterAnchorPos ?? AnchorPos.align(AnchorAlign.center), - clusterWidgetSize.width, - clusterWidgetSize.height, - ); - - return removeAnchor( - pos, - clusterWidgetSize.width, - clusterWidgetSize.height, - anchor, - ); - } - static Point removeAnchor( Point pos, double width, diff --git a/lib/src/layer/create_supercluster.dart b/lib/src/layer/create_supercluster.dart index 5cf1ddb..c980b46 100644 --- a/lib/src/layer/create_supercluster.dart +++ b/lib/src/layer/create_supercluster.dart @@ -1,40 +1,41 @@ import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/layer/cluster_data.dart'; -import 'package:flutter_map_supercluster/src/layer/supercluster_config.dart'; +import 'package:flutter_map_supercluster/src/layer/supercluster_parameters.dart'; import 'package:supercluster/supercluster.dart'; -Supercluster createSupercluster(SuperclusterConfig config) { - return config.isMutableSupercluster - ? _loadMutable(config) - : _loadImmutable(config); +Supercluster createSupercluster(SuperclusterParameters parameters) { + return parameters.isMutableSupercluster + ? _loadMutable(parameters) + : _loadImmutable(parameters); } -SuperclusterMutable _loadMutable(SuperclusterConfig config) { +SuperclusterMutable _loadMutable(SuperclusterParameters parameters) { return SuperclusterMutable( getX: (m) => m.point.longitude, getY: (m) => m.point.latitude, - minZoom: config.minZoom, - maxZoom: config.maxZoom, - minPoints: config.minimumClusterSize, + minZoom: parameters.minZoom, + maxZoom: parameters.maxZoom, + minPoints: parameters.minimumClusterSize, extractClusterData: (marker) => ClusterData( marker, - innerExtractor: config.innerClusterDataExtractor, + innerExtractor: parameters.innerClusterDataExtractor, ), - radius: config.maxClusterRadius, - )..load(config.markers); + radius: parameters.maxClusterRadius, + )..load(parameters.markers); } -SuperclusterImmutable _loadImmutable(SuperclusterConfig config) { +SuperclusterImmutable _loadImmutable( + SuperclusterParameters parameters) { return SuperclusterImmutable( getX: (m) => m.point.longitude, getY: (m) => m.point.latitude, - minZoom: config.minZoom, - maxZoom: config.maxZoom, + minZoom: parameters.minZoom, + maxZoom: parameters.maxZoom, extractClusterData: (marker) => ClusterData( marker, - innerExtractor: config.innerClusterDataExtractor, + innerExtractor: parameters.innerClusterDataExtractor, ), - radius: config.maxClusterRadius, - minPoints: config.minimumClusterSize, - )..load(config.markers); + radius: parameters.maxClusterRadius, + minPoints: parameters.minimumClusterSize, + )..load(parameters.markers); } diff --git a/lib/src/layer/expanded_cluster_manager.dart b/lib/src/layer/expanded_cluster_manager.dart index 9c466ae..d32edff 100644 --- a/lib/src/layer/expanded_cluster_manager.dart +++ b/lib/src/layer/expanded_cluster_manager.dart @@ -102,7 +102,45 @@ class ExpandedClusterManager { } } - /// Removes all without triggering onRemove callback. + void removeImmediately(ExpandedCluster expandedCluster) { + final removed = _expandedClusters.remove(expandedCluster.layerCluster.uuid); + if (removed == null) return; + + // Dispose after removal so that ExpandedClusterManager never contains + // disposed ExpandedClusters. + expandedCluster.dispose(); + + onRemoveStart([removed]); + onRemoved([removed]); + } + + void removeAllImmediately(Iterable expandedClusters) { + final removalIds = expandedClusters.map((e) => e.layerCluster.uuid).toSet(); + final removed = []; + + _expandedClusters.removeWhere((uuid, expandedCluster) { + if (removalIds.contains(uuid)) { + removed.add(expandedCluster); + return true; + } + return false; + }); + + // Dispose after removal so that ExpandedClusterManager never contains + // disposed ExpandedClusters. + for (var expandedCluster in removed) { + expandedCluster.dispose(); + } + + if (removed.isNotEmpty) { + onRemoveStart(removed); + onRemoved(removed); + } + } + + /// Removes all without triggering onRemove callback. The removal callback is + /// used for hiding popups but this method should only be called after + /// re-initializing the supercluster which already hides popups. void clear() { final removed = List.from(_expandedClusters.values); _expandedClusters.clear(); diff --git a/lib/src/layer/flutter_map_state_extension.dart b/lib/src/layer/map_camera_extension.dart similarity index 68% rename from lib/src/layer/flutter_map_state_extension.dart rename to lib/src/layer/map_camera_extension.dart index 7a2560b..8fd8813 100644 --- a/lib/src/layer/flutter_map_state_extension.dart +++ b/lib/src/layer/map_camera_extension.dart @@ -1,13 +1,15 @@ +import 'dart:math'; import 'dart:ui'; import 'package:flutter_map/plugin_api.dart'; import 'package:latlong2/latlong.dart'; -extension FlutterMapStateExtension on FlutterMapState { - CustomPoint getPixelOffset(LatLng point) => project(point) - pixelOrigin; +extension MapCameraExtension on MapCamera { + Point getPixelOffset(LatLng point) => + project(point) - pixelOrigin.toDoublePoint(); LatLngBounds paddedMapBounds(Size clusterWidgetSize) { - final boundsPixelPadding = CustomPoint( + final boundsPixelPadding = Point( clusterWidgetSize.width / 2, clusterWidgetSize.height / 2, ); diff --git a/lib/src/layer/supercluster_config.dart b/lib/src/layer/supercluster_config.dart index d982bfa..e3b55e0 100644 --- a/lib/src/layer/supercluster_config.dart +++ b/lib/src/layer/supercluster_config.dart @@ -1,25 +1,77 @@ +import 'package:equatable/equatable.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:supercluster/supercluster.dart'; -class SuperclusterConfig { - final bool isMutableSupercluster; +/// This describes the options needed to create a Supercluster but does not +/// contain the Markers. See SuperclusterParameters for the options and the +/// Markers in a single class. +/// +/// This is defined as abstract to allow SuperclusterParameters to implement it +/// without needing to implement Equatable methods since Equatable is used on +/// SuperclusterConfigImpl. +abstract class SuperclusterConfig { + static const defaultMinZoom = 1; + static const defaultMaxZoom = 20; - final List markers; + bool get isMutableSupercluster; + int get maxClusterRadius; + ClusterDataBase Function(Marker marker)? get innerClusterDataExtractor; + int? get minimumClusterSize; - final int minZoom; - final int maxZoom; + int get minZoom; + int get maxZoom; - final ClusterDataBase Function(Marker marker)? innerClusterDataExtractor; + const SuperclusterConfig(); +} + +class SuperclusterConfigImpl extends Equatable implements SuperclusterConfig { + @override + final bool isMutableSupercluster; + @override final int maxClusterRadius; + @override + final ClusterDataBase Function(Marker marker)? innerClusterDataExtractor; + @override final int? minimumClusterSize; - SuperclusterConfig({ + final int? _maxClusterZoom; + final int? _mapStateMinZoom; + final int? _mapStateMaxZoom; + + SuperclusterConfigImpl({ + required MapCamera mapCamera, required this.isMutableSupercluster, - required this.markers, - required this.minZoom, - required this.maxZoom, + required int? maxClusterZoom, required this.maxClusterRadius, required this.innerClusterDataExtractor, - this.minimumClusterSize, - }); + required this.minimumClusterSize, + }) : _maxClusterZoom = maxClusterZoom, + _mapStateMinZoom = _mapStateMinZoomFrom(mapCamera), + _mapStateMaxZoom = _mapStateMaxZoomFrom(mapCamera); + + @override + int get minZoom => _mapStateMinZoom ?? SuperclusterConfig.defaultMinZoom; + @override + int get maxZoom => + _maxClusterZoom ?? _mapStateMaxZoom ?? SuperclusterConfig.defaultMaxZoom; + + bool mapStateZoomLimitsHaveChanged(MapCamera mapCamera) => + _mapStateMaxZoom != _mapStateMaxZoomFrom(mapCamera) || + _mapStateMinZoom != _mapStateMinZoomFrom(mapCamera); + + static int? _mapStateMinZoomFrom(MapCamera mapCamera) => + mapCamera.minZoom?.ceil(); + + static int? _mapStateMaxZoomFrom(MapCamera mapCamera) => + mapCamera.maxZoom?.ceil(); + + @override + List get props => [ + isMutableSupercluster, + minZoom, + maxZoom, + maxClusterRadius, + innerClusterDataExtractor, + minimumClusterSize, + ]; } diff --git a/lib/src/layer/supercluster_layer.dart b/lib/src/layer/supercluster_layer.dart index cb29351..11b8633 100755 --- a/lib/src/layer/supercluster_layer.dart +++ b/lib/src/layer/supercluster_layer.dart @@ -1,37 +1,13 @@ import 'dart:async'; -import 'dart:math'; -import 'package:async/async.dart'; import 'package:flutter/material.dart'; import 'package:flutter_map/plugin_api.dart'; -import 'package:flutter_map_marker_popup/extension_api.dart'; -import 'package:flutter_map_supercluster/src/controller/marker_matcher.dart'; -import 'package:flutter_map_supercluster/src/controller/supercluster_event.dart'; -import 'package:flutter_map_supercluster/src/controller/supercluster_state.dart'; -import 'package:flutter_map_supercluster/src/layer/create_supercluster.dart'; -import 'package:flutter_map_supercluster/src/layer/expanded_cluster_manager.dart'; -import 'package:flutter_map_supercluster/src/layer/flutter_map_state_extension.dart'; -import 'package:flutter_map_supercluster/src/layer/loading_overlay.dart'; -import 'package:flutter_map_supercluster/src/layer/supercluster_config.dart'; -import 'package:flutter_map_supercluster/src/layer_element_extension.dart'; -import 'package:flutter_map_supercluster/src/options/index_builder.dart'; +import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; +import 'package:flutter_map_supercluster/src/controller/supercluster_controller_impl.dart'; +import 'package:flutter_map_supercluster/src/layer/supercluster_layer_impl.dart'; import 'package:flutter_map_supercluster/src/options/popup_options_impl.dart'; -import 'package:flutter_map_supercluster/src/splay/cluster_splay_delegate.dart'; -import 'package:flutter_map_supercluster/src/splay/popup_spec_builder.dart'; -import 'package:flutter_map_supercluster/src/splay/spread_cluster_splay_delegate.dart'; -import 'package:flutter_map_supercluster/src/supercluster_extension.dart'; -import 'package:flutter_map_supercluster/src/widget/expandable_cluster_widget.dart'; -import 'package:flutter_map_supercluster/src/widget/expanded_cluster.dart'; +import 'package:flutter_map_supercluster/src/state/inherit_or_create_supercluster_scope.dart'; import 'package:latlong2/latlong.dart'; -import 'package:provider/provider.dart'; -import 'package:supercluster/supercluster.dart'; - -import '../controller/supercluster_controller.dart'; -import '../controller/supercluster_controller_impl.dart'; -import '../options/popup_options.dart'; -import '../widget/cluster_widget.dart'; -import '../widget/marker_widget.dart'; -import 'cluster_data.dart'; /// Builder for the cluster widget. typedef ClusterWidgetBuilder = Widget Function( @@ -44,16 +20,16 @@ typedef ClusterWidgetBuilder = Widget Function( /// See [SuperclusterLayer.moveMap]. typedef MoveMapCallback = FutureOr Function(LatLng center, double zoom); -class SuperclusterLayer extends StatefulWidget { +class SuperclusterLayer extends StatelessWidget { static const popupNamespace = 'flutter_map_supercluster'; - final bool _isMutableSupercluster; + final bool isMutableSupercluster; /// Cluster builder final ClusterWidgetBuilder builder; /// Controller for managing [Marker]s and listening to changes. - final SuperclusterControllerImpl controller; + final SuperclusterController? controller; /// Initial list of markers, additions/removals must be made using the /// [controller]. @@ -61,7 +37,19 @@ class SuperclusterLayer extends StatefulWidget { /// Builder used to create the supercluster index. See [IndexBuilders] for /// predefined builders and guidelines on which one to use. - final IndexBuilder indexBuilder; + /// + /// Defaults to IndexBuilder.rootIsolate which may be slow for large amounts + /// of markers. + final IndexBuilder? indexBuilder; + + /// The maximum zoom at which clusters will be formed, at higher zooms all + // points will be visible. Defaults to the FlutterMap maxZoom or, if it is + // not set, 20. + // + // This value must not be higher than the FlutterMap's maxZoom if it is set + // as this will break splay cluster functionality and causes unnecesssary + // calculations since not all clusters/points will be able to be viewed. + final int? maxClusterZoom; /// The minimum number of points required to form a cluster, if there is less /// than this number of points within the [maxClusterRadius] the markers will @@ -106,13 +94,13 @@ class SuperclusterLayer extends StatefulWidget { /// Cluster size final Size clusterWidgetSize; - /// Cluster anchor - final AnchorPos? anchor; + /// Cluster anchor position. + final AnchorPos clusterAnchorPos; /// If true then whenever the aggregated cluster data changes (that is, the /// combined cluster data of all Markers as calculated by - /// [clusterDataExtractor]) then the new value will be added to the - /// [controller]'s [aggregatedClusterDataStream]. + /// [clusterDataExtractor]) dependents of SuperclusterState will be notified + /// with the updated value. final bool calculateAggregatedClusterData; /// Splaying occurs when it is not possible to open a cluster because its @@ -120,14 +108,15 @@ class SuperclusterLayer extends StatefulWidget { /// controls the animation and style of the cluster splaying. final ClusterSplayDelegate clusterSplayDelegate; - SuperclusterLayer.immutable({ + const SuperclusterLayer.immutable({ Key? key, - SuperclusterImmutableController? controller, + SuperclusterImmutableController? this.controller, required this.builder, required this.indexBuilder, this.initialMarkers = const [], this.moveMap, this.onMarkerTap, + this.maxClusterZoom, this.minimumClusterSize, this.maxClusterRadius = 80, this.clusterDataExtractor, @@ -135,27 +124,32 @@ class SuperclusterLayer extends StatefulWidget { this.clusterWidgetSize = const Size(30, 30), this.loadingOverlayBuilder, PopupOptions? popupOptions, - this.anchor, + @Deprecated( + 'Prefer `clusterAnchorPos` instead. ' + 'This method has been renamed to clusterAnchorPos for clarity. ' + 'This method is deprecated since v5.0.0', + ) + AnchorPos? anchorPos, + AnchorPos clusterAnchorPos = AnchorPos.defaultAnchorPos, this.clusterSplayDelegate = const SpreadClusterSplayDelegate( duration: Duration(milliseconds: 300), splayLineOptions: SplayLineOptions(), ), - }) : _isMutableSupercluster = false, - controller = controller != null - ? controller as SuperclusterControllerImpl - : SuperclusterControllerImpl(createdInternally: true), + }) : isMutableSupercluster = false, + clusterAnchorPos = anchorPos ?? clusterAnchorPos, popupOptions = popupOptions == null ? null : popupOptions as PopupOptionsImpl, super(key: key); - SuperclusterLayer.mutable({ + const SuperclusterLayer.mutable({ Key? key, - SuperclusterMutableController? controller, + SuperclusterMutableController? this.controller, required this.builder, - required this.indexBuilder, + this.indexBuilder, this.initialMarkers = const [], this.moveMap, this.onMarkerTap, + this.maxClusterZoom, this.minimumClusterSize, this.maxClusterRadius = 80, this.clusterDataExtractor, @@ -163,659 +157,50 @@ class SuperclusterLayer extends StatefulWidget { this.clusterWidgetSize = const Size(30, 30), this.loadingOverlayBuilder, PopupOptions? popupOptions, - this.anchor, + @Deprecated( + 'Prefer `clusterAnchorPos` instead. ' + 'This method has been renamed to clusterAnchorPos for clarity. ' + 'This method is deprecated since v5.0.0', + ) + AnchorPos? anchorPos, + AnchorPos clusterAnchorPos = AnchorPos.defaultAnchorPos, this.clusterSplayDelegate = const SpreadClusterSplayDelegate( duration: Duration(milliseconds: 400), ), - }) : _isMutableSupercluster = true, - controller = controller != null - ? controller as SuperclusterControllerImpl - : SuperclusterControllerImpl(createdInternally: true), + }) : isMutableSupercluster = true, + clusterAnchorPos = anchorPos ?? clusterAnchorPos, popupOptions = popupOptions == null ? null : popupOptions as PopupOptionsImpl, super(key: key); @override - State createState() => _SuperclusterLayerState(); -} - -class _SuperclusterLayerState extends State - with TickerProviderStateMixin { - static const defaultMinZoom = 1; - static const defaultMaxZoom = 20; - - bool _initialized = false; - - late int minZoom; - late int maxZoom; - - late FlutterMapState _mapState; - late final ExpandedClusterManager _expandedClusterManager; - - StreamSubscription? _controllerSubscription; - StreamSubscription? _movementStreamSubscription; - - int? _lastMovementZoom; - - PopupState? _popupState; - - CancelableCompleter> _superclusterCompleter = - CancelableCompleter(); - - @override - void initState() { - super.initState(); - _expandedClusterManager = ExpandedClusterManager( - onRemoveStart: (expandedClusters) { - // The flutter_map_marker_popup package takes care of hiding popups - // when zooming out but when an ExpandedCluster removal is triggered by - // SuperclusterController.collapseSplayedClusters we need to remove the - // popups ourselves. - widget.popupOptions?.popupController.hidePopupsOnlyFor( - expandedClusters - .expand((expandedCluster) => expandedCluster.markers) - .toList(), - ); - }, - onRemoved: (expandedClusters) => setState(() {}), - ); - } - - @override - void didChangeDependencies() { - super.didChangeDependencies(); - - _mapState = FlutterMapState.maybeOf(context)!; - - final oldMinZoom = !_initialized ? null : minZoom; - final oldMaxZoom = !_initialized ? null : maxZoom; - minZoom = _mapState.options.minZoom?.ceil() ?? defaultMinZoom; - maxZoom = _mapState.options.maxZoom?.ceil() ?? defaultMaxZoom; - - bool zoomsChanged = - _initialized && oldMinZoom != minZoom || oldMaxZoom != maxZoom; - - if (!_initialized) { - _lastMovementZoom = _mapState.zoom.ceil(); - _controllerSubscription = widget.controller.stream.listen( - (superclusterEvent) => _onSuperclusterEvent(superclusterEvent)); - - _movementStreamSubscription = _mapState.mapController.mapEventStream - .listen((_) => _onMove(_mapState)); - } - - if (!_initialized || zoomsChanged) { - if (_initialized) { - debugPrint( - 'WARNING: Changes to the FlutterMapState have caused a rebuild of ' - 'the Supercluster clusters. This can be a slow operation and ' - 'should be avoided whenever possible.'); - } - _initializeClusterManager( - !_initialized - ? Future.value(widget.initialMarkers) - : _superclusterCompleter.operation.value - .then((supercluster) => supercluster.getLeaves().toList()), - ); - } - _initialized = true; - } - - @override - void didUpdateWidget(SuperclusterLayer oldWidget) { - super.didUpdateWidget(oldWidget); - - if (oldWidget._isMutableSupercluster != widget._isMutableSupercluster || - oldWidget.controller != widget.controller) { - _onControllerChange(oldWidget.controller, widget.controller); - } - - if (oldWidget._isMutableSupercluster != widget._isMutableSupercluster || - oldWidget.maxClusterRadius != widget.maxClusterRadius || - oldWidget.minimumClusterSize != widget.minimumClusterSize || - oldWidget.calculateAggregatedClusterData != - widget.calculateAggregatedClusterData) { - debugPrint( - 'WARNING: Changes to the Supercluster options have caused a rebuild ' - 'of the Supercluster clusters. This can be a slow operation and ' - 'should be avoided whenever possible.'); - _initializeClusterManager(_superclusterCompleter.operation - .valueOrCancellation() - .then((supercluster) => supercluster?.getLeaves().toList() ?? [])); - } - - if (widget.popupOptions != oldWidget.popupOptions) { - oldWidget.popupOptions?.popupController.dispose(); - _movementStreamSubscription?.cancel(); - _movementStreamSubscription = _mapState.mapController.mapEventStream - .listen((_) => _onMove(_mapState)); - } - } - - @override - void dispose() { - widget.popupOptions?.popupController.dispose(); - if (widget.controller.createdInternally) widget.controller.dispose(); - _movementStreamSubscription?.cancel(); - _controllerSubscription?.cancel(); - super.dispose(); - } - - void _initializeClusterManager(Future> markersFuture) { - widget.controller.updateState( - const SuperclusterState(loading: true, aggregatedClusterData: null), - ); - - final supercluster = - markersFuture.catchError((_) => []).then((markers) { - final superclusterConfig = SuperclusterConfig( - isMutableSupercluster: widget._isMutableSupercluster, - markers: markers, - minZoom: minZoom, - maxZoom: maxZoom, - maxClusterRadius: widget.maxClusterRadius, - minimumClusterSize: widget.minimumClusterSize, - innerClusterDataExtractor: widget.clusterDataExtractor, - ); - - if (_superclusterCompleter.isCompleted || - _superclusterCompleter.isCanceled) { - setState(() { - _superclusterCompleter = CancelableCompleter(); - }); - } - - final newSupercluster = - widget.indexBuilder.call(createSupercluster, superclusterConfig); - - _superclusterCompleter.complete(newSupercluster); - _superclusterCompleter.operation.value.then((supercluster) { - _onMarkersChange(); - _expandedClusterManager.clear(); - widget.popupOptions?.popupController.hidePopupsWhereSpec( - (popupSpec) => - popupSpec.namespace == SuperclusterLayer.popupNamespace, - ); - }); - - return newSupercluster; - }); - - widget.controller.setSupercluster(supercluster); - } - - @override - Widget build(BuildContext context) { - final mapState = FlutterMapState.maybeOf(context)!; - - return _wrapWithPopupStateIfPopupsEnabled( - (popupState) => Stack( - children: [ - _clustersAndMarkers(mapState), - if (widget.popupOptions?.popupDisplayOptions != null) - PopupLayer( - popupDisplayOptions: widget.popupOptions!.popupDisplayOptions!, - ), - LoadingOverlay( - superclusterFuture: _superclusterCompleter.operation.value, - loadingOverlayBuilder: widget.loadingOverlayBuilder, + Widget build(BuildContext context) => InheritOrCreateSuperclusterScope( + child: SuperclusterLayerImpl( + isMutableSupercluster: isMutableSupercluster, + mapCamera: MapCamera.of(context), + mapController: MapController.of(context), + controller: controller == null + ? null + : controller as SuperclusterControllerImpl, + builder: builder, + indexBuilder: indexBuilder ?? IndexBuilders.rootIsolate, + initialMarkers: initialMarkers, + moveMap: moveMap, + onMarkerTap: onMarkerTap, + maxClusterZoom: maxClusterZoom, + minimumClusterSize: minimumClusterSize, + maxClusterRadius: maxClusterRadius, + clusterDataExtractor: clusterDataExtractor, + calculateAggregatedClusterData: calculateAggregatedClusterData, + clusterWidgetSize: clusterWidgetSize, + loadingOverlayBuilder: loadingOverlayBuilder, + popupOptions: popupOptions, + clusterAnchor: Anchor.fromPos( + clusterAnchorPos, + clusterWidgetSize.width, + clusterWidgetSize.height, ), - ], - ), - ); - } - - Widget _wrapWithPopupStateIfPopupsEnabled( - Widget Function(PopupState? popupState) builder) { - if (widget.popupOptions == null) return builder(null); - - return InheritOrCreatePopupScope( - popupController: widget.popupOptions!.popupController, - builder: (context, popupState) { - _popupState = popupState; - if (widget.popupOptions!.selectedMarkerBuilder != null) { - context.watch(); - } - return builder(popupState); - }, - ); - } - - Widget _clustersAndMarkers(FlutterMapState mapState) { - final paddedBounds = mapState.paddedMapBounds(widget.clusterWidgetSize); - - return FutureBuilder>( - future: _superclusterCompleter.operation.value, - builder: (context, snapshot) { - final supercluster = snapshot.data; - if (supercluster == null) return const SizedBox.shrink(); - - return Stack(children: [ - ..._buildClustersAndMarkers(mapState, supercluster, paddedBounds) - ]); - }, - ); - } - - Iterable _buildClustersAndMarkers( - FlutterMapState mapState, - Supercluster supercluster, - LatLngBounds paddedBounds, - ) sync* { - final selectedMarkerBuilder = - widget.popupOptions != null && _popupState!.selectedMarkers.isNotEmpty - ? widget.popupOptions!.selectedMarkerBuilder - : null; - final List> selectedLayerPoints = []; - final List> clusters = []; - - // Build non-selected markers first, queue the rest to build afterwards - // so they appear above these markers. - for (final layerElement in supercluster.search( - paddedBounds.west, - paddedBounds.south, - paddedBounds.east, - paddedBounds.north, - mapState.zoom.ceil(), - )) { - if (layerElement is LayerCluster) { - clusters.add(layerElement); - continue; - } - layerElement as LayerPoint; - if (selectedMarkerBuilder != null && - _popupState!.selectedMarkers.contains(layerElement.originalPoint)) { - selectedLayerPoints.add(layerElement); - continue; - } - yield _buildMarker(mapState, layerElement); - } - - // Build selected markers. - for (final selectedLayerPoint in selectedLayerPoints) { - yield _buildMarker(mapState, selectedLayerPoint, selected: true); - } - - // Build non expanded clusters. - for (final cluster in clusters) { - if (_expandedClusterManager.contains(cluster)) continue; - yield _buildCluster(mapState, supercluster, cluster); - } - - // Build expanded clusters. - for (final expandedCluster in _expandedClusterManager.all) { - yield _buildExpandedCluster(mapState, expandedCluster); - } - } - - Widget _buildMarker( - FlutterMapState mapState, - LayerPoint mapPoint, { - bool selected = false, - }) { - final marker = mapPoint.originalPoint; - - final markerBuilder = !selected - ? marker.builder - : (context) => - widget.popupOptions!.selectedMarkerBuilder!(context, marker); - - return MarkerWidget( - mapState: _mapState, - marker: marker, - markerBuilder: markerBuilder, - onTap: () => _onMarkerTap(PopupSpecBuilder.forLayerPoint(mapPoint)), - ); - } - - Widget _buildCluster( - FlutterMapState mapState, - Supercluster supercluster, - LayerCluster cluster, - ) { - return ClusterWidget( - mapState: _mapState, - cluster: cluster, - builder: widget.builder, - onTap: () => _onClusterTap(supercluster, cluster), - size: widget.clusterWidgetSize, - anchorPos: widget.anchor, - ); - } - - Widget _buildExpandedCluster( - FlutterMapState mapState, - ExpandedCluster expandedCluster, - ) { - final selectedMarkerBuilder = widget.popupOptions?.selectedMarkerBuilder; - final Widget Function(BuildContext context, Marker marker) markerBuilder = - selectedMarkerBuilder == null - ? ((context, marker) => marker.builder(context)) - : ((context, marker) => - _popupState?.selectedMarkers.contains(marker) == true - ? selectedMarkerBuilder(context, marker) - : marker.builder(context)); - - return ExpandableClusterWidget( - mapState: mapState, - expandedCluster: expandedCluster, - builder: widget.builder, - size: widget.clusterWidgetSize, - anchorPos: widget.anchor, - markerBuilder: markerBuilder, - onCollapse: () { - widget.popupOptions?.popupController - .hidePopupsOnlyFor(expandedCluster.markers.toList()); - _expandedClusterManager - .collapseThenRemove(expandedCluster.layerCluster); - }, - onMarkerTap: _onMarkerTap, - ); - } - - void _onClusterTap( - Supercluster supercluster, - LayerCluster layerCluster, - ) async { - if (layerCluster.highestZoom >= maxZoom) { - await _moveMapIfNotAt( - layerCluster.latLng, - layerCluster.highestZoom.toDouble(), - ); - - final splayAnimation = _expandedClusterManager.putIfAbsent( - layerCluster, - () => ExpandedCluster( - vsync: this, - mapState: _mapState, - layerPoints: - supercluster.childrenOf(layerCluster).cast>(), - layerCluster: layerCluster, - clusterSplayDelegate: widget.clusterSplayDelegate, + clusterSplayDelegate: clusterSplayDelegate, ), ); - if (splayAnimation != null) setState(() {}); - } else { - await _moveMapIfNotAt( - layerCluster.latLng, - layerCluster.highestZoom + 0.5, - ); - } - } - - FutureOr _moveMapIfNotAt( - LatLng center, - double zoom, { - FutureOr Function(LatLng center, double zoom)? moveMapOverride, - }) { - if (center == _mapState.center && zoom == _mapState.zoom) { - return Future.value(); - } - - final moveMap = moveMapOverride ?? - widget.moveMap ?? - (center, zoom) => _mapState.move( - center, - zoom, - source: MapEventSource.custom, - ); - - return moveMap.call(center, zoom); - } - - void _onMarkerTap(PopupSpec popupSpec) { - _selectMarker(popupSpec); - widget.onMarkerTap?.call(popupSpec.marker); - } - - void _selectMarker(PopupSpec popupSpec) { - if (widget.popupOptions != null) { - assert(_popupState != null); - - final popupOptions = widget.popupOptions!; - popupOptions.markerTapBehavior.apply( - popupSpec, - _popupState!, - popupOptions.popupController, - ); - - if (popupOptions.selectedMarkerBuilder != null) setState(() {}); - } - } - - void _onMove(FlutterMapState mapState) { - final zoom = mapState.zoom.ceil(); - - if (_lastMovementZoom == null || zoom < _lastMovementZoom!) { - _expandedClusterManager.removeIfZoomGreaterThan(zoom); - } - - _lastMovementZoom = zoom; - } - - void _onMarkersChange() { - if (!widget.controller.createdInternally) { - _superclusterCompleter.operation.value.then((supercluster) { - final aggregatedClusterData = widget.calculateAggregatedClusterData - ? supercluster.aggregatedClusterData() - : null; - final clusterData = aggregatedClusterData == null - ? null - : (aggregatedClusterData as ClusterData); - widget.controller.updateState( - SuperclusterState( - loading: false, - aggregatedClusterData: clusterData, - ), - ); - }); - } - } - - void _onControllerChange( - SuperclusterControllerImpl oldController, - SuperclusterControllerImpl newController, - ) { - _controllerSubscription?.cancel(); - _controllerSubscription = - newController.stream.listen((event) => _onSuperclusterEvent(event)); - - oldController.removeSupercluster(); - if (oldController.createdInternally) oldController.dispose(); - newController.setSupercluster(_superclusterCompleter.operation.value); - } - - void _moveToMarker({ - required MarkerMatcher markerMatcher, - required bool showPopup, - required FutureOr Function(LatLng center, double zoom)? moveMap, - }) async { - // Create a shorthand for the map movement function. - move(center, zoom) => - _moveMapIfNotAt(center, zoom, moveMapOverride: moveMap); - - /// Find the Marker's LayerPoint. - final supercluster = await _superclusterCompleter.operation.value; - LayerPoint? foundLayerPoint = - supercluster.layerPointMatching(markerMatcher); - if (foundLayerPoint == null) return; - - final markerInSplayCluster = maxZoom < foundLayerPoint.lowestZoom; - if (markerInSplayCluster) { - await _moveToSplayClusterMarker( - supercluster: supercluster, - layerPoint: foundLayerPoint, - move: move, - showPopup: showPopup, - ); - } else { - await move( - foundLayerPoint.latLng, - max(foundLayerPoint.lowestZoom.toDouble(), _mapState.zoom), - ); - if (showPopup) { - _selectMarker(PopupSpecBuilder.forLayerPoint(foundLayerPoint)); - } - } - } - - /// Move to Marker inside splay cluster. There are three possibilities: - /// 1. There is already an ExpandedCluster containing the Marker and it - /// remains expanded during movement. - /// 2. There is already an ExpandedCluster and it closes during movement so - /// we must create a new one once movement finishes. - /// 3. There is NOT already an ExpandedCluster, we should create one and add - /// it once movement finishes. - Future _moveToSplayClusterMarker({ - required Supercluster supercluster, - required LayerPoint layerPoint, - required FutureOr Function(LatLng center, double zoom) move, - required bool showPopup, - }) async { - // Find the parent. - final layerCluster = supercluster.parentOf(layerPoint)!; - - // Shorthand for creating an ExpandedCluster. - createExpandedCluster() => ExpandedCluster( - vsync: this, - mapState: _mapState, - layerPoints: - supercluster.childrenOf(layerCluster).cast>(), - layerCluster: layerCluster, - clusterSplayDelegate: widget.clusterSplayDelegate, - ); - - // Find or create the marker's ExpandedCluster and use it to find the - // DisplacedMarker. - final expandedClusterBeforeMovement = - _expandedClusterManager.forLayerCluster(layerCluster); - final createdExpandedCluster = - expandedClusterBeforeMovement != null ? null : createExpandedCluster(); - final displacedMarker = - (expandedClusterBeforeMovement ?? createdExpandedCluster)! - .markersToDisplacedMarkers[layerPoint.originalPoint]!; - - // Move to the DisplacedMarker. - await move( - displacedMarker.displacedPoint, - max(_mapState.zoom, layerPoint.lowestZoom - 0.99999), - ); - - // Determine the ExpandedCluster after movement, either: - // 1. We created one (without adding it to ExpandedClusterManager) - // because there was none before movement. - // 2. Movement may have caused the ExpandedCluster to be removed in which - // case we create a new one. - final splayAnimation = _expandedClusterManager.putIfAbsent( - layerCluster, - () => createdExpandedCluster ?? createExpandedCluster(), - ); - if (splayAnimation != null) { - if (!mounted) return; - setState(() {}); - await splayAnimation; - } - - if (showPopup) { - final popupSpec = PopupSpecBuilder.forDisplacedMarker( - displacedMarker, - layerCluster.highestZoom, - ); - _selectMarker(popupSpec); - } - } - - void _onSuperclusterEvent(SuperclusterEvent event) async { - switch (event) { - case AddMarkerEvent(): - _superclusterCompleter.operation.then((supercluster) { - (supercluster as SuperclusterMutable).insert(event.marker); - _onMarkersChange(); - }); - case RemoveMarkerEvent(): - _superclusterCompleter.operation.then((supercluster) { - final removed = (supercluster as SuperclusterMutable) - .remove(event.marker); - if (removed) _onMarkersChange(); - }); - case ReplaceAllMarkerEvent(): - _initializeClusterManager(Future.value(event.markers)); - case ModifyMarkerEvent(): - _superclusterCompleter.operation.then((supercluster) { - final modified = - (supercluster as SuperclusterMutable).modifyPointData( - event.oldMarker, - event.newMarker, - updateParentClusters: event.updateParentClusters, - ); - - if (modified) _onMarkersChange(); - }); - case CollapseSplayedClustersEvent(): - _expandedClusterManager.collapseThenRemoveAll(); - case ShowPopupsAlsoForEvent(): - if (widget.popupOptions == null) return; - widget.popupOptions?.popupController.showPopupsAlsoForSpecs( - PopupSpecBuilder.buildList( - supercluster: await _superclusterCompleter.operation.value, - zoom: _mapState.zoom.ceil(), - maxZoom: maxZoom, - markers: event.markers, - expandedClusters: _expandedClusterManager.all, - ), - disableAnimation: event.disableAnimation, - ); - case MoveToMarkerEvent(): - _moveToMarker( - markerMatcher: event.markerMatcher, - showPopup: event.showPopup, - moveMap: event.moveMap, - ); - case ShowPopupsOnlyForEvent(): - if (widget.popupOptions == null) return; - widget.popupOptions?.popupController.showPopupsOnlyForSpecs( - PopupSpecBuilder.buildList( - supercluster: await _superclusterCompleter.operation.value, - zoom: _mapState.zoom.ceil(), - maxZoom: maxZoom, - markers: event.markers, - expandedClusters: _expandedClusterManager.all, - ), - disableAnimation: event.disableAnimation, - ); - case HideAllPopupsEvent(): - if (widget.popupOptions == null) return; - widget.popupOptions?.popupController.hideAllPopups( - disableAnimation: event.disableAnimation, - ); - case HidePopupsWhereEvent(): - if (widget.popupOptions == null) return; - widget.popupOptions?.popupController.hidePopupsWhere( - event.test, - disableAnimation: event.disableAnimation, - ); - case HidePopupsOnlyForEvent(): - if (widget.popupOptions == null) return; - widget.popupOptions?.popupController.hidePopupsOnlyFor( - event.markers, - disableAnimation: event.disableAnimation, - ); - case TogglePopupEvent(): - if (widget.popupOptions == null) return; - final popupSpec = PopupSpecBuilder.build( - supercluster: await _superclusterCompleter.operation.value, - zoom: _mapState.zoom.ceil(), - maxZoom: maxZoom, - marker: event.marker, - expandedClusters: _expandedClusterManager.all, - ); - if (popupSpec == null) return; - widget.popupOptions?.popupController.togglePopupSpec( - popupSpec, - disableAnimation: event.disableAnimation, - ); - } - - setState(() {}); - } } diff --git a/lib/src/layer/supercluster_layer_impl.dart b/lib/src/layer/supercluster_layer_impl.dart new file mode 100755 index 0000000..8d2fd0b --- /dev/null +++ b/lib/src/layer/supercluster_layer_impl.dart @@ -0,0 +1,718 @@ +import 'dart:async'; +import 'dart:math'; + +import 'package:async/async.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_map/plugin_api.dart'; +import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; +import 'package:flutter_map_supercluster/src/controller/supercluster_controller_impl.dart'; +import 'package:flutter_map_supercluster/src/controller/supercluster_event.dart'; +import 'package:flutter_map_supercluster/src/layer/create_supercluster.dart'; +import 'package:flutter_map_supercluster/src/layer/expanded_cluster_manager.dart'; +import 'package:flutter_map_supercluster/src/layer/loading_overlay.dart'; +import 'package:flutter_map_supercluster/src/layer/map_camera_extension.dart'; +import 'package:flutter_map_supercluster/src/layer/supercluster_config.dart'; +import 'package:flutter_map_supercluster/src/layer/supercluster_parameters.dart'; +import 'package:flutter_map_supercluster/src/layer_element_extension.dart'; +import 'package:flutter_map_supercluster/src/options/popup_options_impl.dart'; +import 'package:flutter_map_supercluster/src/splay/popup_spec_builder.dart'; +import 'package:flutter_map_supercluster/src/state/inherited_supercluster_scope.dart'; +import 'package:flutter_map_supercluster/src/supercluster_extension.dart'; +import 'package:flutter_map_supercluster/src/widget/cluster_widget.dart'; +import 'package:flutter_map_supercluster/src/widget/expandable_cluster_widget.dart'; +import 'package:flutter_map_supercluster/src/widget/expanded_cluster.dart'; +import 'package:flutter_map_supercluster/src/widget/marker_widget.dart'; +import 'package:latlong2/latlong.dart'; +import 'package:provider/provider.dart'; + +class SuperclusterLayerImpl extends StatefulWidget { + final bool isMutableSupercluster; + final MapCamera mapCamera; + final MapController mapController; + final ClusterWidgetBuilder builder; + final SuperclusterControllerImpl? controller; + final List initialMarkers; + final IndexBuilder indexBuilder; + final int? maxClusterZoom; + final int? minimumClusterSize; + final int maxClusterRadius; + final ClusterDataBase Function(Marker marker)? clusterDataExtractor; + final MoveMapCallback? moveMap; + final void Function(Marker)? onMarkerTap; + final WidgetBuilder? loadingOverlayBuilder; + final PopupOptionsImpl? popupOptions; + final Size clusterWidgetSize; + final Anchor clusterAnchor; + final bool calculateAggregatedClusterData; + final ClusterSplayDelegate clusterSplayDelegate; + + const SuperclusterLayerImpl({ + super.key, + required this.isMutableSupercluster, + required this.mapCamera, + required this.mapController, + required this.controller, + required this.builder, + required this.indexBuilder, + required this.initialMarkers, + required this.moveMap, + required this.onMarkerTap, + required this.maxClusterZoom, + required this.minimumClusterSize, + required this.maxClusterRadius, + required this.clusterDataExtractor, + required this.calculateAggregatedClusterData, + required this.clusterWidgetSize, + required this.loadingOverlayBuilder, + required this.popupOptions, + required this.clusterAnchor, + required this.clusterSplayDelegate, + }); + + @override + State createState() => _SuperclusterLayerImplState(); +} + +class _SuperclusterLayerImplState extends State + with TickerProviderStateMixin { + late SuperclusterConfigImpl _superclusterConfig; + + late final ExpandedClusterManager _expandedClusterManager; + + StreamSubscription? _controllerSubscription; + StreamSubscription? _movementStreamSubscription; + + int? _lastMovementZoom; + + PopupState? _popupState; + + CancelableCompleter> _superclusterCompleter = + CancelableCompleter(); + + @override + void initState() { + super.initState(); + + _lastMovementZoom = widget.mapCamera.zoom.ceil(); + _controllerSubscription = widget.controller?.stream + .listen((superclusterEvent) => _onSuperclusterEvent(superclusterEvent)); + + _movementStreamSubscription = + widget.mapController.mapEventStream.listen((_) => _onMove()); + + _superclusterConfig = SuperclusterConfigImpl( + isMutableSupercluster: widget.isMutableSupercluster, + mapCamera: widget.mapCamera, + maxClusterZoom: widget.maxClusterZoom, + maxClusterRadius: widget.maxClusterRadius, + innerClusterDataExtractor: widget.clusterDataExtractor, + minimumClusterSize: widget.minimumClusterSize, + ); + + _expandedClusterManager = ExpandedClusterManager( + onRemoveStart: (expandedClusters) { + // The flutter_map_marker_popup package takes care of hiding popups + // when zooming out but when an ExpandedCluster removal is triggered by + // SuperclusterController.collapseSplayedClusters we need to remove the + // popups ourselves. + widget.popupOptions?.popupController.hidePopupsOnlyFor( + expandedClusters + .expand((expandedCluster) => expandedCluster.markers) + .toList(), + ); + }, + onRemoved: (expandedClusters) => setState(() {}), + ); + + WidgetsBinding.instance.addPostFrameCallback((_) { + _initializeSupercluster(Future.value(widget.initialMarkers)); + }); + } + + @override + void didUpdateWidget(SuperclusterLayerImpl oldWidget) { + super.didUpdateWidget(oldWidget); + + final oldSuperclusterConfig = _superclusterConfig; + _superclusterConfig = SuperclusterConfigImpl( + isMutableSupercluster: widget.isMutableSupercluster, + mapCamera: widget.mapCamera, + maxClusterZoom: widget.maxClusterZoom, + maxClusterRadius: widget.maxClusterRadius, + innerClusterDataExtractor: widget.clusterDataExtractor, + minimumClusterSize: widget.minimumClusterSize, + ); + + // Change the controller if necessary. + if (oldSuperclusterConfig.isMutableSupercluster != + _superclusterConfig.isMutableSupercluster || + oldWidget.controller != widget.controller) { + _controllerSubscription?.cancel(); + _controllerSubscription = widget.controller?.stream + .listen((event) => _onSuperclusterEvent(event)); + } + + if (oldSuperclusterConfig.mapStateZoomLimitsHaveChanged(widget.mapCamera)) { + debugPrint( + 'WARNING: Changes to the FlutterMapState have caused a rebuild of ' + 'the Supercluster clusters. This can be a slow operation and ' + 'should be avoided whenever possible.'); + WidgetsBinding.instance.addPostFrameCallback((_) { + _initializeSupercluster(_superclusterCompleter.operation + .valueOrCancellation() + .then((supercluster) => supercluster?.getLeaves().toList() ?? [])); + }); + } else if (oldSuperclusterConfig != _superclusterConfig) { + debugPrint( + 'WARNING: Changes to the Supercluster options have caused a rebuild ' + 'of the Supercluster clusters. This can be a slow operation and ' + 'should be avoided whenever possible.'); + + WidgetsBinding.instance.addPostFrameCallback((_) { + _initializeSupercluster(_superclusterCompleter.operation + .valueOrCancellation() + .then((supercluster) => supercluster?.getLeaves().toList() ?? [])); + }); + } + + if (widget.popupOptions != oldWidget.popupOptions) { + oldWidget.popupOptions?.popupController.dispose(); + } + } + + @override + void dispose() { + widget.popupOptions?.popupController.dispose(); + _movementStreamSubscription?.cancel(); + _controllerSubscription?.cancel(); + super.dispose(); + } + + void _initializeSupercluster(Future> markersFuture) { + InheritedSuperclusterScope.of(context, listen: false).setSuperclusterState( + const SuperclusterStateImpl( + supercluster: null, + aggregatedClusterData: null, + ), + ); + markersFuture.catchError((_) => []).then((markers) { + if (_superclusterCompleter.isCompleted || + _superclusterCompleter.isCanceled) { + setState(() { + _superclusterCompleter = CancelableCompleter(); + }); + } + + final newSupercluster = widget.indexBuilder.call( + createSupercluster, + SuperclusterParameters(config: _superclusterConfig, markers: markers), + ); + + _superclusterCompleter.complete(newSupercluster); + _superclusterCompleter.operation.value.then((supercluster) { + _onMarkersChange(); + _expandedClusterManager.clear(); + widget.popupOptions?.popupController.hidePopupsWhereSpec( + (popupSpec) => + popupSpec.namespace == SuperclusterLayer.popupNamespace, + ); + }); + + return newSupercluster; + }); + } + + @override + Widget build(BuildContext context) { + return _wrapWithPopupStateIfPopupsEnabled( + (popupState) => Stack( + children: [ + _clustersAndMarkers(), + if (widget.popupOptions?.popupDisplayOptions != null) + PopupLayer( + popupDisplayOptions: widget.popupOptions!.popupDisplayOptions!, + ), + LoadingOverlay( + superclusterFuture: _superclusterCompleter.operation.value, + loadingOverlayBuilder: widget.loadingOverlayBuilder, + ), + ], + ), + ); + } + + Widget _wrapWithPopupStateIfPopupsEnabled( + Widget Function(PopupState? popupState) builder) { + if (widget.popupOptions == null) return builder(null); + + return InheritOrCreatePopupScope( + popupController: widget.popupOptions!.popupController, + builder: (context, popupState) { + _popupState = popupState; + if (widget.popupOptions!.selectedMarkerBuilder != null) { + context.watch(); + } + return builder(popupState); + }, + ); + } + + Widget _clustersAndMarkers() { + final paddedBounds = + widget.mapCamera.paddedMapBounds(widget.clusterWidgetSize); + + return FutureBuilder>( + future: _superclusterCompleter.operation.value, + builder: (context, snapshot) { + final supercluster = snapshot.data; + if (supercluster == null) return const SizedBox.shrink(); + + return Stack(children: [ + ..._buildClustersAndMarkers(supercluster, paddedBounds) + ]); + }, + ); + } + + Iterable _buildClustersAndMarkers( + Supercluster supercluster, + LatLngBounds paddedBounds, + ) sync* { + final selectedMarkerBuilder = + widget.popupOptions != null && _popupState!.selectedMarkers.isNotEmpty + ? widget.popupOptions!.selectedMarkerBuilder + : null; + final List> selectedLayerPoints = []; + final List> clusters = []; + + // Build non-selected markers first, queue the rest to build afterwards + // so they appear above these markers. + for (final layerElement in supercluster.search( + paddedBounds.west, + paddedBounds.south, + paddedBounds.east, + paddedBounds.north, + widget.mapCamera.zoom.ceil(), + )) { + if (layerElement is LayerCluster) { + clusters.add(layerElement); + continue; + } + layerElement as LayerPoint; + if (selectedMarkerBuilder != null && + _popupState!.selectedMarkers.contains(layerElement.originalPoint)) { + selectedLayerPoints.add(layerElement); + continue; + } + yield _buildMarker(layerElement); + } + + // Build selected markers. + for (final selectedLayerPoint in selectedLayerPoints) { + yield _buildMarker(selectedLayerPoint, selected: true); + } + + // Build non expanded clusters. + for (final cluster in clusters) { + if (_expandedClusterManager.contains(cluster)) continue; + yield _buildCluster(supercluster, cluster); + } + + // Build expanded clusters. + for (final expandedCluster in _expandedClusterManager.all) { + yield _buildExpandedCluster(expandedCluster); + } + } + + Widget _buildMarker( + LayerPoint mapPoint, { + bool selected = false, + }) { + final marker = mapPoint.originalPoint; + + final markerBuilder = !selected + ? marker.builder + : (context) => + widget.popupOptions!.selectedMarkerBuilder!(context, marker); + + return MarkerWidget( + mapCamera: widget.mapCamera, + marker: marker, + markerBuilder: markerBuilder, + onTap: () => _onMarkerTap(PopupSpecBuilder.forLayerPoint(mapPoint)), + ); + } + + Widget _buildCluster( + Supercluster supercluster, + LayerCluster cluster, + ) { + return ClusterWidget( + mapCamera: widget.mapCamera, + cluster: cluster, + builder: widget.builder, + onTap: () => _onClusterTap(supercluster, cluster), + size: widget.clusterWidgetSize, + anchor: widget.clusterAnchor, + ); + } + + Widget _buildExpandedCluster( + ExpandedCluster expandedCluster, + ) { + final selectedMarkerBuilder = widget.popupOptions?.selectedMarkerBuilder; + final Widget Function(BuildContext context, Marker marker) markerBuilder = + selectedMarkerBuilder == null + ? ((context, marker) => marker.builder(context)) + : ((context, marker) => + _popupState?.selectedMarkers.contains(marker) == true + ? selectedMarkerBuilder(context, marker) + : marker.builder(context)); + + return ExpandableClusterWidget( + mapCamera: widget.mapCamera, + expandedCluster: expandedCluster, + builder: widget.builder, + size: widget.clusterWidgetSize, + anchor: widget.clusterAnchor, + markerBuilder: markerBuilder, + onCollapse: () { + widget.popupOptions?.popupController + .hidePopupsOnlyFor(expandedCluster.markers.toList()); + _expandedClusterManager + .collapseThenRemove(expandedCluster.layerCluster); + }, + onMarkerTap: _onMarkerTap, + ); + } + + void _onClusterTap( + Supercluster supercluster, + LayerCluster layerCluster, + ) async { + if (layerCluster.highestZoom >= _superclusterConfig.maxZoom) { + await _moveMapIfNotAt( + layerCluster.latLng, + layerCluster.highestZoom.toDouble(), + ); + + final splayAnimation = _expandedClusterManager.putIfAbsent( + layerCluster, + () => ExpandedCluster( + vsync: this, + mapCamera: widget.mapCamera, + layerPoints: + supercluster.childrenOf(layerCluster).cast>(), + layerCluster: layerCluster, + clusterSplayDelegate: widget.clusterSplayDelegate, + ), + ); + if (splayAnimation != null) setState(() {}); + } else { + await _moveMapIfNotAt( + layerCluster.latLng, + layerCluster.highestZoom + 0.5, + ); + } + } + + FutureOr _moveMapIfNotAt( + LatLng center, + double zoom, { + FutureOr Function(LatLng center, double zoom)? moveMapOverride, + }) { + if (center == widget.mapCamera.center && zoom == widget.mapCamera.zoom) { + return Future.value(); + } + + final moveMap = moveMapOverride ?? + widget.moveMap ?? + (center, zoom) => widget.mapController.move(center, zoom); + + return moveMap.call(center, zoom); + } + + void _onMarkerTap(PopupSpec popupSpec) { + _selectMarker(popupSpec); + widget.onMarkerTap?.call(popupSpec.marker); + } + + void _selectMarker(PopupSpec popupSpec) { + if (widget.popupOptions != null) { + assert(_popupState != null); + + final popupOptions = widget.popupOptions!; + popupOptions.markerTapBehavior.apply( + popupSpec, + _popupState!, + popupOptions.popupController, + ); + + if (popupOptions.selectedMarkerBuilder != null) setState(() {}); + } + } + + void _onMove() { + final zoom = widget.mapCamera.zoom.ceil(); + + if (_lastMovementZoom == null || zoom < _lastMovementZoom!) { + _expandedClusterManager.removeIfZoomGreaterThan(zoom); + } + + _lastMovementZoom = zoom; + } + + void _onMarkersChange() { + _superclusterCompleter.operation.value.then((supercluster) { + final aggregatedClusterData = widget.calculateAggregatedClusterData + ? supercluster.aggregatedClusterData() + : null; + final clusterData = aggregatedClusterData == null + ? null + : (aggregatedClusterData as ClusterData); + final superclusterState = SuperclusterStateImpl( + aggregatedClusterData: clusterData, + supercluster: supercluster, + ); + InheritedSuperclusterScope.of(context, listen: false) + .setSuperclusterState(superclusterState); + }); + } + + void _moveToMarker({ + required MarkerMatcher markerMatcher, + required bool showPopup, + required FutureOr Function(LatLng center, double zoom)? moveMap, + }) async { + // Create a shorthand for the map movement function. + move(center, zoom) => + _moveMapIfNotAt(center, zoom, moveMapOverride: moveMap); + + /// Find the Marker's LayerPoint. + final supercluster = await _superclusterCompleter.operation.value; + LayerPoint? foundLayerPoint = + supercluster.layerPointMatching(markerMatcher); + if (foundLayerPoint == null) return; + + final markerInSplayCluster = + _superclusterConfig.maxZoom < foundLayerPoint.lowestZoom; + if (markerInSplayCluster) { + await _moveToSplayClusterMarker( + supercluster: supercluster, + layerPoint: foundLayerPoint, + move: move, + showPopup: showPopup, + ); + } else { + await move( + foundLayerPoint.latLng, + max(foundLayerPoint.lowestZoom.toDouble(), widget.mapCamera.zoom), + ); + if (showPopup) { + _selectMarker(PopupSpecBuilder.forLayerPoint(foundLayerPoint)); + } + } + } + + /// Move to Marker inside splay cluster. There are three possibilities: + /// 1. There is already an ExpandedCluster containing the Marker and it + /// remains expanded during movement. + /// 2. There is already an ExpandedCluster and it closes during movement so + /// we must create a new one once movement finishes. + /// 3. There is NOT already an ExpandedCluster, we should create one and add + /// it once movement finishes. + Future _moveToSplayClusterMarker({ + required Supercluster supercluster, + required LayerPoint layerPoint, + required FutureOr Function(LatLng center, double zoom) move, + required bool showPopup, + }) async { + // Find the parent. + final layerCluster = supercluster.parentOf(layerPoint)!; + + // Shorthand for creating an ExpandedCluster. + createExpandedCluster() => ExpandedCluster( + vsync: this, + mapCamera: widget.mapCamera, + layerPoints: + supercluster.childrenOf(layerCluster).cast>(), + layerCluster: layerCluster, + clusterSplayDelegate: widget.clusterSplayDelegate, + ); + + // Find or create the marker's ExpandedCluster and use it to find the + // DisplacedMarker. + final expandedClusterBeforeMovement = + _expandedClusterManager.forLayerCluster(layerCluster); + final createdExpandedCluster = + expandedClusterBeforeMovement != null ? null : createExpandedCluster(); + final displacedMarker = + (expandedClusterBeforeMovement ?? createdExpandedCluster)! + .markersToDisplacedMarkers[layerPoint.originalPoint]!; + + // Move to the DisplacedMarker. + await move( + displacedMarker.displacedPoint, + max(widget.mapCamera.zoom, layerPoint.lowestZoom - 0.99999), + ); + + // Determine the ExpandedCluster after movement, either: + // 1. We created one (without adding it to ExpandedClusterManager) + // because there was none before movement. + // 2. Movement may have caused the ExpandedCluster to be removed in which + // case we create a new one. + final splayAnimation = _expandedClusterManager.putIfAbsent( + layerCluster, + () => createdExpandedCluster ?? createExpandedCluster(), + ); + if (splayAnimation != null) { + if (!mounted) return; + setState(() {}); + await splayAnimation; + } + + if (showPopup) { + final popupSpec = PopupSpecBuilder.forDisplacedMarker( + displacedMarker, + layerCluster.highestZoom, + ); + _selectMarker(popupSpec); + } + } + + void _onSuperclusterEvent(SuperclusterEvent event) async { + switch (event) { + case AddMarkerEvent(): + _superclusterCompleter.operation.then((supercluster) { + (supercluster as SuperclusterMutable).add(event.marker); + _removeExpandedClustersOfRemovedClusters(supercluster); + _onMarkersChange(); + }); + case AddAllMarkerEvent(): + _superclusterCompleter.operation.then((supercluster) { + (supercluster as SuperclusterMutable).addAll(event.markers); + _removeExpandedClustersOfRemovedClusters(supercluster); + _onMarkersChange(); + }); + case RemoveMarkerEvent(): + _superclusterCompleter.operation.then((supercluster) { + final removed = (supercluster as SuperclusterMutable) + .remove(event.marker); + + if (removed) { + _removeExpandedClustersOfRemovedClusters(supercluster); + _hidePopupsInNamespaceFor([event.marker]); + _onMarkersChange(); + } + }); + case RemoveAllMarkerEvent(): + _superclusterCompleter.operation.then((supercluster) { + final removed = (supercluster as SuperclusterMutable) + .removeAll(event.markers); + if (removed) { + _removeExpandedClustersOfRemovedClusters(supercluster); + _hidePopupsInNamespaceFor(event.markers); + _onMarkersChange(); + } + }); + case ReplaceAllMarkerEvent(): + _initializeSupercluster(Future.value(event.markers)); + _expandedClusterManager.clear(); + case ModifyMarkerEvent(): + _superclusterCompleter.operation.then((supercluster) { + final modified = + (supercluster as SuperclusterMutable).modifyPointData( + event.oldMarker, + event.newMarker, + updateParentClusters: event.updateParentClusters, + ); + + if (modified) { + _removeExpandedClustersOfRemovedClusters(supercluster); + _hidePopupsInNamespaceFor([event.oldMarker]); + _onMarkersChange(); + } + }); + case CollapseSplayedClustersEvent(): + _expandedClusterManager.collapseThenRemoveAll(); + case ShowPopupsAlsoForEvent(): + if (widget.popupOptions == null) return; + widget.popupOptions?.popupController.showPopupsAlsoForSpecs( + PopupSpecBuilder.buildList( + supercluster: await _superclusterCompleter.operation.value, + zoom: widget.mapCamera.zoom.ceil(), + maxZoom: _superclusterConfig.maxZoom, + markers: event.markers, + expandedClusters: _expandedClusterManager.all, + ), + disableAnimation: event.disableAnimation, + ); + case MoveToMarkerEvent(): + _moveToMarker( + markerMatcher: event.markerMatcher, + showPopup: event.showPopup, + moveMap: event.moveMap, + ); + case ShowPopupsOnlyForEvent(): + if (widget.popupOptions == null) return; + widget.popupOptions?.popupController.showPopupsOnlyForSpecs( + PopupSpecBuilder.buildList( + supercluster: await _superclusterCompleter.operation.value, + zoom: widget.mapCamera.zoom.ceil(), + maxZoom: _superclusterConfig.maxZoom, + markers: event.markers, + expandedClusters: _expandedClusterManager.all, + ), + disableAnimation: event.disableAnimation, + ); + case HideAllPopupsEvent(): + if (widget.popupOptions == null) return; + widget.popupOptions?.popupController.hideAllPopups( + disableAnimation: event.disableAnimation, + ); + case HidePopupsWhereEvent(): + if (widget.popupOptions == null) return; + widget.popupOptions?.popupController.hidePopupsWhere( + event.test, + disableAnimation: event.disableAnimation, + ); + case HidePopupsOnlyForEvent(): + if (widget.popupOptions == null) return; + widget.popupOptions?.popupController.hidePopupsOnlyFor( + event.markers, + disableAnimation: event.disableAnimation, + ); + case TogglePopupEvent(): + if (widget.popupOptions == null) return; + final popupSpec = PopupSpecBuilder.build( + supercluster: await _superclusterCompleter.operation.value, + zoom: widget.mapCamera.zoom.ceil(), + maxZoom: _superclusterConfig.maxZoom, + marker: event.marker, + expandedClusters: _expandedClusterManager.all, + ); + if (popupSpec == null) return; + widget.popupOptions?.popupController.togglePopupSpec( + popupSpec, + disableAnimation: event.disableAnimation, + ); + } + + setState(() {}); + } + + void _removeExpandedClustersOfRemovedClusters( + SuperclusterMutable supercluster) { + final toRemove = _expandedClusterManager.all + .where((e) => !supercluster.containsElement(e.layerCluster)); + if (toRemove.isNotEmpty) { + _expandedClusterManager.removeAllImmediately(toRemove); + } + } + + void _hidePopupsInNamespaceFor(Iterable markers) { + widget.popupOptions?.popupController.hidePopupsWhereSpec((spec) => + spec.namespace == SuperclusterLayer.popupNamespace && + markers.contains(spec.marker)); + } +} diff --git a/lib/src/layer/supercluster_parameters.dart b/lib/src/layer/supercluster_parameters.dart new file mode 100644 index 0000000..1fee870 --- /dev/null +++ b/lib/src/layer/supercluster_parameters.dart @@ -0,0 +1,32 @@ +import 'package:flutter_map/plugin_api.dart'; +import 'package:flutter_map_supercluster/src/layer/supercluster_config.dart'; +import 'package:supercluster/supercluster.dart'; + +class SuperclusterParameters implements SuperclusterConfig { + final SuperclusterConfig config; + final List markers; + + SuperclusterParameters({ + required this.config, + required this.markers, + }); + + @override + ClusterDataBase Function(Marker marker)? get innerClusterDataExtractor => + config.innerClusterDataExtractor; + + @override + bool get isMutableSupercluster => config.isMutableSupercluster; + + @override + int get maxClusterRadius => config.maxClusterRadius; + + @override + int get maxZoom => config.maxZoom; + + @override + int get minZoom => config.minZoom; + + @override + int? get minimumClusterSize => config.minimumClusterSize; +} diff --git a/lib/src/marker_extension.dart b/lib/src/marker_extension.dart index 3074485..5cffd27 100644 --- a/lib/src/marker_extension.dart +++ b/lib/src/marker_extension.dart @@ -1,8 +1,10 @@ import 'package:flutter_map/plugin_api.dart'; extension MarkerExtension on Marker { - Anchor get anchor => Anchor.fromPos( - anchorPos ?? AnchorPos.align(AnchorAlign.center), + Anchor get anchorWithDefault => + anchor ?? + Anchor.fromPos( + AnchorPos.defaultAnchorPos, width, height, ); diff --git a/lib/src/options/index_builder.dart b/lib/src/options/index_builder.dart index cd3b056..3ed16fc 100644 --- a/lib/src/options/index_builder.dart +++ b/lib/src/options/index_builder.dart @@ -1,13 +1,15 @@ import 'package:flutter/foundation.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; -import 'package:flutter_map_supercluster/src/layer/supercluster_config.dart'; +import 'package:flutter_map_supercluster/src/layer/supercluster_parameters.dart'; /// A callback used to create a supercluster index. See [IndexBuilders] for /// predefined builders and guidelines on which one to use. typedef IndexBuilder = Future> Function( - Supercluster Function(SuperclusterConfig config) createSupercluster, - SuperclusterConfig superclusterConfig, + Supercluster Function( + SuperclusterParameters parameters, + ) createSupercluster, + SuperclusterParameters superclusterParameters, ); /// Predefined builders for creating a supercluster index. The following is a @@ -32,9 +34,9 @@ class IndexBuilders { /// Creates the supercluster in the root isolate. This is the best choice if /// you don't experience jank when creating the index. - static IndexBuilder rootIsolate = - ((createSupercluster, superclusterConfig) async => - createSupercluster(superclusterConfig)); + static final IndexBuilder rootIsolate = + ((createSupercluster, superclusterParameters) async => + createSupercluster(superclusterParameters)); /// Creates the supercluster in a separate isolate using flutter's [compute] /// method and then replaces the copied Marker instances in the supercluster @@ -43,10 +45,10 @@ class IndexBuilders { /// down index creation for large numbers of Markers. This is unnecessary if /// you extend Marker and override its hashCode/== methods, in which case you /// should use [computeWithCopiedMarkers]. - static IndexBuilder computeWithOriginalMarkers = - ((createSupercluster, superclusterConfig) async => - compute(createSupercluster, superclusterConfig).then((supercluster) => - supercluster..replacePoints(superclusterConfig.markers))); + static final IndexBuilder computeWithOriginalMarkers = ((createSupercluster, + superclusterParameters) async => + compute(createSupercluster, superclusterParameters).then((supercluster) => + supercluster..replacePoints(superclusterParameters.markers))); /// Creates the supercluster in a separate isolate using flutter's [compute] /// method. Dart creates copies of objects when running code in a separate @@ -58,9 +60,9 @@ class IndexBuilders { /// /// Failure to override hashCode/== will prevent popups from working properly /// for splayed clusters and may cause other issues. - static IndexBuilder computeWithCopiedMarkers = - ((createSupercluster, superclusterConfig) async => - compute(createSupercluster, superclusterConfig)); + static final IndexBuilder computeWithCopiedMarkers = + ((createSupercluster, superclusterParameters) async => + compute(createSupercluster, superclusterParameters)); /// Calls the provided [indexBuilder] before replacing the resulting index's /// markers with the original markers. This is only necessary when the @@ -69,8 +71,8 @@ class IndexBuilders { /// the index in a separate isolate or the Markers override hashCode/== you /// should just use a plain IndexBuilder instance. static IndexBuilder customWithOriginalMarkers(IndexBuilder indexBuilder) => - ((createSupercluster, superclusterConfig) async => indexBuilder - .call(createSupercluster, superclusterConfig) + ((createSupercluster, superclusterParameters) async => indexBuilder + .call(createSupercluster, superclusterParameters) .then((supercluster) => - supercluster..replacePoints(superclusterConfig.markers))); + supercluster..replacePoints(superclusterParameters.markers))); } diff --git a/lib/src/splay/cluster_splay_delegate.dart b/lib/src/splay/cluster_splay_delegate.dart index c2a7e0e..bce1fd0 100644 --- a/lib/src/splay/cluster_splay_delegate.dart +++ b/lib/src/splay/cluster_splay_delegate.dart @@ -1,3 +1,5 @@ +import 'dart:math'; + import 'package:flutter/material.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/layer/supercluster_layer.dart'; @@ -28,16 +30,16 @@ abstract class ClusterSplayDelegate { List displaceMarkers( List markers, { required LatLng clusterPosition, - required CustomPoint Function(LatLng latLng) project, - required LatLng Function(CustomPoint point) unproject, + required Point Function(LatLng latLng) project, + required LatLng Function(Point point) unproject, }); /// Calculate the marker offsets at the given [animationProgress]. List displacedMarkerOffsets( List displacedMarkers, double animationProgress, - CustomPoint Function(LatLng point) getPixelOffset, - CustomPoint clusterPosition, + Point Function(LatLng point) getPixelOffset, + Point clusterPosition, ); /// Create an optional decoration such as lines from the markers to the diff --git a/lib/src/splay/displaced_marker.dart b/lib/src/splay/displaced_marker.dart index dec7b8d..496d211 100644 --- a/lib/src/splay/displaced_marker.dart +++ b/lib/src/splay/displaced_marker.dart @@ -3,7 +3,8 @@ import 'package:flutter_map/plugin_api.dart'; import 'package:latlong2/latlong.dart'; class DisplacedMarker { - static final anchorPos = AnchorPos.align(AnchorAlign.center); + static const anchorPos = AnchorPos.align(AnchorAlign.center); + final Marker marker; final LatLng displacedPoint; diff --git a/lib/src/splay/displaced_marker_offset.dart b/lib/src/splay/displaced_marker_offset.dart index 4f99366..ad7d49e 100644 --- a/lib/src/splay/displaced_marker_offset.dart +++ b/lib/src/splay/displaced_marker_offset.dart @@ -1,3 +1,5 @@ +import 'dart:math'; + import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/splay/displaced_marker.dart'; @@ -5,8 +7,8 @@ import 'package:flutter_map_supercluster/src/splay/displaced_marker.dart'; /// position. class DisplacedMarkerOffset { final DisplacedMarker displacedMarker; - final CustomPoint displacedOffset; - final CustomPoint originalOffset; + final Point displacedOffset; + final Point originalOffset; const DisplacedMarkerOffset({ required this.displacedMarker, diff --git a/lib/src/splay/popup_spec_builder.dart b/lib/src/splay/popup_spec_builder.dart index 64ef4ee..25d7fc0 100644 --- a/lib/src/splay/popup_spec_builder.dart +++ b/lib/src/splay/popup_spec_builder.dart @@ -16,7 +16,11 @@ class PopupSpecBuilder { markerPointOverride: displacedMarker.displacedPoint, markerRotateAlignmentOveride: DisplacedMarker.rotateAlignment, removeMarkerRotateOrigin: true, - markerAnchorPosOverride: DisplacedMarker.anchorPos, + markerAnchorOverride: Anchor.fromPos( + DisplacedMarker.anchorPos, + displacedMarker.marker.width, + displacedMarker.marker.height, + ), removeIfZoomLessThan: lowestZoom, ); diff --git a/lib/src/splay/spread_cluster_splay_delegate.dart b/lib/src/splay/spread_cluster_splay_delegate.dart index 218f820..7c651e6 100644 --- a/lib/src/splay/spread_cluster_splay_delegate.dart +++ b/lib/src/splay/spread_cluster_splay_delegate.dart @@ -84,8 +84,8 @@ class SpreadClusterSplayDelegate extends ClusterSplayDelegate { List displaceMarkers( List markers, { required LatLng clusterPosition, - required CustomPoint Function(LatLng latLng) project, - required LatLng Function(CustomPoint point) unproject, + required Point Function(LatLng latLng) project, + required LatLng Function(Point point) unproject, }) { final markersWithAngles = markers .map( @@ -118,8 +118,8 @@ class SpreadClusterSplayDelegate extends ClusterSplayDelegate { List displacedMarkerOffsets( List displacedMarkers, double animationProgress, - CustomPoint Function(LatLng point) getPixelOffset, - CustomPoint clusterPosition, + Point Function(LatLng point) getPixelOffset, + Point clusterPosition, ) { return displacedMarkers .map( @@ -156,13 +156,13 @@ class SpreadClusterSplayDelegate extends ClusterSplayDelegate { return atan2(y, x); } - static List _clockwiseCircle(double radius, int count) { + static List _clockwiseCircle(double radius, int count) { final angleStep = pi2 / count; - return List.generate(count, (index) { + return List.generate(count, (index) { final angle = circleStartAngle + index * angleStep; - return CustomPoint( + return Point( radius * cos(angle), radius * sin(angle), ); diff --git a/lib/src/state/inherit_or_create_supercluster_scope.dart b/lib/src/state/inherit_or_create_supercluster_scope.dart new file mode 100644 index 0000000..2f20625 --- /dev/null +++ b/lib/src/state/inherit_or_create_supercluster_scope.dart @@ -0,0 +1,21 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_map_supercluster/src/state/inherited_supercluster_scope.dart'; +import 'package:flutter_map_supercluster/src/state/supercluster_scope.dart'; + +class InheritOrCreateSuperclusterScope extends StatelessWidget { + final Widget child; + const InheritOrCreateSuperclusterScope({ + super.key, + required this.child, + }); + + @override + Widget build(BuildContext context) { + final superclusterScopeState = + InheritedSuperclusterScope.maybeOf(context, listen: false); + + return superclusterScopeState != null + ? child + : SuperclusterScope(child: child); + } +} diff --git a/lib/src/state/inherited_supercluster_scope.dart b/lib/src/state/inherited_supercluster_scope.dart new file mode 100644 index 0000000..64999b2 --- /dev/null +++ b/lib/src/state/inherited_supercluster_scope.dart @@ -0,0 +1,41 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_map_supercluster/src/state/supercluster_state.dart'; + +class InheritedSuperclusterScope extends InheritedWidget { + final SuperclusterState superclusterState; + final void Function(SuperclusterStateImpl stateImpl) setSuperclusterState; + + const InheritedSuperclusterScope({ + super.key, + required this.superclusterState, + required this.setSuperclusterState, + required super.child, + }); + + static InheritedSuperclusterScope? maybeOf( + BuildContext context, { + bool listen = true, + }) { + if (listen) { + return context + .dependOnInheritedWidgetOfExactType(); + } else { + return context + .getInheritedWidgetOfExactType(); + } + } + + static InheritedSuperclusterScope of( + BuildContext context, { + bool listen = true, + }) { + final result = maybeOf(context, listen: listen); + assert( + result != null, 'No InheritedSuperclusterScopeState found in context.'); + return result!; + } + + @override + bool updateShouldNotify(InheritedSuperclusterScope oldWidget) => + oldWidget.superclusterState != superclusterState; +} diff --git a/lib/src/state/marker_supercluster.dart b/lib/src/state/marker_supercluster.dart new file mode 100644 index 0000000..e69de29 diff --git a/lib/src/state/supercluster_scope.dart b/lib/src/state/supercluster_scope.dart new file mode 100644 index 0000000..9a395f3 --- /dev/null +++ b/lib/src/state/supercluster_scope.dart @@ -0,0 +1,39 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_map_supercluster/src/state/inherited_supercluster_scope.dart'; +import 'package:flutter_map_supercluster/src/state/supercluster_state.dart'; + +class SuperclusterScope extends StatefulWidget { + final Widget child; + + const SuperclusterScope({ + super.key, + required this.child, + }); + + @override + State createState() => _SuperclusterScopeState(); +} + +class _SuperclusterScopeState extends State { + late SuperclusterState superclusterState; + + @override + void initState() { + super.initState(); + superclusterState = const SuperclusterStateImpl( + supercluster: null, + aggregatedClusterData: null, + ); + } + + @override + Widget build(BuildContext context) { + return InheritedSuperclusterScope( + superclusterState: superclusterState, + setSuperclusterState: (superclusterState) => setState(() { + this.superclusterState = superclusterState; + }), + child: widget.child, + ); + } +} diff --git a/lib/src/state/supercluster_state.dart b/lib/src/state/supercluster_state.dart new file mode 100644 index 0000000..00201f0 --- /dev/null +++ b/lib/src/state/supercluster_state.dart @@ -0,0 +1,48 @@ +import 'package:equatable/equatable.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_map/plugin_api.dart'; +import 'package:flutter_map_supercluster/flutter_map_supercluster.dart'; +import 'package:flutter_map_supercluster/src/state/inherited_supercluster_scope.dart'; + +abstract class SuperclusterState { + bool get loading; + + ClusterData? get aggregatedClusterData; + + static SuperclusterState? maybeOf( + BuildContext context, { + bool listen = true, + }) { + return InheritedSuperclusterScope.maybeOf( + context, + listen: listen, + )?.superclusterState; + } + + static SuperclusterState of( + BuildContext context, { + bool listen = true, + }) { + final SuperclusterState? result = maybeOf(context, listen: listen); + assert(result != null, 'No SuperclusterState found in context.'); + return result!; + } +} + +class SuperclusterStateImpl extends Equatable implements SuperclusterState { + @override + final ClusterData? aggregatedClusterData; + + final Supercluster? _supercluster; + + @override + bool get loading => _supercluster == null; + + const SuperclusterStateImpl({ + required this.aggregatedClusterData, + required Supercluster? supercluster, + }) : _supercluster = supercluster; + + @override + List get props => [loading, aggregatedClusterData]; +} diff --git a/lib/src/widget/cluster_widget.dart b/lib/src/widget/cluster_widget.dart index 9a383fd..a84e493 100644 --- a/lib/src/widget/cluster_widget.dart +++ b/lib/src/widget/cluster_widget.dart @@ -3,7 +3,7 @@ import 'dart:math'; import 'package:flutter/material.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/layer/anchor_util.dart'; -import 'package:flutter_map_supercluster/src/layer/flutter_map_state_extension.dart'; +import 'package:flutter_map_supercluster/src/layer/map_camera_extension.dart'; import 'package:flutter_map_supercluster/src/layer_element_extension.dart'; import 'package:supercluster/supercluster.dart'; @@ -20,19 +20,19 @@ class ClusterWidget extends StatelessWidget { ClusterWidget({ Key? key, - required FlutterMapState mapState, + required MapCamera mapCamera, required this.cluster, required this.builder, required this.onTap, required this.size, - required AnchorPos? anchorPos, + required Anchor anchor, }) : position = _getClusterPixel( - mapState, + mapCamera, cluster, - anchorPos, + anchor, size, ), - mapRotationRad = mapState.rotationRad, + mapRotationRad = mapCamera.rotationRad, super(key: ValueKey(cluster.uuid)); @override @@ -61,16 +61,16 @@ class ClusterWidget extends StatelessWidget { } static Point _getClusterPixel( - FlutterMapState mapState, + MapCamera mapCamera, LayerCluster cluster, - AnchorPos? anchorPos, + Anchor anchor, Size size, ) { - return AnchorUtil.removeClusterAnchor( - mapState.getPixelOffset(cluster.latLng), - cluster, - anchorPos, - size, + return AnchorUtil.removeAnchor( + mapCamera.getPixelOffset(cluster.latLng), + size.width, + size.height, + anchor, ); } } diff --git a/lib/src/widget/expandable_cluster_widget.dart b/lib/src/widget/expandable_cluster_widget.dart index b2082fc..9ad4f10 100644 --- a/lib/src/widget/expandable_cluster_widget.dart +++ b/lib/src/widget/expandable_cluster_widget.dart @@ -1,7 +1,9 @@ +import 'dart:math'; + import 'package:flutter/material.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_marker_popup/extension_api.dart'; -import 'package:flutter_map_supercluster/src/layer/flutter_map_state_extension.dart'; +import 'package:flutter_map_supercluster/src/layer/map_camera_extension.dart'; import 'package:flutter_map_supercluster/src/layer_element_extension.dart'; import 'package:flutter_map_supercluster/src/splay/popup_spec_builder.dart'; import 'package:flutter_map_supercluster/src/widget/cluster_widget.dart'; @@ -11,28 +13,28 @@ import 'package:flutter_map_supercluster/src/widget/marker_widget.dart'; import '../layer/supercluster_layer.dart'; class ExpandableClusterWidget extends StatelessWidget { - final FlutterMapState mapState; + final MapCamera mapCamera; final ExpandedCluster expandedCluster; final ClusterWidgetBuilder builder; final Size size; - final AnchorPos? anchorPos; + final Anchor anchor; final Widget Function(BuildContext, Marker) markerBuilder; final void Function(PopupSpec popupSpec) onMarkerTap; final VoidCallback onCollapse; - final CustomPoint clusterPixelPosition; + final Point clusterPixelPosition; ExpandableClusterWidget({ Key? key, - required this.mapState, + required this.mapCamera, required this.expandedCluster, required this.builder, required this.size, - required this.anchorPos, + required this.anchor, required this.markerBuilder, required this.onMarkerTap, required this.onCollapse, }) : clusterPixelPosition = - mapState.getPixelOffset(expandedCluster.layerCluster.latLng), + mapCamera.getPixelOffset(expandedCluster.layerCluster.latLng), super(key: ValueKey('expandable-${expandedCluster.layerCluster.uuid}')); @override @@ -41,7 +43,7 @@ class ExpandableClusterWidget extends StatelessWidget { animation: expandedCluster.animation, builder: (context, _) { final displacedMarkerOffsets = expandedCluster.displacedMarkerOffsets( - mapState, + mapCamera, clusterPixelPosition, ); final splayDecoration = expandedCluster.splayDecoration( @@ -73,17 +75,17 @@ class ExpandableClusterWidget extends StatelessWidget { expandedCluster.minimumVisibleZoom, ), ), - mapRotationRad: mapState.rotationRad, + mapRotationRad: mapCamera.rotationRad, ), ), ClusterWidget( - mapState: mapState, + mapCamera: mapCamera, cluster: expandedCluster.layerCluster, builder: (context, latLng, count, data) => expandedCluster.buildCluster(context, builder), onTap: expandedCluster.isExpanded ? onCollapse : () {}, size: size, - anchorPos: anchorPos, + anchor: anchor, ), ], ), diff --git a/lib/src/widget/expanded_cluster.dart b/lib/src/widget/expanded_cluster.dart index b7f5641..9109f84 100644 --- a/lib/src/widget/expanded_cluster.dart +++ b/lib/src/widget/expanded_cluster.dart @@ -3,7 +3,7 @@ import 'dart:math'; import 'package:flutter/material.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/layer/cluster_data.dart'; -import 'package:flutter_map_supercluster/src/layer/flutter_map_state_extension.dart'; +import 'package:flutter_map_supercluster/src/layer/map_camera_extension.dart'; import 'package:flutter_map_supercluster/src/layer/supercluster_layer.dart'; import 'package:flutter_map_supercluster/src/layer_element_extension.dart'; import 'package:flutter_map_supercluster/src/splay/cluster_splay_delegate.dart'; @@ -26,7 +26,7 @@ class ExpandedCluster { ExpandedCluster({ required TickerProvider vsync, required this.layerCluster, - required FlutterMapState mapState, + required MapCamera mapCamera, required List> layerPoints, required this.clusterSplayDelegate, }) : clusterData = layerCluster.clusterData as ClusterData, @@ -38,9 +38,9 @@ class ExpandedCluster { layerPoints.map((e) => e.originalPoint).toList(), clusterPosition: layerCluster.latLng, project: (latLng) => - mapState.project(latLng, layerCluster.highestZoom.toDouble()), + mapCamera.project(latLng, layerCluster.highestZoom.toDouble()), unproject: (point) => - mapState.unproject(point, layerCluster.highestZoom.toDouble()), + mapCamera.unproject(point, layerCluster.highestZoom.toDouble()), ), maxMarkerSize = layerPoints.fold( Size.zero, @@ -66,13 +66,13 @@ class ExpandedCluster { int get minimumVisibleZoom => layerCluster.highestZoom; List displacedMarkerOffsets( - FlutterMapState mapState, - CustomPoint clusterPosition, + MapCamera mapCamera, + Point clusterPosition, ) => clusterSplayDelegate.displacedMarkerOffsets( displacedMarkers, animation.value, - mapState.getPixelOffset, + mapCamera.getPixelOffset, clusterPosition, ); diff --git a/lib/src/widget/marker_widget.dart b/lib/src/widget/marker_widget.dart index 3603f1d..6fe7a18 100644 --- a/lib/src/widget/marker_widget.dart +++ b/lib/src/widget/marker_widget.dart @@ -3,7 +3,7 @@ import 'dart:math'; import 'package:flutter/material.dart'; import 'package:flutter_map/plugin_api.dart'; import 'package:flutter_map_supercluster/src/layer/anchor_util.dart'; -import 'package:flutter_map_supercluster/src/layer/flutter_map_state_extension.dart'; +import 'package:flutter_map_supercluster/src/layer/map_camera_extension.dart'; import 'package:flutter_map_supercluster/src/marker_extension.dart'; import 'package:flutter_map_supercluster/src/splay/displaced_marker.dart'; @@ -19,19 +19,19 @@ class MarkerWidget extends StatelessWidget { MarkerWidget({ super.key, - required FlutterMapState mapState, + required MapCamera mapCamera, required this.marker, required this.markerBuilder, required this.onTap, - }) : mapRotationRad = mapState.rotationRad, - position = _getMapPointPixel(mapState, marker), + }) : mapRotationRad = mapCamera.rotationRad, + position = _getMapPointPixel(mapCamera, marker), rotateAlignment = marker.rotateAlignment, removeRotateOrigin = false; MarkerWidget.displaced({ Key? key, required DisplacedMarker displacedMarker, - required CustomPoint position, + required Point position, required this.markerBuilder, required this.onTap, required this.mapRotationRad, @@ -48,10 +48,13 @@ class MarkerWidget extends StatelessWidget { @override Widget build(BuildContext context) { - final child = GestureDetector( - behavior: HitTestBehavior.opaque, - onTap: onTap, - child: markerBuilder(context), + final child = MouseRegion( + cursor: SystemMouseCursors.click, + child: GestureDetector( + behavior: HitTestBehavior.opaque, + onTap: onTap, + child: markerBuilder(context), + ), ); return Positioned( @@ -72,14 +75,14 @@ class MarkerWidget extends StatelessWidget { } static Point _getMapPointPixel( - FlutterMapState mapState, + MapCamera mapCamera, Marker marker, ) { return AnchorUtil.removeAnchor( - mapState.getPixelOffset(marker.point), + mapCamera.getPixelOffset(marker.point), marker.width, marker.height, - marker.anchor, + marker.anchorWithDefault, ); } } diff --git a/pubspec.yaml b/pubspec.yaml index 8c1cca8..202e21b 100755 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,10 @@ name: flutter_map_supercluster description: Very fast Marker clustering for flutter_map. Supports efficient adding/removing of Markers. -version: 4.3.0 - +version: 5.0.0-dev.1 homepage: https://github.com/rorystephenson/flutter_map_supercluster +topics: + - flutter-map + - cluster environment: sdk: ">=3.0.0 <4.0.0" @@ -13,11 +15,11 @@ dependencies: equatable: ^2.0.5 flutter: sdk: flutter - flutter_map: ^5.0.0 - flutter_map_marker_popup: ^5.2.0 + flutter_map: ^6.0.0-dev.2 + flutter_map_marker_popup: ^5.3.0-dev.1 latlong2: ^0.9.0 provider: ^6.0.5 - supercluster: ^2.4.0 + supercluster: ^3.0.0 dev_dependencies: flutter_lints: ^2.0.2