proxy_box_test.dart 18.7 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'dart:typed_data';
6
import 'dart:ui' as ui show Gradient, Image, ImageFilter;
7 8

import 'package:flutter/animation.dart';
9
import 'package:flutter/foundation.dart';
10
import 'package:flutter/gestures.dart';
11
import 'package:flutter/rendering.dart';
12
import 'package:flutter/src/scheduler/ticker.dart';
13
import '../flutter_test_alternative.dart';
14 15 16 17

import 'rendering_tester.dart';

void main() {
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
  test('RenderFittedBox handles applying paint transform and hit-testing with empty size', () {
    final RenderFittedBox fittedBox = RenderFittedBox(
      child: RenderCustomPaint(
        preferredSize: Size.zero,
        painter: TestCallbackPainter(onPaint: () {}),
      ),
    );

    layout(fittedBox, phase: EnginePhase.flushSemantics);
    final Matrix4 transform = Matrix4.identity();
    fittedBox.applyPaintTransform(fittedBox.child, transform);
    expect(transform, Matrix4.zero());

    final BoxHitTestResult hitTestResult = BoxHitTestResult();
    expect(fittedBox.hitTestChildren(hitTestResult), isFalse);
  });

35
  test('RenderFittedBox does not paint with empty sizes', () {
36
    bool painted;
37
    RenderFittedBox makeFittedBox(Size size) {
38 39
      return RenderFittedBox(
        child: RenderCustomPaint(
40
          preferredSize: size,
41
          painter: TestCallbackPainter(onPaint: () {
42 43
            painted = true;
          }),
44 45 46 47
        ),
      );
    }

48
    // The RenderFittedBox paints if both its size and its child's size are nonempty.
49
    painted = false;
50
    layout(makeFittedBox(const Size(1, 1)), phase: EnginePhase.paint);
51 52
    expect(painted, equals(true));

53 54 55 56 57
    // The RenderFittedBox should not paint if its child is empty-sized.
    painted = false;
    layout(makeFittedBox(Size.zero), phase: EnginePhase.paint);
    expect(painted, equals(false));

58 59
    // The RenderFittedBox should not paint if it is empty.
    painted = false;
60
    layout(makeFittedBox(const Size(1, 1)), constraints: BoxConstraints.tight(Size.zero), phase: EnginePhase.paint);
61 62
    expect(painted, equals(false));
  });
63 64 65 66

  test('RenderPhysicalModel compositing on Fuchsia', () {
    debugDefaultTargetPlatformOverride = TargetPlatform.fuchsia;

67
    final RenderPhysicalModel root = RenderPhysicalModel(color: const Color(0xffff00ff));
68
    layout(root, phase: EnginePhase.composite);
69
    expect(root.needsCompositing, isTrue);
70 71 72 73 74 75 76 77 78

    // On Fuchsia, the system compositor is responsible for drawing shadows
    // for physical model layers with non-zero elevation.
    root.elevation = 1.0;
    pumpFrame(phase: EnginePhase.composite);
    expect(root.needsCompositing, isTrue);

    root.elevation = 0.0;
    pumpFrame(phase: EnginePhase.composite);
79
    expect(root.needsCompositing, isTrue);
80 81 82 83 84 85 86

    debugDefaultTargetPlatformOverride = null;
  });

  test('RenderPhysicalModel compositing on non-Fuchsia', () {
    debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

87
    final RenderPhysicalModel root = RenderPhysicalModel(color: const Color(0xffff00ff));
88
    layout(root, phase: EnginePhase.composite);
89
    expect(root.needsCompositing, isTrue);
90

91
    // Flutter now composites physical shapes on all platforms.
92 93
    root.elevation = 1.0;
    pumpFrame(phase: EnginePhase.composite);
94
    expect(root.needsCompositing, isTrue);
95 96 97

    root.elevation = 0.0;
    pumpFrame(phase: EnginePhase.composite);
98
    expect(root.needsCompositing, isTrue);
99 100 101

    debugDefaultTargetPlatformOverride = null;
  });
102 103

  test('RenderSemanticsGestureHandler adds/removes correct semantic actions', () {
104
    final RenderSemanticsGestureHandler renderObj = RenderSemanticsGestureHandler(
105 106
      onTap: () { },
      onHorizontalDragUpdate: (DragUpdateDetails details) { },
107 108
    );

109
    SemanticsConfiguration config = SemanticsConfiguration();
110 111 112 113
    renderObj.describeSemanticsConfiguration(config);
    expect(config.getActionHandler(SemanticsAction.tap), isNotNull);
    expect(config.getActionHandler(SemanticsAction.scrollLeft), isNotNull);
    expect(config.getActionHandler(SemanticsAction.scrollRight), isNotNull);
114

115
    config = SemanticsConfiguration();
116
    renderObj.validActions = <SemanticsAction>{SemanticsAction.tap, SemanticsAction.scrollLeft};
117

118 119 120 121
    renderObj.describeSemanticsConfiguration(config);
    expect(config.getActionHandler(SemanticsAction.tap), isNotNull);
    expect(config.getActionHandler(SemanticsAction.scrollLeft), isNotNull);
    expect(config.getActionHandler(SemanticsAction.scrollRight), isNull);
122
  });
123 124 125 126 127 128 129

  group('RenderPhysicalShape', () {
    setUp(() {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;
    });

    test('shape change triggers repaint', () {
130
      final RenderPhysicalShape root = RenderPhysicalShape(
131
        color: const Color(0xffff00ff),
132
        clipper: const ShapeBorderClipper(shape: CircleBorder()),
133 134 135 136 137
      );
      layout(root, phase: EnginePhase.composite);
      expect(root.debugNeedsPaint, isFalse);

      // Same shape, no repaint.
138
      root.clipper = const ShapeBorderClipper(shape: CircleBorder());
139 140 141
      expect(root.debugNeedsPaint, isFalse);

      // Different shape triggers repaint.
142
      root.clipper = const ShapeBorderClipper(shape: StadiumBorder());
143 144 145 146
      expect(root.debugNeedsPaint, isTrue);
    });

    test('compositing on non-Fuchsia', () {
147
      final RenderPhysicalShape root = RenderPhysicalShape(
148
        color: const Color(0xffff00ff),
149
        clipper: const ShapeBorderClipper(shape: CircleBorder()),
150 151
      );
      layout(root, phase: EnginePhase.composite);
152
      expect(root.needsCompositing, isTrue);
153

154
      // On non-Fuchsia platforms, we composite physical shape layers
155 156
      root.elevation = 1.0;
      pumpFrame(phase: EnginePhase.composite);
157
      expect(root.needsCompositing, isTrue);
158 159 160

      root.elevation = 0.0;
      pumpFrame(phase: EnginePhase.composite);
161
      expect(root.needsCompositing, isTrue);
162 163 164 165

      debugDefaultTargetPlatformOverride = null;
    });
  });
166 167

  test('RenderRepaintBoundary can capture images of itself', () async {
168 169
    RenderRepaintBoundary boundary = RenderRepaintBoundary();
    layout(boundary, constraints: BoxConstraints.tight(const Size(100.0, 200.0)));
170 171 172 173 174 175
    pumpFrame(phase: EnginePhase.composite);
    ui.Image image = await boundary.toImage();
    expect(image.width, equals(100));
    expect(image.height, equals(200));

    // Now with pixel ratio set to something other than 1.0.
176 177
    boundary = RenderRepaintBoundary();
    layout(boundary, constraints: BoxConstraints.tight(const Size(100.0, 200.0)));
178 179 180 181 182 183
    pumpFrame(phase: EnginePhase.composite);
    image = await boundary.toImage(pixelRatio: 2.0);
    expect(image.width, equals(200));
    expect(image.height, equals(400));

    // Try building one with two child layers and make sure it renders them both.
184 185 186
    boundary = RenderRepaintBoundary();
    final RenderStack stack = RenderStack()..alignment = Alignment.topLeft;
    final RenderDecoratedBox blackBox = RenderDecoratedBox(
187
        decoration: const BoxDecoration(color: Color(0xff000000)),
188 189
        child: RenderConstrainedBox(
          additionalConstraints: BoxConstraints.tight(const Size.square(20.0)),
190
        ));
191
    stack.add(RenderOpacity()
192 193
      ..opacity = 0.5
      ..child = blackBox);
194
    final RenderDecoratedBox whiteBox = RenderDecoratedBox(
195
        decoration: const BoxDecoration(color: Color(0xffffffff)),
196 197
        child: RenderConstrainedBox(
          additionalConstraints: BoxConstraints.tight(const Size.square(10.0)),
198
        ));
199
    final RenderPositionedBox positioned = RenderPositionedBox(
200 201 202 203 204 205 206
      widthFactor: 2.0,
      heightFactor: 2.0,
      alignment: Alignment.topRight,
      child: whiteBox,
    );
    stack.add(positioned);
    boundary.child = stack;
207
    layout(boundary, constraints: BoxConstraints.tight(const Size(20.0, 20.0)));
208 209 210 211
    pumpFrame(phase: EnginePhase.composite);
    image = await boundary.toImage();
    expect(image.width, equals(20));
    expect(image.height, equals(20));
212 213 214 215
    ByteData data = await image.toByteData();

    int getPixel(int x, int y) => data.getUint32((x + y * image.width) * 4);

216 217
    expect(data.lengthInBytes, equals(20 * 20 * 4));
    expect(data.elementSizeInBytes, equals(1));
218 219 220
    expect(getPixel(0, 0), equals(0x00000080));
    expect(getPixel(image.width - 1, 0 ), equals(0xffffffff));

221
    final OffsetLayer layer = boundary.debugLayer;
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

    image = await layer.toImage(Offset.zero & const Size(20.0, 20.0));
    expect(image.width, equals(20));
    expect(image.height, equals(20));
    data = await image.toByteData();
    expect(getPixel(0, 0), equals(0x00000080));
    expect(getPixel(image.width - 1, 0 ), equals(0xffffffff));

    // non-zero offsets.
    image = await layer.toImage(const Offset(-10.0, -10.0) & const Size(30.0, 30.0));
    expect(image.width, equals(30));
    expect(image.height, equals(30));
    data = await image.toByteData();
    expect(getPixel(0, 0), equals(0x00000000));
    expect(getPixel(10, 10), equals(0x00000080));
    expect(getPixel(image.width - 1, 0), equals(0x00000000));
    expect(getPixel(image.width - 1, 10), equals(0xffffffff));

    // offset combined with a custom pixel ratio.
    image = await layer.toImage(const Offset(-10.0, -10.0) & const Size(30.0, 30.0), pixelRatio: 2.0);
    expect(image.width, equals(60));
    expect(image.height, equals(60));
    data = await image.toByteData();
    expect(getPixel(0, 0), equals(0x00000000));
    expect(getPixel(20, 20), equals(0x00000080));
    expect(getPixel(image.width - 1, 0), equals(0x00000000));
    expect(getPixel(image.width - 1, 20), equals(0xffffffff));
249
  }, skip: isBrowser);
250 251

  test('RenderOpacity does not composite if it is transparent', () {
252
    final RenderOpacity renderOpacity = RenderOpacity(
253
      opacity: 0.0,
254
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
255 256 257 258 259 260 261
    );

    layout(renderOpacity, phase: EnginePhase.composite);
    expect(renderOpacity.needsCompositing, false);
  });

  test('RenderOpacity does not composite if it is opaque', () {
262
    final RenderOpacity renderOpacity = RenderOpacity(
263
      opacity: 1.0,
264
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
265 266 267 268 269 270
    );

    layout(renderOpacity, phase: EnginePhase.composite);
    expect(renderOpacity.needsCompositing, false);
  });

271 272 273 274 275 276 277
  test('RenderOpacity reuses its layer', () {
    _testLayerReuse<OpacityLayer>(RenderOpacity(
      opacity: 0.5,  // must not be 0 or 1.0. Otherwise, it won't create a layer
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
    ));
  });

278
  test('RenderAnimatedOpacity does not composite if it is transparent', () async {
279 280
    final Animation<double> opacityAnimation = AnimationController(
      vsync: _FakeTickerProvider(),
281 282
    )..value = 0.0;

283
    final RenderAnimatedOpacity renderAnimatedOpacity = RenderAnimatedOpacity(
284
      alwaysIncludeSemantics: false,
285
      opacity: opacityAnimation,
286
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
287 288 289 290 291 292 293
    );

    layout(renderAnimatedOpacity, phase: EnginePhase.composite);
    expect(renderAnimatedOpacity.needsCompositing, false);
  });

  test('RenderAnimatedOpacity does not composite if it is opaque', () {
294 295
    final Animation<double> opacityAnimation = AnimationController(
      vsync: _FakeTickerProvider(),
296 297
    )..value = 1.0;

298
    final RenderAnimatedOpacity renderAnimatedOpacity = RenderAnimatedOpacity(
299
      alwaysIncludeSemantics: false,
300
      opacity: opacityAnimation,
301
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
302 303 304 305 306
    );

    layout(renderAnimatedOpacity, phase: EnginePhase.composite);
    expect(renderAnimatedOpacity.needsCompositing, false);
  });
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483

  test('RenderAnimatedOpacity reuses its layer', () {
    final Animation<double> opacityAnimation = AnimationController(
      vsync: _FakeTickerProvider(),
    )..value = 0.5;  // must not be 0 or 1.0. Otherwise, it won't create a layer

    _testLayerReuse<OpacityLayer>(RenderAnimatedOpacity(
      opacity: opacityAnimation,
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
    ));
  });

  test('RenderShaderMask reuses its layer', () {
    _testLayerReuse<ShaderMaskLayer>(RenderShaderMask(
      shaderCallback: (Rect rect) {
        return ui.Gradient.radial(
          rect.center,
          rect.shortestSide / 2.0,
          const <Color>[Color.fromRGBO(0, 0, 0, 1.0), Color.fromRGBO(255, 255, 255, 1.0)],
        );
      },
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
    ));
  });

  test('RenderBackdropFilter reuses its layer', () {
    _testLayerReuse<BackdropFilterLayer>(RenderBackdropFilter(
      filter: ui.ImageFilter.blur(),
      child: RenderSizedBox(const Size(1.0, 1.0)), // size doesn't matter
    ));
  });

  test('RenderClipRect reuses its layer', () {
    _testLayerReuse<ClipRectLayer>(RenderClipRect(
      clipper: _TestRectClipper(),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  test('RenderClipRRect reuses its layer', () {
    _testLayerReuse<ClipRRectLayer>(RenderClipRRect(
      clipper: _TestRRectClipper(),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  test('RenderClipOval reuses its layer', () {
    _testLayerReuse<ClipPathLayer>(RenderClipOval(
      clipper: _TestRectClipper(),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  test('RenderClipPath reuses its layer', () {
    _testLayerReuse<ClipPathLayer>(RenderClipPath(
      clipper: _TestPathClipper(),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  test('RenderPhysicalModel reuses its layer', () {
    _testLayerReuse<PhysicalModelLayer>(RenderPhysicalModel(
      color: const Color.fromRGBO(0, 0, 0, 1.0),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  test('RenderPhysicalShape reuses its layer', () {
    _testLayerReuse<PhysicalModelLayer>(RenderPhysicalShape(
      clipper: _TestPathClipper(),
      color: const Color.fromRGBO(0, 0, 0, 1.0),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  test('RenderTransform reuses its layer', () {
    _testLayerReuse<TransformLayer>(RenderTransform(
      // Use a 3D transform to force compositing.
      transform: Matrix4.rotationX(0.1),
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1.0, 1.0)),
      ), // size doesn't matter
    ));
  });

  void _testFittedBoxWithClipRectLayer() {
    _testLayerReuse<ClipRectLayer>(RenderFittedBox(
      alignment: Alignment.center,
      fit: BoxFit.cover,
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(100.0, 200.0)),
      ), // size doesn't matter
    ));
  }

  void _testFittedBoxWithTransformLayer() {
    _testLayerReuse<TransformLayer>(RenderFittedBox(
      alignment: Alignment.center,
      fit: BoxFit.fill,
      // Inject opacity under the clip to force compositing.
      child: RenderOpacity(
        opacity: 0.5,
        child: RenderSizedBox(const Size(1, 1)),
      ), // size doesn't matter
    ));
  }

  test('RenderFittedBox reuses ClipRectLayer', () {
    _testFittedBoxWithClipRectLayer();
  });

  test('RenderFittedBox reuses TransformLayer', () {
    _testFittedBoxWithTransformLayer();
  });

  test('RenderFittedBox switches between ClipRectLayer and TransformLayer, and reuses them', () {
    _testFittedBoxWithClipRectLayer();

    // clip -> transform
    _testFittedBoxWithTransformLayer();
    // transform -> clip
    _testFittedBoxWithClipRectLayer();
  });
}

class _TestRectClipper extends CustomClipper<Rect> {
  @override
  Rect getClip(Size size) {
    return Rect.zero;
  }

  @override
  Rect getApproximateClipRect(Size size) => getClip(size);

  @override
  bool shouldReclip(_TestRectClipper oldClipper) => true;
}

class _TestRRectClipper extends CustomClipper<RRect> {
  @override
  RRect getClip(Size size) {
    return RRect.zero;
  }

  @override
  Rect getApproximateClipRect(Size size) => getClip(size).outerRect;

  @override
  bool shouldReclip(_TestRRectClipper oldClipper) => true;
484 485 486 487
}

class _FakeTickerProvider implements TickerProvider {
  @override
488
  Ticker createTicker(TickerCallback onTick, [ bool disableAnimations = false ]) {
489
    return _FakeTicker();
490
  }
491
}
492 493 494 495 496 497

class _FakeTicker implements Ticker {
  @override
  bool muted;

  @override
498
  void absorbTicker(Ticker originalTicker) { }
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

  @override
  String get debugLabel => null;

  @override
  bool get isActive => null;

  @override
  bool get isTicking => null;

  @override
  bool get scheduled => null;

  @override
  bool get shouldScheduleTick => null;

  @override
516
  void dispose() { }
517 518

  @override
519
  void scheduleTick({ bool rescheduling = false }) { }
520 521 522 523 524 525 526

  @override
  TickerFuture start() {
    return null;
  }

  @override
527
  void stop({ bool canceled = false }) { }
528 529

  @override
530
  void unscheduleTick() { }
531 532

  @override
533
  String toString({ bool debugIncludeStack = false }) => super.toString();
534 535 536 537 538

  @override
  DiagnosticsNode describeForError(String name) {
    return DiagnosticsProperty<Ticker>(name, this, style: DiagnosticsTreeStyle.errorProperty);
  }
539
}
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568

// Forces two frames and checks that:
// - a layer is created on the first frame
// - the layer is reused on the second frame
void _testLayerReuse<L extends Layer>(RenderObject renderObject) {
  expect(L, isNot(Layer));
  expect(renderObject.debugLayer, null);
  layout(renderObject, phase: EnginePhase.paint, constraints: BoxConstraints.tight(const Size(10, 10)));
  final Layer layer = renderObject.debugLayer;
  expect(layer, isInstanceOf<L>());
  expect(layer, isNotNull);

  // Mark for repaint otherwise pumpFrame is a noop.
  renderObject.markNeedsPaint();
  expect(renderObject.debugNeedsPaint, true);
  pumpFrame(phase: EnginePhase.paint);
  expect(renderObject.debugNeedsPaint, false);
  expect(renderObject.debugLayer, same(layer));
}

class _TestPathClipper extends CustomClipper<Path> {
  @override
  Path getClip(Size size) {
    return Path()
      ..addRect(const Rect.fromLTWH(50.0, 50.0, 100.0, 100.0));
  }
  @override
  bool shouldReclip(_TestPathClipper oldClipper) => false;
}