SnapOptions

interface SnapOptions(source)

Properties

Link copied to clipboard
abstract val camera: Camera

The camera defining the current view. Must be viewing in SceneMode.SCENE3D.

Link copied to clipboard
abstract val canvasHeight: Double

The canvas height in CSS pixels.

Link copied to clipboard
abstract val canvasWidth: Double

The canvas width in CSS pixels.

Link copied to clipboard
abstract val closePoint: Cartesian3?

A reference point near the target geometry that seeds the snap search. Default value - options.testPoint

Link copied to clipboard
abstract val elementId: String

The element id to snap to, as a hex string, e.g. "0x30000000df2".

Link copied to clipboard
abstract val snapAperture: Double?

The snap tolerance in CSS pixels of the world-to-view output space. Default value - IonSnapService.DEFAULT_SNAP_APERTURE

Link copied to clipboard
abstract val snapMode: IonSnapMode?

The type of snap to perform. Default value - IonSnapMode.NEAREST

Link copied to clipboard
abstract val testPoint: Cartesian3

The point to snap from, typically the picked cursor position.