SmartfaceTransparentEllipseOverlay class

Displays a transparent ellipse overlay used to guide face positioning during enrollment.

The border color changes automatically as the native layer reports whether the detected face is inside the expected capture region.

Constructors

SmartfaceTransparentEllipseOverlay({Key? key, Color overlayColor = const Color.fromRGBO(0, 0, 0, 0.6), Color borderColorActive = const Color(0xFF00FF00), Color borderColorDefault = const Color(0xFF606F7B), double borderWidth = 4.0, double ellipseWidthRatio = 0.65, double ellipseHeightRatio = 0.45, double? ellipseTopMarginRatio, int defaultAbsHeight = 250, double logoDistance = 64.0, void onRectInsideEllipseChanged(bool isInside)?})
Creates a SmartFace overlay with configurable ellipse geometry and styling.

Properties

borderColorActive → Color
The border color when face is inside the ellipse
final
borderColorDefault → Color
The border color when face is outside the ellipse
final
borderWidth → double
The width of the ellipse border
final
Optional logo or image to display below the ellipse
final
creationParams → Map<String, dynamic>
Returns the creation parameters for the native platform view
no setter
defaultAbsHeight → int
The default absolute height for ellipse validation
final
effectiveTopMarginRatio → double
Calculates the effective top margin ratio for centering
no setter
ellipseHeightRatio → double
The height ratio of the ellipse relative to screen height (0.0 to 1.0)
final
ellipseTopMarginRatio → double?
The top margin ratio of the ellipse relative to screen height (0.0 to 1.0) If null, the ellipse will be automatically centered vertically
final
ellipseWidthRatio → double
The width ratio of the ellipse relative to screen width (0.0 to 1.0)
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
logoDistance → double
The distance between the ellipse and the bottom logo
final
onRectInsideEllipseChanged → void Function(bool isInside)?
Optional callback that is triggered when face position changes
final
overlayColor → Color
The background color of the overlay (outside the ellipse)
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<SmartfaceTransparentEllipseOverlay>
Creates the mutable state for this widget at a given location in the tree.
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
updateFromPlatform(bool isInside) → void
Updates the inside/outside state from platform events

Operators

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