Struct ScanOutlineOptions 

pub struct ScanOutlineOptions {

    pub cell_size: Option<f64>,
    pub min_cell_size: f64,
    pub max_cell_size: f64,
    pub target_points_per_cell: f64,
    pub max_cells: usize,
    pub min_points_per_cell: u32,
    pub noise_fraction: f64,
    pub max_gap: f64,
    pub open_radius_cells: u32,
    pub min_component_area: f64,
    pub min_hole_area: f64,
    pub simplify_tolerance_cells: f64,
    pub snap: bool,
    pub snap_distance_cells: f64,
    pub min_snap_points: usize,
    pub max_vertex_move_cells: f64,
    pub square: bool,
    pub square_angle_tolerance_deg: f64,
    pub square_offset_tolerance: f64,
}

Every tunable of the tracer, with defaults sized for building scans in metres. Deserialises from camelCase with every field optional (absent means the default) and unknown fields refused, which is the shape the wasm binding accepts.

Fields

cell_size: Option<f64>

Fixed cell edge length (metres). None picks it from the point density between min_cell_size and max_cell_size.

min_cell_size: f64

Finest cell the adaptive choice starts from.

max_cell_size: f64

Coarsest cell the adaptive choice grows to.

target_points_per_cell: f64

The adaptive choice grows the cell until the median occupied cell holds at least this many points.

max_cells: usize

Total cell budget for the padded grid. When the extent needs more, the cell grows to fit and ScanOutlineDiagnostics::cell_cap_hit is set.

min_points_per_cell: u32

A cell needs at least this many points to count as occupied.

noise_fraction: f64

Noise threshold relative to density: a cell is occupied when its count reaches noise_fraction × the median occupied-cell count (and min_points_per_cell).

max_gap: f64

Widest gap (metres) the closing bridges, about one wall thickness. Clamped to MAX_GAP_LIMIT.

open_radius_cells: u32

Radius (cells) of the speckle-removing opening. A connected blob that cannot hold a disk of this radius anywhere is dropped; anything that can is kept whole. 0 disables it.

min_component_area: f64

Solid components smaller than this (m²) are dropped.

min_hole_area: f64

Enclosed empty regions smaller than this (m²) are filled.

simplify_tolerance_cells: f64

Douglas-Peucker tolerance in cells.

snap: bool

Refit simplified edges to the point evidence.

snap_distance_cells: f64

How far (cells) beside an edge points count as its evidence.

min_snap_points: usize

Fewest points an edge needs before it is refitted.

max_vertex_move_cells: f64

A squared vertex may move at most this far (cells); a larger move is undone. It also widens how far a moved edge may sit from the traced boundary (the support check). Snapping bounds its own moves by the closing radius (rebuilt corners reach about 2 × (radius + 3) cells).

square: bool

Square edges against the dominant building direction.

square_angle_tolerance_deg: f64

Edges within this angle (degrees) of the dominant direction, or its perpendicular, are squared.

square_offset_tolerance: f64

An edge whose ends would move at most this far (metres) when squared is squared too, up to four times the angle tolerance.

Implementations

impl ScanOutlineOptions

pub fn min_cells(&self) -> usize

Smallest max_cells these options accept: even at the coarsest cell (one cell over the whole extent, closing radius one cell) the grid keeps its padding on every side, so it needs (2 * pad + 1)² cells.

pub fn validate(&self) -> Result<(), String>

Reject options no run could honour (non-finite, non-positive sizes, inverted ranges). max_gap above MAX_GAP_LIMIT is not an error; it is clamped and reported.

Trait Implementations

impl Clone for ScanOutlineOptions

fn clone(&self) -> ScanOutlineOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScanOutlineOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScanOutlineOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScanOutlineOptions

where ScanOutlineOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScanOutlineOptions

fn eq(&self, other: &ScanOutlineOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScanOutlineOptions