FaceBoundingBoxOverlay class

A debug/enrollment overlay that draws bounding boxes around detected faces.

Place this widget on top of a camera preview using a Stack:

Stack(
  children: [
    CameraPreview(controller),
    FaceBoundingBoxOverlay(
      faces: detectedFaces,
      imageSize: Size(480, 640),
      widgetSize: Size(screenWidth, screenHeight),
    ),
  ],
);
Inheritance

Constructors

FaceBoundingBoxOverlay({Key? key, required List<Face> faces, required Size imageSize, required Size widgetSize, Color boxColor = Colors.green, double strokeWidth = 2.0, bool showLabels = false, bool mirror = true})
const

Properties

boxColor → Color
Color of the bounding box rectangles. Defaults to green.
final
faces → List<Face>
List of detected faces to draw bounding boxes for.
final
hashCode → int
The hash code for this object.
no setterinherited
imageSize → Size
The size of the camera image in pixels.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mirror → bool
Whether to mirror the coordinates horizontally. Set to true for the front camera (default), false for the rear camera.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showLabels → bool
Whether to show tracking ID labels above each bounding box. Defaults to false.
final
strokeWidth → double
Stroke width of the bounding box lines. Defaults to 2.0.
final
widgetSize → Size
The size of this widget (the display area).
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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