ScenePainter class

A CustomPainter that renders a Scene to a Flutter Canvas.

The painter expects node geometry to be stored in local coordinates around (0,0) and uses SceneNode.transform to map into scene/world coordinates. It also applies Scene.camera offset to render into view coordinates.

Inheritance

Constructors

ScenePainter({required SceneController controller, required ImageResolver imageResolver, SceneStaticLayerCache? staticLayerCache, SceneTextLayoutCache? textLayoutCache, SceneStrokePathCache? strokePathCache, Color selectionColor = const Color(0xFF1565C0), double selectionStrokeWidth = 1, double gridStrokeWidth = 1})

Properties

controller SceneController
final
gridStrokeWidth double
final
hashCode int
The hash code for this object.
no setterinherited
imageResolver ImageResolver
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectionColor Color
final
selectionStrokeWidth double
final
semanticsBuilder SemanticsBuilderCallback?
Returns a function that builds semantic information for the picture drawn by this painter.
no setterinherited
staticLayerCache SceneStaticLayerCache?
final
strokePathCache SceneStrokePathCache?
final
textLayoutCache SceneTextLayoutCache?
final

Methods

addListener(VoidCallback listener) → void
Register a closure to be notified when it is time to repaint.
inherited
hitTest(Offset position) bool?
Called whenever a hit test is being performed on an object that is using this custom paint delegate.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paint(Canvas canvas, Size size) → void
Called whenever the object needs to paint. The given Canvas has its coordinate space configured such that the origin is at the top left of the box. The area of the box is the size of the size argument.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies when it is time to repaint.
inherited
shouldRebuildSemantics(covariant CustomPainter oldDelegate) bool
Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object, or any time that a new CustomPaint object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former).
inherited
shouldRepaint(covariant ScenePainter oldDelegate) bool
Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object, or any time that a new CustomPaint object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former).
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited