Class: InteractionBase โ
Hierarchy โ
InteractionBase
โณ
Interaction
Implements โ
Table of contents โ
Constructors โ
Properties โ
- target
- canvas
- selector
- running
- config
- cursor
- bottomList
- shrinkCanvasBounds
- downData
- hoverData
- focusData
- downTime
- overPath
- enterPath
- waitMenuTap
- waitRightTap
- waitTap
- longPressTimer
- longPressed
- tapCount
- tapTimer
- dragger
- transformer
- __eventIds
- defaultPath
- downKeyMap
Accessors โ
- dragging
- transforming
- moveMode
- canHover
- isDragEmpty
- isMobileDragEmpty
- isHoldMiddleKey
- isHoldRightKey
- isHoldSpaceKey
- m
- p
- hitRadius
Methods โ
- start
- stop
- receive
- pointerDown
- pointerMove
- pointerMoveReal
- pointerUp
- pointerCancel
- menu
- menuTap
- createTransformer
- move
- zoom
- rotate
- transformEnd
- wheel
- multiTouch
- keyDown
- keyUp
- pointerHover
- pointerOverOrOut
- pointerEnterOrLeave
- touchLeave
- tap
- findPath
- isRootPath
- isTreePath
- checkPath
- canMove
- isDrag
- isPress
- isHover
- isFocus
- cancelHover
- updateDownData
- updateHoverData
- updateCursor
- setCursor
- getLocal
- emitTap
- emitDoubleTap
- pointerWaitCancel
- tapWait
- tapWaitCancel
- longPressWait
- longTap
- longPressWaitCancel
- __onResize
- __listenEvents
- __removeListenEvents
- emit
- destroy
Constructors โ
constructor โ
โข new InteractionBase(target
, canvas
, selector
, userConfig?
)
Parameters โ
Name | Type |
---|---|
target | ILeaf |
canvas | IInteractionCanvas |
selector | ISelector |
userConfig? | IInteractionConfig |
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:70
Properties โ
target โ
โข target: ILeaf
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:16
canvas โ
โข canvas: IInteractionCanvas
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:17
selector โ
โข selector: ISelector
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:18
running โ
โข running: boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:20
config โ
โข config: IInteractionConfig
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:34
cursor โ
โข cursor: ICursorType
| ICursorType
[]
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:38
bottomList โ
โข Optional
bottomList: IPickBottom
[]
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:41
shrinkCanvasBounds โ
โข shrinkCanvasBounds: IBounds
Implementation of โ
IInteraction.shrinkCanvasBounds
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:43
downData โ
โข downData: IPointerEvent
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:45
hoverData โ
โข hoverData: IPointerEvent
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:46
focusData โ
โข focusData: ILeaf
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:47
downTime โ
โข downTime: number
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:49
overPath โ
โข Protected
overPath: LeafList
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:51
enterPath โ
โข Protected
enterPath: LeafList
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:52
waitMenuTap โ
โข Protected
waitMenuTap: boolean
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:54
waitRightTap โ
โข Protected
waitRightTap: boolean
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:55
waitTap โ
โข Protected
waitTap: boolean
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:56
longPressTimer โ
โข Protected
longPressTimer: any
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:57
longPressed โ
โข Protected
longPressed: boolean
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:58
tapCount โ
โข Protected
tapCount: number
= 0
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:59
tapTimer โ
โข Protected
tapTimer: any
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:60
dragger โ
โข dragger: Dragger
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:62
transformer โ
โข transformer: ITransformer
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:63
__eventIds โ
โข Protected
__eventIds: IEventListenerId
[]
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:65
defaultPath โ
โข Protected
defaultPath: ILeafList
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:66
downKeyMap โ
โข Protected
downKeyMap: IBooleanMap
= {}
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:68
Accessors โ
dragging โ
โข get
dragging(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:22
transforming โ
โข get
transforming(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:23
moveMode โ
โข get
moveMode(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:25
canHover โ
โข get
canHover(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:26
isDragEmpty โ
โข get
isDragEmpty(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:28
isMobileDragEmpty โ
โข get
isMobileDragEmpty(): boolean
Returns โ
boolean
Implementation of โ
IInteraction.isMobileDragEmpty
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:29
isHoldMiddleKey โ
โข get
isHoldMiddleKey(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:30
isHoldRightKey โ
โข get
isHoldRightKey(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:31
isHoldSpaceKey โ
โข get
isHoldSpaceKey(): boolean
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:32
m โ
โข get
m(): IMoveConfig
Returns โ
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:35
p โ
โข get
p(): IPointerConfig
Returns โ
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:36
hitRadius โ
โข get
hitRadius(): number
Returns โ
number
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:39
Methods โ
start โ
โธ start(): void
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:84
stop โ
โธ stop(): void
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:88
receive โ
โธ receive(_event
): void
Parameters โ
Name | Type |
---|---|
_event | any |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:93
pointerDown โ
โธ pointerDown(data?
, useDefaultPath?
): void
Parameters โ
Name | Type |
---|---|
data? | IPointerEvent |
useDefaultPath? | boolean |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:96
pointerMove โ
โธ pointerMove(data?
): void
Parameters โ
Name | Type |
---|---|
data? | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:120
pointerMoveReal โ
โธ pointerMoveReal(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:134
pointerUp โ
โธ pointerUp(data?
): void
Parameters โ
Name | Type |
---|---|
data? | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:164
pointerCancel โ
โธ pointerCancel(): void
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:195
menu โ
โธ menu(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:203
menuTap โ
โธ menuTap(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:210
createTransformer โ
โธ createTransformer(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:219
move โ
โธ move(_data
): void
Parameters โ
Name | Type |
---|---|
_data | IMoveEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:221
zoom โ
โธ zoom(_data
): void
Parameters โ
Name | Type |
---|---|
_data | IZoomEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:223
rotate โ
โธ rotate(_data
): void
Parameters โ
Name | Type |
---|---|
_data | IRotateEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:225
transformEnd โ
โธ transformEnd(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:227
wheel โ
โธ wheel(_data
): void
Parameters โ
Name | Type |
---|---|
_data | IWheelEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:229
multiTouch โ
โธ multiTouch(_data
, _list
): void
Parameters โ
Name | Type |
---|---|
_data | IUIEvent |
_list | IKeepTouchData [] |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:231
keyDown โ
โธ keyDown(data
): void
Parameters โ
Name | Type |
---|---|
data | IKeyEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:237
keyUp โ
โธ keyUp(data
): void
Parameters โ
Name | Type |
---|---|
data | IKeyEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:254
pointerHover โ
โธ Protected
pointerHover(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:267
pointerOverOrOut โ
โธ Protected
pointerOverOrOut(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:275
pointerEnterOrLeave โ
โธ Protected
pointerEnterOrLeave(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:290
touchLeave โ
โธ Protected
touchLeave(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:305
tap โ
โธ Protected
tap(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:314
findPath โ
โธ findPath(data
, options?
): ILeafList
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
options? | IPickOptions |
Returns โ
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:354
isRootPath โ
โธ isRootPath(data
): boolean
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:364
isTreePath โ
โธ isTreePath(data
): boolean
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:368
checkPath โ
โธ Protected
checkPath(data
, useDefaultPath?
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
useDefaultPath? | boolean |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:374
canMove โ
โธ canMove(data
): boolean
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:378
isDrag โ
โธ isDrag(leaf
): boolean
Parameters โ
Name | Type |
---|---|
leaf | ILeaf |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:383
isPress โ
โธ isPress(leaf
): boolean
Parameters โ
Name | Type |
---|---|
leaf | ILeaf |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:387
isHover โ
โธ isHover(leaf
): boolean
Parameters โ
Name | Type |
---|---|
leaf | ILeaf |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:391
isFocus โ
โธ isFocus(leaf
): boolean
Parameters โ
Name | Type |
---|---|
leaf | ILeaf |
Returns โ
boolean
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:395
cancelHover โ
โธ cancelHover(): void
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:400
updateDownData โ
โธ updateDownData(data?
, options?
, merge?
): void
Parameters โ
Name | Type |
---|---|
data? | IPointerEvent |
options? | IPickOptions |
merge? | boolean |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:409
updateHoverData โ
โธ updateHoverData(data?
): void
Parameters โ
Name | Type |
---|---|
data? | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:418
updateCursor โ
โธ updateCursor(data?
): void
Parameters โ
Name | Type |
---|---|
data? | IPointerEvent |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:425
setCursor โ
โธ setCursor(cursor
): void
Parameters โ
Name | Type |
---|---|
cursor | ICursorType | ICursorType [] |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:451
getLocal โ
โธ getLocal(clientPoint
, updateClient?
): IPointData
Parameters โ
Name | Type |
---|---|
clientPoint | IClientPointData |
updateClient? | boolean |
Returns โ
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:455
emitTap โ
โธ Protected
emitTap(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:461
emitDoubleTap โ
โธ Protected
emitDoubleTap(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:466
pointerWaitCancel โ
โธ pointerWaitCancel(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:471
tapWait โ
โธ Protected
tapWait(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:476
tapWaitCancel โ
โธ Protected
tapWaitCancel(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:481
longPressWait โ
โธ Protected
longPressWait(data
): void
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:487
longTap โ
โธ Protected
longTap(data
): boolean
Parameters โ
Name | Type |
---|---|
data | IPointerEvent |
Returns โ
boolean
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:495
longPressWaitCancel โ
โธ Protected
longPressWaitCancel(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:505
__onResize โ
โธ Protected
__onResize(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:510
__listenEvents โ
โธ Protected
__listenEvents(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:516
__removeListenEvents โ
โธ Protected
__removeListenEvents(): void
Returns โ
void
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:522
emit โ
โธ emit(type
, data
, path?
, excludePath?
): void
Parameters โ
Name | Type |
---|---|
type | string |
data | IUIEvent |
path? | ILeafList |
excludePath? | ILeafList |
Returns โ
void
Implementation of โ
Defined in โ
ui/packages/interaction/interaction/src/Interaction.ts:528
destroy โ
โธ destroy(): void
Returns โ
void