Documentation / scene / IControllerMouseEvent

Interface: IControllerMouseEvent<T>

Defined in: libs/scene/src/camera/base.ts:46

Base interface for all controller mouse and pointer events.

Extends the base event with positional and button information, as well as modifier keys.

Extends

• IBaseEvent<T>.IModKey

Extended by

• IControllerPointerDownEvent
• IControllerPointerUpEvent
• IControllerPointerMoveEvent
• IControllerPointerCancelEvent
• IControllerWheelEvent

Type Parameters

T

T extends string

Properties

type

type: T

Defined in: libs/scene/src/camera/base.ts:13

Event type identifier.

Inherited from

IBaseEvent.type

---

preventDefault?

optional preventDefault?: () => void

Defined in: libs/scene/src/camera/base.ts:18

Optional method to cancel the default event behavior. May be provided by the event source.

Returns

void

Inherited from

IBaseEvent.preventDefault

---

ctrlKey

readonly ctrlKey: boolean

Defined in: libs/scene/src/camera/base.ts:30

Whether the Control key is pressed.

Inherited from

IModKey.ctrlKey

---

metaKey

readonly metaKey: boolean

Defined in: libs/scene/src/camera/base.ts:32

Whether the Meta (Command on macOS) key is pressed.

Inherited from

IModKey.metaKey

---

shiftKey

readonly shiftKey: boolean

Defined in: libs/scene/src/camera/base.ts:34

Whether the Shift key is pressed.

Inherited from

IModKey.shiftKey

---

altKey

readonly altKey: boolean

Defined in: libs/scene/src/camera/base.ts:36

Whether the Alt/Option key is pressed.

Inherited from

IModKey.altKey

---

offsetX

readonly offsetX: number

Defined in: libs/scene/src/camera/base.ts:48

Pointer offset along the X-axis, typically relative to the event target.

---

offsetY

readonly offsetY: number

Defined in: libs/scene/src/camera/base.ts:50

Pointer offset along the Y-axis, typically relative to the event target.

---

button

readonly button: number

Defined in: libs/scene/src/camera/base.ts:52

Mouse button index: 0 for left, 1 for middle, 2 for right, etc.