Skip to content

API reference / edit-controls / EditControlsEngine

Interface: EditControlsEngine ​

Defined in: tacticalgraphics/ui/editControls.ts:44

What the controls need from an engine. Every engine returned by createTacticalGraphics has it.

Methods ​

beginGesture() ​

ts
beginGesture(kind, event): boolean;

Defined in: tacticalgraphics/ui/editControls.ts:47

Parameters ​

kind ​

GestureKind

event ​

PointerEvent

Returns ​

boolean


getInteractionMode()? ​

ts
optional getInteractionMode(): EditMode;

Defined in: tacticalgraphics/ui/editControls.ts:48

Returns ​

EditMode


selectionBox() ​

ts
selectionBox(): 
  | SelectionBox
  | undefined;

Defined in: tacticalgraphics/ui/editControls.ts:45

Returns ​

| SelectionBox | undefined


selectionGestures() ​

ts
selectionGestures(): 
  | AllowedGestures
  | null;

Defined in: tacticalgraphics/ui/editControls.ts:46

Returns ​

| AllowedGestures | null

Released under the MIT License.