Class TranslationSnapping

An abstract interface for all interactions

Hierarchy (view full)

AbstractInteraction
- TranslationSnapping

Index

Accessors

Constructors

Methods

destroy modifierChanged pipe setActive setModification setPointer

Properties

active id modificationKey pointerKey

Accessors

snapTo

get snapTo(): (
    | "orthogonal"
    | "parallel"
    | "vertex"
    | "edge")[]
Returns (
    | "orthogonal"
    | "parallel"
    | "vertex"
    | "edge")[]
- Defined in src/util/editor/interactions/translationSnapping.ts:91
set snapTo(snapTo): void
Parameters
- snapTo: (
      | "orthogonal"
      | "parallel"
      | "vertex"
      | "edge")[]
Returns void
- Defined in src/util/editor/interactions/translationSnapping.ts:112

Constructors

constructor

new TranslationSnapping(scratchLayer, geometry, snapTo?): TranslationSnapping
Parameters
- scratchLayer: VectorLayer
- geometry: Polygon | LineString
- snapTo: (
      | "orthogonal"
      | "parallel"
      | "vertex"
      | "edge")[] = ...
Returns TranslationSnapping
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/translationSnapping.ts:68

Methods

destroy

destroy(): void
destroys the implementation, removing any created resources

Returns void
Overrides AbstractInteraction.destroy
- Defined in src/util/editor/interactions/translationSnapping.ts:298

modifierChanged

modifierChanged(_modifier): void
Called when the modifier keys have changed.
Parameters
- _modifier: ModificationKeyType
Returns void
Inherited from AbstractInteraction.modifierChanged
- Defined in src/interaction/abstractInteraction.ts:147

pipe

pipe(event): Promise<SnappingInteractionEvent>
Main function, called when an event is raised for this interaction
Parameters
- event: SnappingInteractionEvent
Returns Promise<SnappingInteractionEvent>
Overrides AbstractInteraction.pipe
- Defined in src/util/editor/interactions/translationSnapping.ts:139

setActive

setActive(active?): void
Sets the interaction active. Use boolean (true|false) to toggle default behavior. Pass it a bitmask of EventType to change the active state. Call without arguments to reset the default active, modification key and pointer Key behavior
Parameters
- Optionalactive: number | boolean
Returns void
Inherited from AbstractInteraction.setActive
- Defined in src/interaction/abstractInteraction.ts:156

setModification

setModification(mod?): void
Sets the modification key to listen to or the default modification key if none is provided.
Parameters
- Optionalmod: ModificationKeyType
Returns void
Inherited from AbstractInteraction.setModification
- Defined in src/interaction/abstractInteraction.ts:171

setPointer

setPointer(pointer?): void
Sets the pointer key for this interaction or the default pointer if none is provided.
Parameters
- Optionalpointer: PointerKeyType
Returns void
Inherited from AbstractInteraction.setPointer
- Defined in src/interaction/abstractInteraction.ts:182

Properties

active

active: number

The current active bitmask for EventType

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType