gridpaper.dart 2.47 KB
Newer Older
1 2 3 4 5 6 7 8 9
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/rendering.dart';

import 'basic.dart';
import 'framework.dart';

10 11 12
class _GridPaperPainter extends CustomPainter {
  const _GridPaperPainter({
    this.color,
Ian Hickson's avatar
Ian Hickson committed
13 14 15
    this.interval,
    this.divisions,
    this.subDivisions
16 17 18 19
  });

  final Color color;
  final double interval;
Ian Hickson's avatar
Ian Hickson committed
20 21
  final int divisions;
  final int subDivisions;
22 23 24 25

  void paint(Canvas canvas, Size size) {
    Paint linePaint = new Paint()
      ..color = color;
Ian Hickson's avatar
Ian Hickson committed
26 27 28
    double allDivisions = (divisions * subDivisions).toDouble();
    for (double x = 0.0; x <= size.width; x += interval / allDivisions) {
      linePaint.strokeWidth = (x % interval == 0.0) ? 1.0 : (x % (interval / subDivisions) == 0.0) ? 0.5: 0.25;
29 30
      canvas.drawLine(new Point(x, 0.0), new Point(x, size.height), linePaint);
    }
Ian Hickson's avatar
Ian Hickson committed
31 32
    for (double y = 0.0; y <= size.height; y += interval / allDivisions) {
      linePaint.strokeWidth = (y % interval == 0.0) ? 1.0 : (y % (interval / subDivisions) == 0.0) ? 0.5: 0.25;
33 34 35 36 37 38
      canvas.drawLine(new Point(0.0, y), new Point(size.width, y), linePaint);
    }
  }

  bool shouldRepaint(_GridPaperPainter oldPainter) {
    return oldPainter.color != color
Ian Hickson's avatar
Ian Hickson committed
39 40 41
        || oldPainter.interval != interval
        || oldPainter.divisions != divisions
        || oldPainter.subDivisions != subDivisions;
42
  }
Ian Hickson's avatar
Ian Hickson committed
43 44

  bool hitTest(Point position) => false;
45 46
}

47 48
/// Draws a rectalinear grid of 1px width lines at the specified color and interval.
/// Useful with a Stack for visualizing your layout along a grid.
49 50 51
class GridPaper extends StatelessComponent {
  GridPaper({
    Key key,
Ian Hickson's avatar
Ian Hickson committed
52 53 54 55 56
    this.color: const Color(0x7FC3E8F3),
    this.interval: 100.0,
    this.divisions: 2,
    this.subDivisions: 5,
    this.child
57 58
  }) : super(key: key);

59
  /// The color to draw the lines in the grid.
60
  final Color color;
61 62

  /// The distance between the primary lines in the grid, in logical pixels.
63
  final double interval;
64 65

  /// The number of major divisions within each primary grid cell.
Ian Hickson's avatar
Ian Hickson committed
66
  final int divisions;
67 68

  /// The number of minor divisions within each major division.
Ian Hickson's avatar
Ian Hickson committed
69
  final int subDivisions;
70

Ian Hickson's avatar
Ian Hickson committed
71
  final Widget child;
72 73

  Widget build(BuildContext context) {
Ian Hickson's avatar
Ian Hickson committed
74 75 76 77 78 79 80 81
    return new CustomPaint(
      foregroundPainter: new _GridPaperPainter(
        color: color,
        interval: interval,
        divisions: divisions,
        subDivisions: subDivisions
      ),
      child: child
82 83 84
    );
  }
}