ScanConfiguration class

Configuration options for room scanning sessions.

This class allows you to customize various aspects of the scanning process including quality settings, timeout values, and feature detection preferences.

iOS version support:

  • iOS 16: Only quality affects behavior (fast/balanced/high). All other fields are reserved for iOS 17+ and currently have no effect on the scan.
  • iOS 17+: StructureBuilder and export options become available (not yet exposed).

Constructors

ScanConfiguration({ScanQuality quality = ScanQuality.balanced, int? timeoutSeconds, bool enableRealtimeUpdates = true, bool detectFurniture = true, bool detectDoors = true, bool detectWindows = true, double minimumConfidence = 0.5, bool enableAdvancedSurfaceDetection = false})
Creates a scan configuration with the specified settings.
const
ScanConfiguration.accurate({int? timeoutSeconds = 300, bool enableRealtimeUpdates = true, bool detectFurniture = true, bool detectDoors = true, bool detectWindows = true, double minimumConfidence = 0.8, bool enableAdvancedSurfaceDetection = true})
Creates a configuration optimized for accuracy.
const
ScanConfiguration.fast({int? timeoutSeconds = 60, bool enableRealtimeUpdates = false, bool detectFurniture = false, bool detectDoors = true, bool detectWindows = true, double minimumConfidence = 0.3, bool enableAdvancedSurfaceDetection = false})
Creates a configuration optimized for speed.
const
ScanConfiguration.fromMap(Map<String, dynamic> map)
Creates a configuration from a map.
factory
ScanConfiguration.minimal({int? timeoutSeconds = 120, bool enableRealtimeUpdates = false, bool detectFurniture = false, bool detectDoors = false, bool detectWindows = false, double minimumConfidence = 0.7, bool enableAdvancedSurfaceDetection = false})
Creates a configuration with minimal features for basic room outline.
const

Properties

detectDoors → bool
Whether to detect and include doors in the scan.
final
detectFurniture → bool
Whether to detect and include furniture objects in the scan.
final
detectWindows → bool
Whether to detect and include windows in the scan.
final
enableAdvancedSurfaceDetection → bool
Whether to enable advanced surface detection.
final
enableRealtimeUpdates → bool
Whether to enable real-time updates during scanning.
final
hashCode → int
The hash code for this object.
no setteroverride
minimumConfidence → double
Minimum confidence level for detected objects to be included.
final
quality → ScanQuality
The quality level for room scanning.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeoutSeconds → int?
Maximum duration for a scanning session in seconds. If null, no timeout is applied.
final

Methods

copyWith({ScanQuality? quality, int? timeoutSeconds, bool? enableRealtimeUpdates, bool? detectFurniture, bool? detectDoors, bool? detectWindows, double? minimumConfidence, bool? enableAdvancedSurfaceDetection}) → ScanConfiguration
Creates a copy of this configuration with modified values.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
Converts the configuration to a map for native platform communication.
toString() → String
A string representation of this object.
override

Operators

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