GameCameraControls class

A widget that wraps child with scroll-wheel and on-screen +/− zoom controls that operate a Camera without rebuilding the child.

GameCameraControls(
  camera: engine.rendering.camera,
  child: GameWidget(engine: engine),
)
Inheritance

Constructors

GameCameraControls({Key? key, required Camera camera, required Widget child, double zoomStep = 0.1, double scrollZoomFactor = 0.1, bool showZoomLevel = false, bool enablePan = true, bool enablePinch = true})
Controls for camera over child: buttons and scroll steps of 0.1, mouse-drag pan and pinch zoom on, the zoom readout off, unless told otherwise. Every zoom is clamped to the camera's minZoom..maxZoom.
const

Properties

camera → Camera
The Camera whose Camera.zoom is controlled.
final
child → Widget
Child widget — never rebuilt when zoom changes.
final
enablePan → bool
Enable mouse-drag to pan the camera (desktop).
final
enablePinch → bool
Enable two-finger pinch to zoom (touch).
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollZoomFactor → double
Zoom added (scrolling up) or taken away (scrolling down) per scroll event, whatever the event's size (mouse-wheel / trackpad).
final
showZoomLevel → bool
When true, displays the current zoom level between the +/− buttons.
final
zoomStep → double
Zoom delta applied each time the +/− buttons are tapped.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<GameCameraControls>
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, int wrapWidth = 65}) → 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