Class CreateBBoxInteraction

This interaction allows you to create a bounding box geometry.

Hierarchy (view full)

AbstractInteraction
- CreateBBoxInteraction

Implements

CreateInteraction<Polygon>

Index

Constructors

Methods

destroy finish modifierChanged pipe setActive setModification setPointer

Properties

active created finished id modificationKey pointerKey

Constructors

constructor

new CreateBBoxInteraction(): CreateBBoxInteraction
Returns CreateBBoxInteraction
Overrides AbstractInteraction.constructor
- Defined in src/util/editor/interactions/createBBoxInteraction.ts:42

Methods

destroy

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

Returns void
Implementation of CreateInteraction.destroy
Overrides AbstractInteraction.destroy
- Defined in src/util/editor/interactions/createBBoxInteraction.ts:136

finish

finish(): void
Finish the current creation. Calls finish and sets the interaction to be inactive

Returns void
Implementation of CreateInteraction.finish
- Defined in src/util/editor/interactions/createBBoxInteraction.ts:128

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<EventAfterEventHandler>
Main function, called when an event is raised for this interaction
Parameters
- event: EventAfterEventHandler
Returns Promise<EventAfterEventHandler>
Overrides AbstractInteraction.pipe
- Defined in src/util/editor/interactions/createBBoxInteraction.ts:91

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

created

created: VcsEvent<Polygon> = ...

finished

finished: VcsEvent<null | Polygon> = ...

id

id: string

A unique identifier for this interaction

modificationKey

modificationKey: ModificationKeyType

The current active ModificationKeyType

pointerKey

pointerKey: PointerKeyType

The currently active PointerKeyType