Skip to content

fix: replace unstable ObjectKey(tileRenderer) with stable TileKey #2195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
braindamagedman wants to merge 1 commit into
base: master
Choose a base branch
from
+39 −1
Open

fix: replace unstable ObjectKey(tileRenderer) with stable TileKey #2195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions lib/src/layer/tile_layer/tile_key.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import 'package:flutter/foundation.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_coordinates.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_image.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_renderer.dart';

/// A key that identifies rendering of a [TileImage] at given [TileCoordinates].
///
/// Two [TileKey]s are equal when they reference the same [TileImage]
/// instance and have equal [positionCoordinates].
final class TileKey extends LocalKey {
/// Tile image to identify by instance.
final TileImage tileImage;

/// Position where [tileImage] is rendered.
final TileCoordinates positionCoordinates;

/// Creates a [TileKey] for the given [TileRenderer].
///
/// The [tileImage] is compared by identity, while [positionCoordinates] are
/// compared by value.
TileKey(TileRenderer renderer)
: tileImage = renderer.tileImage,
positionCoordinates = renderer.positionCoordinates;

@override
bool operator ==(Object other) {
return other is TileKey &&
identical(other.tileImage, tileImage) &&
other.positionCoordinates == positionCoordinates;
}

@override
int get hashCode => Object.hash(
identityHashCode(tileImage),
positionCoordinates,
);
}
3 changes: 2 additions & 1 deletion lib/src/layer/tile_layer/tile_layer.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import 'package:flutter_map/src/layer/tile_layer/tile.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_bounds/tile_bounds.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_bounds/tile_bounds_at_zoom.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_image_manager.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_key.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_range.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_range_calculator.dart';
import 'package:flutter_map/src/layer/tile_layer/tile_scale_calculator.dart';
Expand Down Expand Up @@ -561,7 +562,7 @@ class _TileLayerState extends State<TileLayer> with TickerProviderStateMixin {
.map((tileRenderer) => Tile(
// Must be an ObjectKey, not a ValueKey using the coordinates, in
// case we remove and replace the TileImage with a different one.
key: ObjectKey(tileRenderer),
key: TileKey(tileRenderer),
scaledTileDimension: _tileScaleCalculator.scaledTileDimension(
map.zoom,
tileRenderer.positionCoordinates.z,
Expand Down
Loading