Skip to content

Documentation / scene / IControllerWheelEvent

Interface: IControllerWheelEvent ​

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

Wheel (scroll) event for camera controllers.

Extends a mouse event with wheel delta values for scroll-based input (e.g., zoom).

Extends ​

Properties ​

type ​

type: "wheel"

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

Event type identifier.

Inherited from ​

IControllerMouseEvent.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 ​

IControllerMouseEvent.preventDefault


ctrlKey ​

readonly ctrlKey: boolean

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

Whether the Control key is pressed.

Inherited from ​

IControllerMouseEvent.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 ​

IControllerMouseEvent.metaKey


shiftKey ​

readonly shiftKey: boolean

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

Whether the Shift key is pressed.

Inherited from ​

IControllerMouseEvent.shiftKey


altKey ​

readonly altKey: boolean

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

Whether the Alt/Option key is pressed.

Inherited from ​

IControllerMouseEvent.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.

Inherited from ​

IControllerMouseEvent.offsetX


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.

Inherited from ​

IControllerMouseEvent.offsetY


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.

Inherited from ​

IControllerMouseEvent.button


deltaX ​

readonly deltaX: number

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

Horizontal wheel scroll delta.


deltaY ​

readonly deltaY: number

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

Vertical wheel scroll delta.


deltaMode ​

readonly deltaMode: number

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

Delta mode

Released under the MIT License.