Added clipBehavior to Overlay, Flow, AnimatedSize and AndroidView (#65910)

Author: thecalamiity

packages/flutter/lib/src/rendering/animated_size.dart

@@ -81,10 +81,13 @@ class RenderAnimatedSize extends RenderAligningShiftedBox {
     AlignmentGeometry alignment = Alignment.center,
     TextDirection? textDirection,
     RenderBox? child,
+    Clip clipBehavior = Clip.hardEdge,
   }) : assert(vsync != null),
        assert(duration != null),
        assert(curve != null),
+       assert(clipBehavior != null),
        _vsync = vsync,
+       _clipBehavior = clipBehavior,
        super(child: child, alignment: alignment, textDirection: textDirection) {
     _controller = AnimationController(
       vsync: vsync,
@@ -139,6 +142,20 @@ class RenderAnimatedSize extends RenderAligningShiftedBox {
     _animation.curve = value;
   }
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.hardEdge], and must not be null.
+  Clip get clipBehavior => _clipBehavior;
+  Clip _clipBehavior = Clip.hardEdge;
+  set clipBehavior(Clip value) {
+    assert(value != null);
+    if (value != _clipBehavior) {
+      _clipBehavior = value;
+      markNeedsPaint();
+      markNeedsSemanticsUpdate();
+    }
+  }
+
   /// Whether the size is being currently animated towards the child's size.
   ///
   /// See [RenderAnimatedSizeState] for situations when we may not be animating
@@ -275,9 +292,9 @@ class RenderAnimatedSize extends RenderAligningShiftedBox {
 
   @override
   void paint(PaintingContext context, Offset offset) {
-    if (child != null && _hasVisualOverflow) {
+    if (child != null && _hasVisualOverflow && clipBehavior != Clip.none) {
       final Rect rect = Offset.zero & size;
-      context.pushClipRect(needsCompositing, offset, rect, super.paint);
+      context.pushClipRect(needsCompositing, offset, rect, super.paint, clipBehavior: clipBehavior);
     } else {
       super.paint(context, offset);
     }

packages/flutter/lib/src/rendering/flow.dart

@@ -181,8 +181,11 @@ class RenderFlow extends RenderBox
   RenderFlow({
     List<RenderBox>? children,
     required FlowDelegate delegate,
+    Clip clipBehavior = Clip.hardEdge,
   }) : assert(delegate != null),
-       _delegate = delegate {
+       assert(clipBehavior != null),
+       _delegate = delegate,
+       _clipBehavior = clipBehavior {
     addAll(children);
   }
 
@@ -221,6 +224,20 @@ class RenderFlow extends RenderBox
     }
   }
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.hardEdge], and must not be null.
+  Clip get clipBehavior => _clipBehavior;
+  Clip _clipBehavior = Clip.hardEdge;
+  set clipBehavior(Clip value) {
+    assert(value != null);
+    if (value != _clipBehavior) {
+      _clipBehavior = value;
+      markNeedsPaint();
+      markNeedsSemanticsUpdate();
+    }
+  }
+
   @override
   void attach(PipelineOwner owner) {
     super.attach(owner);
@@ -365,7 +382,11 @@ class RenderFlow extends RenderBox
 
   @override
   void paint(PaintingContext context, Offset offset) {
-    context.pushClipRect(needsCompositing, offset, Offset.zero & size, _paintWithDelegate);
+    if (clipBehavior == Clip.none) {
+      _paintWithDelegate(context, offset);
+    } else {
+      context.pushClipRect(needsCompositing, offset, Offset.zero & size, _paintWithDelegate, clipBehavior: clipBehavior);
+    }
   }
 
   @override

packages/flutter/lib/src/rendering/platform_view.dart

@@ -83,10 +83,13 @@ class RenderAndroidView extends RenderBox with _PlatformViewGestureMixin {
     required AndroidViewController viewController,
     required PlatformViewHitTestBehavior hitTestBehavior,
     required Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers,
+    Clip clipBehavior = Clip.hardEdge,
   }) : assert(viewController != null),
        assert(hitTestBehavior != null),
        assert(gestureRecognizers != null),
-       _viewController = viewController {
+       assert(clipBehavior != null),
+       _viewController = viewController,
+       _clipBehavior = clipBehavior {
     _viewController.pointTransformer = (Offset offset) => globalToLocal(offset);
     updateGestureRecognizers(gestureRecognizers);
     _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
@@ -115,6 +118,20 @@ class RenderAndroidView extends RenderBox with _PlatformViewGestureMixin {
     _viewController.addOnPlatformViewCreatedListener(_onPlatformViewCreated);
   }
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.hardEdge], and must not be null.
+  Clip get clipBehavior => _clipBehavior;
+  Clip _clipBehavior = Clip.hardEdge;
+  set clipBehavior(Clip value) {
+    assert(value != null);
+    if (value != _clipBehavior) {
+      _clipBehavior = value;
+      markNeedsPaint();
+      markNeedsSemanticsUpdate();
+    }
+  }
+
   void _onPlatformViewCreated(int id) {
     markNeedsSemanticsUpdate();
   }
@@ -188,8 +205,8 @@ class RenderAndroidView extends RenderBox with _PlatformViewGestureMixin {
 
     // Clip the texture if it's going to paint out of the bounds of the renter box
     // (see comment in _paintTexture for an explanation of when this happens).
-    if (size.width < _currentAndroidViewSize.width || size.height < _currentAndroidViewSize.height) {
-      context.pushClipRect(true, offset, offset & size, _paintTexture);
+    if (size.width < _currentAndroidViewSize.width || size.height < _currentAndroidViewSize.height && clipBehavior != Clip.none) {
+      context.pushClipRect(true, offset, offset & size, _paintTexture, clipBehavior: clipBehavior);
       return;
     }
 

packages/flutter/lib/src/widgets/animated_size.dart

@@ -61,7 +61,9 @@ class AnimatedSize extends SingleChildRenderObjectWidget {
     required this.duration,
     this.reverseDuration,
     required this.vsync,
-  }) : super(key: key, child: child);
+    this.clipBehavior = Clip.hardEdge,
+  }) : assert(clipBehavior != null),
+       super(key: key, child: child);
 
   /// The alignment of the child within the parent when the parent is not yet
   /// the same size as the child.
@@ -101,6 +103,11 @@ class AnimatedSize extends SingleChildRenderObjectWidget {
   /// The [TickerProvider] for this widget.
   final TickerProvider vsync;
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.hardEdge], and must not be null.
+  final Clip clipBehavior;
+
   @override
   RenderAnimatedSize createRenderObject(BuildContext context) {
     return RenderAnimatedSize(
@@ -110,6 +117,7 @@ class AnimatedSize extends SingleChildRenderObjectWidget {
       curve: curve,
       vsync: vsync,
       textDirection: Directionality.of(context),
+      clipBehavior: clipBehavior,
     );
   }
 
@@ -121,7 +129,8 @@ class AnimatedSize extends SingleChildRenderObjectWidget {
       ..reverseDuration = reverseDuration
       ..curve = curve
       ..vsync = vsync
-      ..textDirection = Directionality.of(context);
+      ..textDirection = Directionality.of(context)
+      ..clipBehavior = clipBehavior;
   }
 
   @override

packages/flutter/lib/src/widgets/basic.dart

@@ -5091,7 +5091,9 @@ class Flow extends MultiChildRenderObjectWidget {
     Key? key,
     required this.delegate,
     List<Widget> children = const <Widget>[],
+    this.clipBehavior = Clip.hardEdge,
   }) : assert(delegate != null),
+       assert(clipBehavior != null),
        super(key: key, children: RepaintBoundary.wrapAll(children));
        // https://github.com/dart-lang/sdk/issues/29277
 
@@ -5106,18 +5108,26 @@ class Flow extends MultiChildRenderObjectWidget {
     Key? key,
     required this.delegate,
     List<Widget> children = const <Widget>[],
+    this.clipBehavior = Clip.hardEdge,
   }) : assert(delegate != null),
+       assert(clipBehavior != null),
        super(key: key, children: children);
 
   /// The delegate that controls the transformation matrices of the children.
   final FlowDelegate delegate;
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.none], and must not be null.
+  final Clip clipBehavior;
+
   @override
