DesktopInputRegion class

Widget wrapper that forwards mouse and keyboard input to a DesktopInputDriver. Place it around the VR viewport on desktop targets.

  • Mouse-look: hold the primary button and drag.
  • Click-to-pick: onPick fires with the raycast hit (if any).
  • Keyboard: WASD + Q/E vertical + Shift sprint (auto-focused).
Inheritance

Constructors

DesktopInputRegion({Key? key, required DesktopInputDriver driver, required Widget child, void onPick(RaycastHit? hit)?, void onHoverRay(Ray ray, Offset position)?, Node? pickRoot})
const

Properties

child Widget
final
driver DesktopInputDriver
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onHoverRay → void Function(Ray ray, Offset position)?
Called continuously while the pointer moves (for hover effects).
final
onPick → void Function(RaycastHit? hit)?
Called when the user clicks; receives the nearest hit (or null).
final
pickRoot Node?
Scene root used for onPick raycasts.
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() State<DesktopInputRegion>
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