Class TurboEventManager<ToolType>

TurboEventManager

Description

Class that manages default mouse, trackpad, and touch events, and accordingly fires custom events for easier management of input.

Type Parameters

ToolType extends string = string

Hierarchy (View Summary)

TurboBaseElement
- TurboEventManager

Index

Constructors

constructor

new TurboEventManager<ToolType extends string = string>(): TurboEventManager<
ToolType,
>
Type Parameters
- ToolType extends string = string
Returns TurboEventManager<ToolType>
Overrides TurboBaseElement.constructor
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:113

Properties

`Protected` `Static`managers

managers: TurboEventManager<string>[] = []

`Readonly`properties

properties: TurboEventManagerProperties

`Static`defaultProperties

defaultProperties: TurboEventManagerProperties = ...

Description

Default properties assigned to a new instance.

`Protected`keyOperator

keyOperator: TurboEventManagerKeyOperator

`Protected`wheelOperator

wheelOperator: TurboEventManagerWheelOperator

`Protected`pointerOperator

pointerOperator: TurboEventManagerPointerOperator

`Protected`dispatchOperator

dispatchOperator: TurboEventManagerDispatchOperator

inputDevice

inputDevice: InputDevice

Description

The currently identified input device. It is not 100% accurate, especially when differentiating between mouse and trackpad.

onInputDeviceChange

onInputDeviceChange: Delegate<(device: InputDevice) => void>

currentClick

currentClick: ClickMode

currentKeys

currentKeys: string[]

onToolChange

onToolChange: Delegate<(oldTool: Node, newTool: Node, type: ClickMode) => void>

Description

Delegate fired when a tool is changed on a certain click button/mode

authorizeEventScaling

authorizeEventScaling: boolean | (() => boolean)

scaleEventPosition

scaleEventPosition: (position: Point) => Point

moveThreshold

moveThreshold: number

longPressDuration

longPressDuration: number

selected

selected: boolean

Description

Whether the element is selected or not.

`Readonly`initialized

initialized: boolean

Description

Whether the element was initialized already or not.

defaultFeedforwardProperties

defaultFeedforwardProperties: TurboElementProperties

Accessors

`Static`instance

get instance(): TurboEventManager
Returns TurboEventManager
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:52

`Static`allManagers

get allManagers(): TurboEventManager<string>[]
Returns TurboEventManager<string>[]
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:56
set allManagers(managers: TurboEventManager<string>[]): void
Parameters
- managers: TurboEventManager<string>[]
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:60

model

get model(): TurboEventManagerModel
Returns TurboEventManagerModel
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:64

keyEventsEnabled

set keyEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:129

wheelEventsEnabled

set wheelEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:140

moveEventsEnabled

set moveEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:146

mouseEventsEnabled

set mouseEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:150

touchEventsEnabled

set touchEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:166

clickEventsEnabled

set clickEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:180

dragEventsEnabled

set dragEventsEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:184

enabled

get enabled(): boolean
Returns boolean
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:215
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:219

preventDefaultWheel