-  RenderFlow createRenderObject(BuildContext context) => RenderFlow(delegate: delegate);
+  RenderFlow createRenderObject(BuildContext context) => RenderFlow(delegate: delegate, clipBehavior: clipBehavior);
 
   @override
   void updateRenderObject(BuildContext context, RenderFlow renderObject) {
     renderObject.delegate = delegate;
+    renderObject.clipBehavior = clipBehavior;
   }
 }
 

packages/flutter/lib/src/widgets/overlay.dart

@@ -213,7 +213,9 @@ class Overlay extends StatefulWidget {
   const Overlay({
     Key? key,
     this.initialEntries = const <OverlayEntry>[],
+    this.clipBehavior = Clip.hardEdge,
   }) : assert(initialEntries != null),
+       assert(clipBehavior != null),
        super(key: key);
 
   /// The entries to include in the overlay initially.
@@ -231,6 +233,11 @@ class Overlay extends StatefulWidget {
   /// To remove an entry from an [Overlay], use [OverlayEntry.remove].
   final List<OverlayEntry> initialEntries;
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.hardEdge], and must not be null.
+  final Clip clipBehavior;
+
   /// The state from the closest instance of this class that encloses the given context.
   ///
   /// In debug mode, if the `debugRequiredFor` argument is provided then this
@@ -470,6 +477,7 @@ class OverlayState extends State<Overlay> with TickerProviderStateMixin {
     return _Theatre(
       skipCount: children.length - onstageCount,
       children: children.reversed.toList(growable: false),
+      clipBehavior: widget.clipBehavior,
     );
   }
 
@@ -490,15 +498,19 @@ class _Theatre extends MultiChildRenderObjectWidget {
   _Theatre({
     Key? key,
     this.skipCount = 0,
+    this.clipBehavior = Clip.hardEdge,
     List<Widget> children = const <Widget>[],
   }) : assert(skipCount != null),
        assert(skipCount >= 0),
        assert(children != null),
        assert(children.length >= skipCount),
+       assert(clipBehavior != null),
        super(key: key, children: children);
 
   final int skipCount;
 
+  final Clip clipBehavior;
+
   @override
   _TheatreElement createElement() => _TheatreElement(this);
 
@@ -507,14 +519,16 @@ class _Theatre extends MultiChildRenderObjectWidget {
     return _RenderTheatre(
       skipCount: skipCount,
       textDirection: Directionality.of(context)!,
+      clipBehavior: clipBehavior,
     );
   }
 
   @override
   void updateRenderObject(BuildContext context, _RenderTheatre renderObject) {
     renderObject
       ..skipCount = skipCount
-      ..textDirection = Directionality.of(context)!;
+      ..textDirection = Directionality.of(context)!
+      ..clipBehavior = clipBehavior;
   }
 
   @override
@@ -545,11 +559,14 @@ class _RenderTheatre extends RenderBox with ContainerRenderObjectMixin<RenderBox
     List<RenderBox>? children,
     required TextDirection textDirection,
     int skipCount = 0,
+    Clip clipBehavior = Clip.hardEdge,
   }) : assert(skipCount != null),
        assert(skipCount >= 0),
        assert(textDirection != null),
