Skip to content

@orillusion/core


Class: PointerEvent3D

Defined in: src/event/eventConst/PointerEvent3D.ts:18

enum event type of pointer. InputSystem

Extends

Constructors

Constructor

new PointerEvent3D(eventType?, data?): PointerEvent3D

Defined in: src/event/CEvent.ts:102

Create a new event, with type and data

Parameters

eventType?

string = null

{any} eventType

data?

any = null

{any} param

Returns

PointerEvent3D

Inherited from

CEvent.constructor

Properties

target

target: Object3D

Defined in: src/event/CEvent.ts:13

Event target, it's usually event dispatcher

Inherited from

CEvent.target


currentTarget

currentTarget: CEventListener

Defined in: src/event/CEvent.ts:18

Current event target, it's current bubble object

Inherited from

CEvent.currentTarget


type

type: string

Defined in: src/event/CEvent.ts:23

event type, it's registered string of key

Inherited from

CEvent.type


param

param: any

Defined in: src/event/CEvent.ts:34

The param data when event is registered

Inherited from

CEvent.param


time

time: number = 0

Defined in: src/event/CEvent.ts:40

the time when event is

Inherited from

CEvent.time


delay

delay: number = 0

Defined in: src/event/CEvent.ts:46

the delay time when event is dispatched.

Inherited from

CEvent.delay


mouseCode

mouseCode: number = 0

Defined in: src/event/CEvent.ts:52

mouse code, see

Mouse Code

MouseCode

Inherited from

CEvent.mouseCode


ctrlKey

ctrlKey: boolean

Defined in: src/event/CEvent.ts:57

Is Ctrl key pressed when the event occurs

Inherited from

CEvent.ctrlKey


metaKey

metaKey: boolean

Defined in: src/event/CEvent.ts:62

Is Meta key pressed when the event occurs

Inherited from

CEvent.metaKey


altKey

altKey: boolean

Defined in: src/event/CEvent.ts:67

Is Alt key pressed when the event occurs

Inherited from

CEvent.altKey


shiftKey

shiftKey: boolean

Defined in: src/event/CEvent.ts:72

Is Shift key pressed when the event occurs

Inherited from

CEvent.shiftKey


targetTouches

targetTouches: TouchData[]

Defined in: src/event/CEvent.ts:77

Collection of finger touch points, which registered

Inherited from

CEvent.targetTouches


changedTouches

changedTouches: TouchData[]

Defined in: src/event/CEvent.ts:82

Collection of finger touch points changed

Inherited from

CEvent.changedTouches


touches

touches: TouchData[]

Defined in: src/event/CEvent.ts:87

Collection of finger touch points

Inherited from

CEvent.touches


view

view: View3D

Defined in: src/event/CEvent.ts:94

binded view3D object in event.

Inherited from

CEvent.view


PICK_OVER

static PICK_OVER: string = 'onPickOver'

Defined in: src/event/eventConst/PointerEvent3D.ts:22

Triggered when the touch point enters the collision


PICK_CLICK

static PICK_CLICK: string = 'onPickClick'

Defined in: src/event/eventConst/PointerEvent3D.ts:27

Triggered when the touch point clicked the collision


PICK_OUT

static PICK_OUT: string = 'onPickOut'

Defined in: src/event/eventConst/PointerEvent3D.ts:32

Triggered when the touch point leave the collision


PICK_MOVE

static PICK_MOVE: string = 'onPickMove'

Defined in: src/event/eventConst/PointerEvent3D.ts:37

Triggered when the touch point move on the collision


PICK_UP

static PICK_UP: string = 'onPickUp'

Defined in: src/event/eventConst/PointerEvent3D.ts:42

Triggered when the touch point release from the collision


PICK_DOWN

static PICK_DOWN: string = 'onPickDown'

Defined in: src/event/eventConst/PointerEvent3D.ts:47

Triggered when the touch point pressed the collision


POINTER_RIGHT_CLICK

static POINTER_RIGHT_CLICK: string = 'onPointerRightClick'

Defined in: src/event/eventConst/PointerEvent3D.ts:53

Triggered when the right pointer clicked


POINTER_CLICK

static POINTER_CLICK: string = 'onPointerClick'

Defined in: src/event/eventConst/PointerEvent3D.ts:58

Triggered when the pointer clicked


POINTER_MOVE

static POINTER_MOVE: string = 'onPointerMove'

Defined in: src/event/eventConst/PointerEvent3D.ts:64

Triggered when the pointer moved


POINTER_DOWN

static POINTER_DOWN: string = 'onPointerDown'

Defined in: src/event/eventConst/PointerEvent3D.ts:70

Triggered when the pointer pressed


POINTER_UP

static POINTER_UP: string = 'onPointerUp'

Defined in: src/event/eventConst/PointerEvent3D.ts:76

Triggered when the pointer released


POINTER_OUT

static POINTER_OUT: string = 'onPointerOut'

Defined in: src/event/eventConst/PointerEvent3D.ts:82

Triggered when the pointer move out


POINTER_OVER

static POINTER_OVER: string = 'onPointerOver'

Defined in: src/event/eventConst/PointerEvent3D.ts:88

Triggered when the pointer move over


POINTER_WHEEL

static POINTER_WHEEL: string = 'onPointerWheel'

Defined in: src/event/eventConst/PointerEvent3D.ts:94

Triggered when the wheel pointer is used


pointerId

pointerId: number

Defined in: src/event/eventConst/PointerEvent3D.ts:99

A unique identifier for an event caused by a pointer.


pointerType

pointerType: string = 'onPointer'

Defined in: src/event/eventConst/PointerEvent3D.ts:104

event type


isPrimary

isPrimary: boolean

Defined in: src/event/eventConst/PointerEvent3D.ts:109

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


pressure

pressure: number

Defined in: src/event/eventConst/PointerEvent3D.ts:114

Normalize values


mouseX

mouseX: number

Defined in: src/event/eventConst/PointerEvent3D.ts:119

coord x of mouse


mouseY

mouseY: number

Defined in: src/event/eventConst/PointerEvent3D.ts:124

coord y of mouse


movementX

movementX: number

Defined in: src/event/eventConst/PointerEvent3D.ts:129

delta of coord x of mouse


movementY

movementY: number

Defined in: src/event/eventConst/PointerEvent3D.ts:134

delta of coord y of mouse


deltaX

deltaX: number

Defined in: src/event/eventConst/PointerEvent3D.ts:140

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


deltaY

deltaY: number

Defined in: src/event/eventConst/PointerEvent3D.ts:146

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


data

data: pickResult

Defined in: src/event/eventConst/PointerEvent3D.ts:152

Pick result carried by PICK_* events: hit mesh id, world position/normal, and optional screen UV and distance.

Overrides

CEvent.data

Accessors

isStopImmediatePropagation

Get Signature

get isStopImmediatePropagation(): boolean

Defined in: src/event/CEvent.ts:125

Returns stopImmediatePropagation value

Returns

boolean

Inherited from

CEvent.isStopImmediatePropagation

Methods

stopImmediatePropagation()

stopImmediatePropagation(): void

Defined in: src/event/CEvent.ts:110

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

Returns

void

Inherited from

CEvent.stopImmediatePropagation