Orillusion

English

简体中文

English

简体中文

Appearance

Class: PointerEvent3D ​

enum event type of pointer. InputSystem

Hierarchy ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

• new PointerEvent3D(eventType?, data?): PointerEvent3D

Create a new event, with type and data

Parameters ​

NameTypeDefault valueDescription
eventTypestringnull{any} eventType
dataanynull{any} param

Returns ​

PointerEvent3D

Inherited from ​

CEvent.constructor

Defined in ​

src/event/CEvent.ts:102

Properties ​

target ​

• target: Object3D

Event target, it's usually event dispatcher

Inherited from ​

CEvent.target

Defined in ​

src/event/CEvent.ts:13

currentTarget ​

• currentTarget: CEventListener

Current event target, it's current bubble object

Inherited from ​

CEvent.currentTarget

Defined in ​

src/event/CEvent.ts:18

type ​

• type: string

event type, it's registered string of key

Inherited from ​

CEvent.type

Defined in ​

src/event/CEvent.ts:23

data ​

• data: any

extra data.Used for the transmission process of events, carrying data

Inherited from ​

CEvent.data

Defined in ​

src/event/CEvent.ts:28

param ​

• param: any

The param data when event is registered

Inherited from ​

CEvent.param

Defined in ​

src/event/CEvent.ts:34

time ​

• time: number = 0

the time when event is

Inherited from ​

CEvent.time

Defined in ​

src/event/CEvent.ts:40

delay ​

• delay: number = 0

the delay time when event is dispatched.

Inherited from ​

CEvent.delay

Defined in ​

src/event/CEvent.ts:46

mouseCode ​

• mouseCode: number = 0

mouse code, see

Mouse Code

MouseCode

Inherited from ​

CEvent.mouseCode

Defined in ​

src/event/CEvent.ts:52

ctrlKey ​

• ctrlKey: boolean

Is Ctrl key pressed when the event occurs

Inherited from ​

CEvent.ctrlKey

Defined in ​

src/event/CEvent.ts:57

metaKey ​

• metaKey: boolean

Is Meta key pressed when the event occurs

Inherited from ​

CEvent.metaKey

Defined in ​

src/event/CEvent.ts:62

altKey ​

• altKey: boolean

Is Alt key pressed when the event occurs

Inherited from ​

CEvent.altKey

Defined in ​

src/event/CEvent.ts:67

shiftKey ​

• shiftKey: boolean

Is Shift key pressed when the event occurs

Inherited from ​

CEvent.shiftKey

Defined in ​

src/event/CEvent.ts:72

targetTouches ​

• targetTouches: TouchData[]

Collection of finger touch points, which registered

Inherited from ​

CEvent.targetTouches

Defined in ​

src/event/CEvent.ts:77

changedTouches ​

• changedTouches: TouchData[]

Collection of finger touch points changed

Inherited from ​

CEvent.changedTouches

Defined in ​

src/event/CEvent.ts:82

touches ​

• touches: TouchData[]

Collection of finger touch points

Inherited from ​

CEvent.touches

Defined in ​

src/event/CEvent.ts:87

view ​

• view: View3D

binded view3D object in event.

Inherited from ​

CEvent.view

Defined in ​

src/event/CEvent.ts:94

PICK_OVER ​

▪ Static PICK_OVER: string = 'onPickOver'

Triggered when the touch point enters the collision

Defined in ​

src/event/eventConst/PointerEvent3D.ts:13

PICK_OVER_GUI ​

▪ Static PICK_OVER_GUI: string = 'onPickOverGUI'

Triggered when the touch point enters the interactive GUI

Defined in ​

src/event/eventConst/PointerEvent3D.ts:18

PICK_CLICK ​

▪ Static PICK_CLICK: string = 'onPickClick'

Triggered when the touch point clicked the collision

Defined in ​

src/event/eventConst/PointerEvent3D.ts:23

PICK_CLICK_GUI ​

▪ Static PICK_CLICK_GUI: string = 'onPickClickGUI'

Triggered when the touch point clicked the interactive GUI

Defined in ​

src/event/eventConst/PointerEvent3D.ts:28

PICK_OUT ​

▪ Static PICK_OUT: string = 'onPickOut'

Triggered when the touch point leave the collision

Defined in ​

src/event/eventConst/PointerEvent3D.ts:33

PICK_OUT_GUI ​

▪ Static PICK_OUT_GUI: string = 'onPickOutGUI'

Triggered when the touch point leave the interactive GUI

Defined in ​

src/event/eventConst/PointerEvent3D.ts:38

PICK_MOVE ​

▪ Static PICK_MOVE: string = 'onPickMove'

Triggered when the touch point move on the collision

Defined in ​

src/event/eventConst/PointerEvent3D.ts:43

PICK_UP ​

▪ Static PICK_UP: string = 'onPickUp'

Triggered when the touch point release from the collision

Defined in ​

src/event/eventConst/PointerEvent3D.ts:48