+       assert(clipBehavior != null),
        _textDirection = textDirection,
-       _skipCount = skipCount {
+       _skipCount = skipCount,
+       _clipBehavior = clipBehavior {
     addAll(children);
   }
 
@@ -593,6 +610,20 @@ class _RenderTheatre extends RenderBox with ContainerRenderObjectMixin<RenderBox
     }
   }
 
+  /// {@macro flutter.widgets.Clip}
+  ///
+  /// Defaults to [Clip.hardEdge], and must not be null.
+  Clip get clipBehavior => _clipBehavior;
+  Clip _clipBehavior = Clip.hardEdge;
+  set clipBehavior(Clip value) {
+    assert(value != null);
+    if (value != _clipBehavior) {
+      _clipBehavior = value;
+      markNeedsPaint();
+      markNeedsSemanticsUpdate();
+    }
+  }
+
   RenderBox? get _firstOnstageChild {
     if (skipCount == super.childCount) {
       return null;
@@ -724,8 +755,8 @@ class _RenderTheatre extends RenderBox with ContainerRenderObjectMixin<RenderBox
 
   @override
   void paint(PaintingContext context, Offset offset) {
-    if (_hasVisualOverflow) {
-      context.pushClipRect(needsCompositing, offset, Offset.zero & size, paintStack);
+    if (_hasVisualOverflow && clipBehavior != Clip.none) {
+      context.pushClipRect(needsCompositing, offset, Offset.zero & size, paintStack, clipBehavior: clipBehavior);
     } else {
       paintStack(context, offset);
     }