SceneBuilderWidget class

A widget that builds a scene using the GraphX engine.

This widget is responsible for rendering the scene using the provided builder function which must return a SceneController.

SceneBuilderWidget also handles the input events from mouse and keyboard and sends them to the SceneController as events.

If autoSize is true, the widget will wrap the CustomPaint in a SizedBox.expand, so it takes the available space in the parent. Warning: this will not work inside flex widgets.

If the child parameter is non-null, it will be drawn above the scene.

Inheritance

Constructors

SceneBuilderWidget({Key? key, required SceneController builder(), Widget? child, bool painterIsComplex = true, bool mouseOpaque = true, HitTestBehavior pointerBehaviour = HitTestBehavior.translucent, bool autoSize = false})
Creates a new instance of SceneBuilderWidget.
const

Properties

autoSize → bool
Wraps the CustomPaint in an SizedBox.expand() so it takes the available space in the parent. Warning: will not work with inside Flex Widgets.
final
builder → SceneController Function()
The function that creates a SceneController.
final
child → Widget?
The child widget to draw above the scene.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mouseOpaque → bool
Absorbs mouse events blocking the child. See MouseRegion.opaque
final
painterIsComplex → bool
Rendering caching flag. See CustomPaint.willChange
final
pointerBehaviour → HitTestBehavior
See Listener.behavior defaults to capture translucent("empty") areas.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → SceneBuilderWidgetState
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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