PICK_UP_GUI ​

▪ Static PICK_UP_GUI: string = 'onPickUpGUI'

Triggered when the touch point release from the interactive GUI

Defined in ​

src/event/eventConst/PointerEvent3D.ts:53

PICK_DOWN ​

▪ Static PICK_DOWN: string = 'onPickDown'

Triggered when the touch point pressed the collision

Defined in ​

src/event/eventConst/PointerEvent3D.ts:58

PICK_DOWN_GUI ​

▪ Static PICK_DOWN_GUI: string = 'onPickDownGUI'

Triggered when the touch point pressed the interactive GUI

Defined in ​

src/event/eventConst/PointerEvent3D.ts:63

POINTER_RIGHT_CLICK ​

▪ Static POINTER_RIGHT_CLICK: string = 'onPointerRightClick'

Triggered when the right pointer clicked

Defined in ​

src/event/eventConst/PointerEvent3D.ts:69

POINTER_MID_UP ​

▪ Static POINTER_MID_UP: string = 'onPointerMidUp'

Triggered when the middle pointer released

Defined in ​

src/event/eventConst/PointerEvent3D.ts:74

POINTER_MID_DOWN ​

▪ Static POINTER_MID_DOWN: string = 'onPointerMidDown'

Triggered when the middle pointer pressed

Defined in ​

src/event/eventConst/PointerEvent3D.ts:79

POINTER_CLICK ​

▪ Static POINTER_CLICK: string = 'onPointerClick'

Triggered when the pointer clicked

Defined in ​

src/event/eventConst/PointerEvent3D.ts:84

POINTER_MOVE ​

▪ Static POINTER_MOVE: string = 'onPointerMove'

Triggered when the pointer moved

Defined in ​

src/event/eventConst/PointerEvent3D.ts:90

POINTER_DOWN ​

▪ Static POINTER_DOWN: string = 'onPointerDown'

Triggered when the pointer pressed

Defined in ​

src/event/eventConst/PointerEvent3D.ts:96

POINTER_UP ​

▪ Static POINTER_UP: string = 'onPointerUp'

Triggered when the pointer released

Defined in ​

src/event/eventConst/PointerEvent3D.ts:102

POINTER_OUT ​

▪ Static POINTER_OUT: string = 'onPointerOut'

Triggered when the pointer move out

Defined in ​

src/event/eventConst/PointerEvent3D.ts:108

POINTER_OVER ​

▪ Static POINTER_OVER: string = 'onPointerOver'

Triggered when the pointer move over

Defined in ​

src/event/eventConst/PointerEvent3D.ts:114

POINTER_WHEEL ​

▪ Static POINTER_WHEEL: string = 'onPointerWheel'

Triggered when the wheel pointer is used

Defined in ​

src/event/eventConst/PointerEvent3D.ts:120

pointerId ​

• pointerId: number

A unique identifier for an event caused by a pointer.

Defined in ​

src/event/eventConst/PointerEvent3D.ts:125

pointerType ​

• pointerType: string

event type

Defined in ​

src/event/eventConst/PointerEvent3D.ts:130

isPrimary ​

• isPrimary: boolean

whether it's the preferred pointer in this type of pointer.

Defined in ​

src/event/eventConst/PointerEvent3D.ts:135

pressure ​

• pressure: number

Normalize values

Defined in ​

src/event/eventConst/PointerEvent3D.ts:140

mouseX ​

• mouseX: number

coord x of mouse

Defined in ​

src/event/eventConst/PointerEvent3D.ts:145

mouseY ​

• mouseY: number

coord y of mouse

Defined in ​

src/event/eventConst/PointerEvent3D.ts:150

movementX ​

• movementX: number

delta of coord x of mouse

Defined in ​

src/event/eventConst/PointerEvent3D.ts:155

movementY ​

• movementY: number

delta of coord y of mouse

Defined in ​

src/event/eventConst/PointerEvent3D.ts:160

deltaX ​

• deltaX: number

Returns a negative value when scrolling left, a positive value when scrolling right, otherwise 0.

Defined in ​

src/event/eventConst/PointerEvent3D.ts:166

deltaY ​

• deltaY: number

Returns a positive value when scrolling down, a negative value when scrolling up, otherwise 0.

Defined in ​

src/event/eventConst/PointerEvent3D.ts:172

Accessors ​

isStopImmediatePropagation ​

• get isStopImmediatePropagation(): boolean

Returns stopImmediatePropagation value

Returns ​

boolean

Inherited from ​

CEvent.isStopImmediatePropagation

Defined in ​

src/event/CEvent.ts:125

Methods ​

stopImmediatePropagation ​

▸ stopImmediatePropagation(): void

Prevent bubbling of all event listeners in subsequent nodes of the current node in the event flow.

Returns ​

void

Inherited from ​

CEvent.stopImmediatePropagation

Defined in ​

src/event/CEvent.ts:110

Released under the MIT License

Copyright © 2021-Present Orillusion