Skip to content
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

refactor: use separate painters for each Polyline #1697

Closed
wants to merge 2 commits into from
Closed

refactor: use separate painters for each Polyline #1697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6aa39d
feat: 🎸 modify Polyline painter
thomascoumau Oct 20, 2023
7c5ae56
Merge branch 'master' into feature/rework-polyline-painter
JaffaKetchup Oct 25, 2023
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
199 changes: 101 additions & 98 deletions lib/src/layer/polyline_layer.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,44 +67,55 @@ class PolylineLayer extends StatelessWidget {
@override
Widget build(BuildContext context) {
final map = MapCamera.of(context);
final visiblePolylines = polylineCulling
? polylines
.where((p) => p.boundingBox.isOverlapping(map.visibleBounds))
.toList()
: polylines;

return MobileLayerTransformer(
child: CustomPaint(
painter: PolylinePainter(
polylineCulling
? polylines
.where((p) => p.boundingBox.isOverlapping(map.visibleBounds))
.toList()
: polylines,
map,
),
size: Size(map.size.x, map.size.y),
isComplex: true,
),
child: Stack(
children: visiblePolylines
.map(
(polyline) => GestureDetector(
child: CustomPaint(
painter: PolylinePainter(
polyline,
map,
),
size: Size(map.size.x, map.size.y),
isComplex: true,
),
),
)
.toList()),
);
}
}

class PolylinePainter extends CustomPainter {
final List<Polyline> polylines;

final Polyline polyline;
final MapCamera map;
final LatLngBounds bounds;

PolylinePainter(this.polylines, this.map) : bounds = map.visibleBounds;
PolylinePainter(this.polyline, this.map) : bounds = map.visibleBounds;

int get hash => _hash ??= Object.hashAll(polylines);
int get hash => _hash ??= Object.hashAll(polyline.points);

int? _hash;

Offset getOffset(LatLng point) => map.getOffsetFromOrigin(point);

List<Offset> getOffsets(List<LatLng> points) {
return List.generate(points.length, (index) {
return getOffset(points[index]);
}, growable: false);
return List.generate(
points.length,
(index) {
return getOffset(points[index]);
},
growable: false,
);
}

Offset getOffset(LatLng point) => map.getOffsetFromOrigin(point);

@override
void paint(Canvas canvas, Size size) {
final rect = Offset.zero & size;
Expand All @@ -114,6 +125,7 @@ class PolylinePainter extends CustomPainter {
var filterPath = ui.Path();
var paint = Paint();
var needsLayerSaving = false;
final offsets = getOffsets(polyline.points);

Paint? borderPaint;
Paint? filterPaint;
Expand Down Expand Up @@ -144,90 +156,83 @@ class PolylinePainter extends CustomPainter {
paint = Paint();
}

for (final polyline in polylines) {
final offsets = getOffsets(polyline.points);
if (offsets.isEmpty) {
continue;
}
final hash = polyline.renderHashCode;
if (needsLayerSaving || lastHash != hash) {
drawPaths();
}
lastHash = hash;
needsLayerSaving = polyline.color.opacity < 1.0 ||
(polyline.gradientColors?.any((c) => c.opacity < 1.0) ?? false);

late final double strokeWidth;
if (polyline.useStrokeWidthInMeter) {
final firstPoint = polyline.points.first;
final firstOffset = offsets.first;
final r = const Distance().offset(
firstPoint,
polyline.strokeWidth,
180,
);
final delta = firstOffset - getOffset(r);

strokeWidth = delta.distance;
} else {
strokeWidth = polyline.strokeWidth;
}

final hash = polyline.renderHashCode;
if (needsLayerSaving || (lastHash != null && lastHash != hash)) {
drawPaths();
}
lastHash = hash;
needsLayerSaving = polyline.color.opacity < 1.0 ||
(polyline.gradientColors?.any((c) => c.opacity < 1.0) ?? false);

late final double strokeWidth;
if (polyline.useStrokeWidthInMeter) {
final firstPoint = polyline.points.first;
final firstOffset = offsets.first;
final r = const Distance().offset(
firstPoint,
polyline.strokeWidth,
180,
);
final delta = firstOffset - getOffset(r);

strokeWidth = delta.distance;
} else {
strokeWidth = polyline.strokeWidth;
}
final isDotted = polyline.isDotted;
paint = Paint()
..strokeWidth = strokeWidth
..strokeCap = polyline.strokeCap
..strokeJoin = polyline.strokeJoin
..style = isDotted ? PaintingStyle.fill : PaintingStyle.stroke
..blendMode = BlendMode.srcOver;

if (polyline.gradientColors == null) {
paint.color = polyline.color;
} else {
polyline.gradientColors!.isNotEmpty
? paint.shader = _paintGradient(polyline, offsets)
: paint.color = polyline.color;
}

final isDotted = polyline.isDotted;
paint = Paint()
..strokeWidth = strokeWidth
if (polyline.borderColor != null && polyline.borderStrokeWidth > 0.0) {
// Outlined lines are drawn by drawing a thicker path underneath, then
// stenciling the middle (in case the line fill is transparent), and
// finally drawing the line fill.
borderPaint = Paint()
..color = polyline.borderColor ?? const Color(0x00000000)
..strokeWidth = strokeWidth + polyline.borderStrokeWidth
..strokeCap = polyline.strokeCap
..strokeJoin = polyline.strokeJoin
..style = isDotted ? PaintingStyle.fill : PaintingStyle.stroke
..blendMode = BlendMode.srcOver;

if (polyline.gradientColors == null) {
paint.color = polyline.color;
} else {
polyline.gradientColors!.isNotEmpty
? paint.shader = _paintGradient(polyline, offsets)
: paint.color = polyline.color;
}

if (polyline.borderColor != null && polyline.borderStrokeWidth > 0.0) {
// Outlined lines are drawn by drawing a thicker path underneath, then
// stenciling the middle (in case the line fill is transparent), and
// finally drawing the line fill.
borderPaint = Paint()
..color = polyline.borderColor ?? const Color(0x00000000)
..strokeWidth = strokeWidth + polyline.borderStrokeWidth
..strokeCap = polyline.strokeCap
..strokeJoin = polyline.strokeJoin
..style = isDotted ? PaintingStyle.fill : PaintingStyle.stroke
..blendMode = BlendMode.srcOver;

filterPaint = Paint()
..color = polyline.borderColor!.withAlpha(255)
..strokeWidth = strokeWidth
..strokeCap = polyline.strokeCap
..strokeJoin = polyline.strokeJoin
..style = isDotted ? PaintingStyle.fill : PaintingStyle.stroke
..blendMode = BlendMode.dstOut;
}
filterPaint = Paint()
..color = polyline.borderColor!.withAlpha(255)
..strokeWidth = strokeWidth
..strokeCap = polyline.strokeCap
..strokeJoin = polyline.strokeJoin
..style = isDotted ? PaintingStyle.fill : PaintingStyle.stroke
..blendMode = BlendMode.dstOut;
}

final radius = paint.strokeWidth / 2;
final borderRadius = (borderPaint?.strokeWidth ?? 0) / 2;
final radius = paint.strokeWidth / 2;
final borderRadius = (borderPaint?.strokeWidth ?? 0) / 2;

if (isDotted) {
final spacing = strokeWidth * 1.5;
if (borderPaint != null && filterPaint != null) {
_paintDottedLine(borderPath, offsets, borderRadius, spacing);
_paintDottedLine(filterPath, offsets, radius, spacing);
}
_paintDottedLine(path, offsets, radius, spacing);
} else {
if (borderPaint != null && filterPaint != null) {
_paintLine(borderPath, offsets);
_paintLine(filterPath, offsets);
}
_paintLine(path, offsets);
if (isDotted) {
final spacing = strokeWidth * 1.5;
if (borderPaint != null && filterPaint != null) {
_paintDottedLine(borderPath, offsets, borderRadius, spacing);
_paintDottedLine(filterPath, offsets, radius, spacing);
}
_paintDottedLine(path, offsets, radius, spacing);
} else {
if (borderPaint != null && filterPaint != null) {
_paintLine(borderPath, offsets);
_paintLine(filterPath, offsets);
}
_paintLine(path, offsets);
}

drawPaths();
Expand Down Expand Up @@ -283,8 +288,6 @@ class PolylinePainter extends CustomPainter {

@override
bool shouldRepaint(PolylinePainter oldDelegate) {
return oldDelegate.bounds != bounds ||
oldDelegate.polylines.length != polylines.length ||
oldDelegate.hash != hash;
return oldDelegate.bounds != bounds || oldDelegate.hash != hash;
}
}
7 changes: 1 addition & 6 deletions test/layer/polyline_layer_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ void main() {
expect(find.byType(FlutterMap), findsOneWidget);
expect(find.byType(PolylineLayer), findsWidgets);

// Assert that batching works and all Polylines are drawn into the same
// CustomPaint/Canvas.
expect(
find.descendant(
of: find.byType(PolylineLayer), matching: find.byType(CustomPaint)),
findsOneWidget);
expect(find.byType(PolylineLayer), findsOneWidget);
});
}