Interface BindEditSketchSnappingOptions<T>

interface BindEditSketchSnappingOptions<T> {
    config?: Partial<SnappingConfig>;
    index: SnapIndex;
    indicator?: boolean | EditSketchSnapIndicatorOptions;
    model?: EditSketchWorkflowModel<T>;
    pointerEvent?: string;
    onSnap?(resolution: SnapResolution): void;
    onUnsnap?(previous: SnapCandidate): void;
}

Type Parameters

  • T = Record<string, unknown>

Hierarchy (view full)

Properties

config? index indicator? model? pointerEvent?

Methods

onSnap? onUnsnap?

Properties

Optionalconfig

config?: Partial<SnappingConfig>

Snapping configuration when no model is bound (or overrides for one-off use).

index

index: SnapIndex

Snap index over the loaded snap-source features.

Optionalindicator

indicator?: boolean | EditSketchSnapIndicatorOptions

Default snap indicator; false disables it.

Optionalmodel

model?: EditSketchWorkflowModel<T>

Sketch workflow whose snapping config drives resolution and that receives snapped geometry via EditSketchSnappingHandle.applySketchGeometry. When omitted, pass config and consume snaps through events / current.

OptionalpointerEvent

pointerEvent?: string

Pointer event name to listen for.

Default

"mousemove"

Methods

OptionalonSnap

OptionalonUnsnap

Settings

Member Visibility

On This Page

Properties
Methods