Files
BadNote/lib/editor/engine/stroke_geometry.dart
Akiba So 0feca74278
All checks were successful
CI / Windows build (push) Successful in 14m54s
feat(pen): extensible brush model (4 brushes)
Replace the 2-tool ink system with a data-driven, Krita-style
BrushProfile (lib/editor/engine/brush.dart). Adding a brush is a
const map entry, not render-path branching.

Four presets from the rnote/krita spec:
- fountain pen: quadratic (p^2) pressure, wide dynamic width
- ballpoint:    near-constant width (thinning 0.15)
- highlighter:  flat width, square caps
- pencil:       sqrt(p) pressure, moderate width

Pressure is pre-warped per brush via PressureCurve(gamma) before
perfect_freehand; geometry fields (thinning/streamline/smoothing/
caps) flow through the shared stroke recipe so the PDF overlay and
the note/slide PenCanvas both honor the brush. Brush kind is now
persisted on the stroke model. Picker added to all three toolbars.

Opacity/multiply and pencil grain are carried as data but not yet
composited (TODO brush-opacity / brush-texture); this increment is
width + pressure-curve differentiation. analyze clean, 283 tests.
2026-06-24 11:13:43 +08:00

174 lines
7.1 KiB
Dart

// lib/editor/engine/stroke_geometry.dart
//
// Single source of stroke outline geometry for both screen render and export.
// The recipe is lifted verbatim from the proven live
// `ink_painters.buildStrokePath` (lib/editor/canvas/ink_painters.dart): points
// are scaled from normalized page coords to pixels, perfect_freehand produces
// the outline, and a closed fill Path is built. Keeping ONE implementation here
// kills the hairline-export divergence (R7).
import 'dart:ui';
import 'package:perfect_freehand/perfect_freehand.dart' as pf;
import 'brush.dart';
import 'stroke_model.dart';
/// Canonical default for perfect_freehand's `thinning` (how strongly pressure
/// modulates stroke width). The SINGLE source of truth shared by the on-screen
/// painter ([buildStrokeOutline] here and `ink_painters.buildStrokePath`) and
/// the PDF export path, so screen and export can never diverge. `0.85` =
/// pressure visibly sweeps width; preserves the existing feel + export golden.
/// Overridable per-stroke via [PenConfig.pressureSensitivity].
const double kDefaultPenThinning = 0.85;
/// perfect_freehand input-smoothing parameters, shared (single source of truth)
/// by the on-screen painter and the export path so the two can never diverge
/// (guarded by the screen==export parity test). [kPenStreamline] lowers the
/// per-point lag from freehand's 0.5 default to 0.32: at 0.5 a quick flick lags
/// so far behind the pen that a short fast stroke collapsed toward its start and
/// rendered as a dot ("写字识别成单击") and the pen felt sluggish; 0.32 tracks the
/// real path closely (crisper, lower-latency feel) while still damping digitizer
/// jitter. [kPenSmoothing] keeps freehand's 0.5 corner rounding.
const double kPenStreamline = 0.32;
const double kPenSmoothing = 0.5;
/// THE single perfect_freehand outline recipe — the raw outline points for a
/// stroke. Both the on-screen painter ([buildStrokeOutline] / the live
/// `ink_painters.buildStrokePath`) and the PDF export
/// (`pdf_service._buildFreehandPdfPath`) call THIS, so the `StrokeOptions`
/// (thinning / smoothing / streamline / simulatePressure) live in exactly one
/// place and screen↔export can never drift again (R7 — the hairline-export bug
/// was pdf_service hardcoding its own `thinning: 0.7, streamline: 0.5`).
///
/// Callers supply already-pixel-scaled [pfPoints] (because the two stroke
/// models scale differently) plus the per-stroke flags. Returns the closed
/// outline as `List<Offset>` (perfect_freehand 2.x); empty when freehand
/// produces nothing.
List<Offset> freehandOutlinePoints({
required List<pf.PointVector> pfPoints,
required double size,
required bool isHighlighter,
required bool hasRealPressure,
required bool isComplete,
double thinning = kDefaultPenThinning,
BrushProfile? brush,
}) {
if (pfPoints.isEmpty) return const <Offset>[];
return pf.getStroke(
pfPoints,
options: brush != null
// Brush-driven path: every geometry knob (thinning / streamline /
// smoothing / caps / taper / simulatePressure) comes from the
// BrushProfile so each brush renders distinctly. Pressure was already
// pre-warped by the brush's gamma at CAPTURE (PressureCurve), so the
// pre-warp is baked into pfPoints — perfect_freehand stays linear here.
// simulatePressure is forced true only when the device gave us NO real
// pressure, so velocity-thinning still kicks in for mice/trackpads.
? _optionsFromBrush(brush,
size: size,
isComplete: isComplete,
hasRealPressure: hasRealPressure)
: pf.StrokeOptions(
size: size,
// Highlighter keeps a constant width (no thinning); pen uses the
// configurable [thinning] so Surface-Pen pressure changes width.
thinning: isHighlighter ? 0.0 : thinning,
smoothing: kPenSmoothing,
streamline: kPenStreamline,
// Real stylus pressure -> don't simulate; no pressure -> let
// freehand fake it based on velocity (highlighter never simulates).
// perfect_freehand 2.x honors real pressure when simulatePressure
// is false.
simulatePressure: !hasRealPressure && !isHighlighter,
isComplete: isComplete,
),
);
}
/// Build perfect_freehand [pf.StrokeOptions] from a [BrushProfile] (spec §4).
///
/// TODO(brush-opacity): [BrushProfile.opacity] / [BrushProfile.blendMultiply]
/// are NOT consumed here — geometry only this increment. The caller still paints
/// fill color (with its own alpha) and BlendMode.srcOver; per-stroke opacity /
/// BlendMode.multiply for ballpoint/pencil/highlighter lands later.
pf.StrokeOptions _optionsFromBrush(
BrushProfile brush, {
required double size,
required bool isComplete,
required bool hasRealPressure,
}) {
return pf.StrokeOptions(
size: size,
thinning: brush.pfThinning,
smoothing: brush.pfSmoothing,
streamline: brush.pfStreamline,
// Honor REAL pressure (already gamma-pre-warped at capture). Only fall back
// to velocity simulation when the device reported no usable pressure.
simulatePressure: brush.simulatePressure || !hasRealPressure,
start: pf.StrokeEndOptions.start(
cap: brush.capStart,
taperEnabled: brush.taper,
),
end: pf.StrokeEndOptions.end(
cap: brush.capEnd,
taperEnabled: brush.taper,
),
isComplete: isComplete,
);
}
/// Builds a closed, fillable outline [Path] for one [stroke], scaled into the
/// pixel space of [pageSize] (which maps normalized [0,1] coords to pixels).
///
/// [isComplete] should be false for the in-progress live stroke so freehand
/// tapers the trailing end correctly, and true for committed strokes.
///
/// [thinning] is perfect_freehand's pressure→width response (see
/// [kDefaultPenThinning]); highlighter always forces `0.0` (constant width).
///
/// Returns an empty [Path] when the stroke has no points (or freehand produces
/// no outline).
Path buildStrokeOutline(
EditorStroke stroke,
Size pageSize, {
required bool isComplete,
double thinning = kDefaultPenThinning,
}) {
final path = Path();
if (stroke.points.isEmpty) return path;
final pfPoints = stroke.points
.map(
(p) => pf.PointVector(
p.x * pageSize.width,
p.y * pageSize.height,
p.pressure ?? 0.5,
),
)
.toList();
// Resolve the brush so each stroke renders with its own geometry. The
// pressure pre-warp ([BrushProfile.pressureGamma]) was already applied at
// capture, so it is baked into the points here.
final brush = brushProfileFor(stroke.brush);
final outline = freehandOutlinePoints(
pfPoints: pfPoints,
size: stroke.width * pageSize.width,
isHighlighter: stroke.tool == EditorTool.highlighter,
hasRealPressure: stroke.points.any((p) => p.pressure != null),
isComplete: isComplete,
thinning: thinning,
brush: brush,
);
if (outline.isEmpty) return path;
path.moveTo(outline.first.dx, outline.first.dy);
for (var i = 1; i < outline.length; i++) {
path.lineTo(outline[i].dx, outline[i].dy);
}
path.close();
return path;
}