Class SnappingHandler

constructor

• new SnappingHandler(options: SnappableOptions): SnappingHandler

  Parameters

  • options: SnappableOptions

  Returns SnappingHandler

gutterSize

snappableDebugDraw

stickyZoneSize

isActive

• get isActive(): boolean

  Returns true if the snapping handler is currently active, meaning it is ready to snap to a position.

  Returns boolean

isEnabled

• get isEnabled(): boolean

  Returns true if the snapping handler is enabled and ready to snap.

  Returns boolean

isScaling

• get isScaling(): boolean

  Returns boolean

isTweening

• get isTweening(): boolean

  Returns true if the snapping handler is currently tweening to a new position or rotation.

  Returns boolean

ReadonlyabortSnapping

• abortSnapping(): void

  Returns void

destroy

• destroy(): void

  Returns void

enableItemSnapping

• enableItemSnapping(enable: boolean): void

  Parameters

  • enable: boolean

  Returns void

enableWorldSnapping

• enableWorldSnapping(enable: boolean): void

  Parameters

  • enable: boolean

  Returns void

setScaling

• setScaling(val: boolean): void

  Parameters

  • val: boolean

  Returns void

tryToSnap

• tryToSnap(): void

  Returns void

update

• update(): void

  Returns void