get preventDefaultWheel(): boolean
Returns boolean
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:223
set preventDefaultWheel(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:227

preventDefaultMouse

get preventDefaultMouse(): boolean
Returns boolean
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:231
set preventDefaultMouse(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:235

preventDefaultTouch

get preventDefaultTouch(): boolean
Returns boolean
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:239
set preventDefaultTouch(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:243

toolsArray

get toolsArray(): Node[]
Returns Node[]
Description
All attached tools in an array
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:259

Methods

initialize

initialize(): void
Function
initialize

Returns void
Description
Initializes the element. It sets up the UI by calling the methods setupUIElements, setupUILayout, setupUIListeners, and setupChangedCallbacks (in this order, if they are defined). This function is called automatically in .setProperties() and when instantiating an element via element(). It is called only once per element (as it checks with the reflected initialized flag).
Overrides TurboBaseElement.initialize
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:118

lock

lock(origin: Node, value: TurboEventManagerStateProperties): void
Parameters
- origin: Node
  The element that initiated the lock state.
- value: TurboEventManagerStateProperties
  The state properties to set.
Returns void
Description
Sets the lock state for the event manager.
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:202

unlock

unlock(): void
Returns void
Description
Resets the lock state to the default values.
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:211

getCurrentTool

getCurrentTool(mode?: ClickMode): Node
Parameters
- mode: ClickMode = ...
Returns Node
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:265

getCurrentTools

getCurrentTools(mode?: ClickMode): Node[]
Parameters
- mode: ClickMode = ...
Returns Node[]
Description
Returns the instances of the tool currently held by the provided click mode
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:273

getCurrentToolName

getCurrentToolName(mode?: ClickMode): ToolType
Parameters
- mode: ClickMode = ...
Returns ToolType
Description
Returns the name of the tool currently held by the provided click mode
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:281

getToolName

getToolName(tool: Node): ToolType
Parameters
- tool: Node
Returns ToolType
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:285

getSimilarTools

getSimilarTools(tool: Node): Node[]
Parameters
- tool: Node
Returns Node[]
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:292

getToolsByName

getToolsByName(name: ToolType): Node[]
Parameters
- name: ToolType
Returns Node[]
Description
Returns the tool with the given name (or undefined)
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:303

getToolByName

getToolByName(name: ToolType, predicate?: (tool: Node) => boolean): Node
Parameters
- name: ToolType
- Optionalpredicate: (tool: Node) => boolean
Returns Node
Description
Returns the first tool with the given name (or undefined)
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:313

getToolsByKey

getToolsByKey(key: string): Node[]
Parameters
- key: string
Returns Node[]
Description
Returns the tools associated with the given key
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:322

getToolByKey

getToolByKey(key: string, predicate?: (tool: Element) => boolean): Node
Parameters
- key: string
- Optionalpredicate: (tool: Element) => boolean
Returns Node
Description
Returns the first tool associated with the given key
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:333

addTool

addTool(toolName: ToolType, tool: Node, key?: string): void
Parameters
- toolName: ToolType
- tool: Node
- Optionalkey: string
Returns void
Description
Adds a tool to the tools map, identified by its name. Optionally, provide a key to bind the tool to.
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:344

setTool

setTool(tool: Node, type: ClickMode, options?: SetToolOptions): void
Parameters
- tool: Node
- type: ClickMode
- options: SetToolOptions = {}
Returns void
Description
Sets the provided tool as a current tool associated with the provided type
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:357

setToolByKey

setToolByKey(key: string): boolean
Parameters
- key: string
Returns boolean
Description
Sets tool associated with the provided key as the current tool for the key mode
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:392

setupCustomDispatcher

setupCustomDispatcher(type: string): void
Parameters
- type: string
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:407

`Protected`applyAndHookEvents

applyAndHookEvents(
    turboEventNames: Record<string, string>,
    defaultEventNames: Record<string, string>,
    applyTurboEvents: boolean,
): void
Parameters
- turboEventNames: Record<string, string>
- defaultEventNames: Record<string, string>
- applyTurboEvents: boolean
Returns void
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:411

destroy

destroy(): TurboEventManager<ToolType>
Function
destroy

Returns TurboEventManager<ToolType>
Itself, allowing for method chaining.

Description
Destroys the node by removing it from the document and removing all its bound listeners.
Overrides TurboBaseElement.destroy
- Defined in src/eventHandling/turboEventManager/turboEventManager.ts:420

feedforward

feedforward(properties?: FeedforwardProperties): this
Parameters
- Optionalproperties: FeedforwardProperties
Returns this
Inherited from TurboBaseElement.feedforward
- Defined in src/turboElement/setup/default/default.types.ts:40

clone

clone(options?: CloneElementOptions): this
Parameters
- Optionaloptions: CloneElementOptions
Returns this
Inherited from TurboBaseElement.clone
- Defined in src/turboElement/setup/default/default.types.ts:42

`Static`create

create<Type extends new (...args: any[]) => TurboBaseElement>(
this: Type,
properties?: InstanceType<Type>["properties"],
): InstanceType<Type>
Type Parameters
- Type extends new (...args: any[]) => TurboBaseElement
Parameters
- this: Type
- properties: InstanceType<Type>["properties"] = {}
Returns InstanceType<Type>
Inherited from TurboBaseElement.create
- Defined in src/turboElement/turboBaseElement/turboBaseElement.ts:23

`Protected` `Static`customCreate

customCreate(properties: object): object
Parameters
- properties: object
Returns object
Inherited from TurboBaseElement.customCreate
- Defined in src/turboElement/turboBaseElement/turboBaseElement.ts:28

Class TurboEventManager<ToolType>

Description

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns TurboEventManager<ToolType>

Properties

Protected Staticmanagers

Readonlyproperties

StaticdefaultProperties

Description

ProtectedkeyOperator

ProtectedwheelOperator

ProtectedpointerOperator

ProtecteddispatchOperator

inputDevice

Description

onInputDeviceChange

currentClick

currentKeys

onToolChange

Description

authorizeEventScaling

scaleEventPosition

moveThreshold

longPressDuration

selected

Description

Readonlyinitialized

Description

defaultFeedforwardProperties

Accessors

Staticinstance

Returns TurboEventManager

StaticallManagers

Returns TurboEventManager<string>[]

Parameters

Returns void

model

Returns TurboEventManagerModel

keyEventsEnabled

Parameters

Returns void

wheelEventsEnabled

Parameters

Returns void

moveEventsEnabled

Parameters

Returns void

mouseEventsEnabled

Parameters

Returns void

touchEventsEnabled

Parameters

Returns void

clickEventsEnabled

Parameters

Returns void

dragEventsEnabled

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

preventDefaultWheel

Returns boolean

Parameters

Returns void

preventDefaultMouse

Returns boolean

Parameters

Returns void

`Protected` `Static`managers

`Readonly`properties

`Static`defaultProperties

`Protected`keyOperator

`Protected`wheelOperator

`Protected`pointerOperator

`Protected`dispatchOperator

`Readonly`initialized

`Static`instance

`Static`allManagers

`Protected`applyAndHookEvents