RotateControl

Since version 4.0.0

source

Camera's rotation control

class RotateControl extends Component<RotateControlEvents> implements CameraControl

Extends

• Component<RotateControlEvents>

Implements

• CameraControl

Properties

animating

Whether this control is animating the camera

disableKeyboard

Disable rotation by keyboard.

disablePitch

Disable X-axis(pitch) rotation.

disableYaw

Disable Y-axis(yaw) rotation.

duration

Duration of the input animation (ms)

easing

Easing function of the animation

enabled

Whether this control is enabled or not

keyboardScale

Scale factor for keyboard rotation

pitch

Current pitch value

pointerScale

Scale factor for mouse/touch rotation

scrollable

If true, enables scroll on mobile(touch) devices on canvas.

caution

When this option is enabled, users must swipe horizontally first then vertically to change view up or down.

yaw

Current yaw value

Methods

destroy

Destroy the instance and remove all event listeners attached.

disable

Disable this control and remove all event listeners

enable

Enable this control and add event listeners.

hasOn

off

on

once

resize

Resize control to match target size.

sync

Synchronize this control's state to current camera state

trigger

Constructor

Create new RotateControl instance

new RotateControl(controlEl: HTMLElement, enableBlocked: boolean, options: Partial<RotateControlOptions>): RotateControl

Parameters

controlEl

HTMLElement

Element to attach handlers

enableBlocked

boolean

Whether to disable control on init

options

Partial<RotateControlOptions>

{}

Options for control

Properties

animating

readonly

animating

boolean

Whether this control is animating the camera

source

disableKeyboard

disableKeyboard

boolean

false

Disable rotation by keyboard.

source

disablePitch

disablePitch

boolean

false

Disable X-axis(pitch) rotation.

source

disableYaw

disableYaw

boolean

false

Disable Y-axis(yaw) rotation.

source

duration

duration

number

300

Duration of the input animation (ms)

source

easing

easing

((x: number) => number)

EASING.EASE_OUT_CUBIC

Easing function of the animation

See

EASING

source

enabled

readonly

enabled

boolean

Whether this control is enabled or not

source

keyboardScale

>=4.0.0

keyboardScale

[number,number]

[1, 1]

Scale factor for keyboard rotation

source

pitch

>=4.0.0

readonly

pitch

Motion

Current pitch value

source

pointerScale

>=4.0.0

pointerScale

[number,number]

[1, 1]

Scale factor for mouse/touch rotation

source

scrollable

scrollable

boolean

If true, enables scroll on mobile(touch) devices on canvas.

caution

When this option is enabled, users must swipe horizontally first then vertically to change view up or down.

source

yaw

>=4.0.0

readonly

yaw

Motion

Current yaw value

source

Methods

destroy

>=4.0.0

destroy

void

destroy(): void

Destroy the instance and remove all event listeners attached.

source

disable

>=4.0.0

disable

void

disable(): void

Disable this control and remove all event listeners

source

enable

>=4.0.0

enable

void

enable(): void

Enable this control and add event listeners.

source

hasOn

inherited

hasOn

boolean

hasOn<K>(eventName: K): boolean

Parameters

eventName

K

off

inherited

off

RotateControl

off<K>(eventName: K, handlerToDetach: EventCallback<RotateControlEvents, K, RotateControl>): RotateControl

Parameters

eventName

K

handlerToDetach

EventCallback<RotateControlEvents, K, RotateControl>

on

inherited

on

RotateControl

on(eventHash: Partial<{ change: ((event: { delta: RotateDeltaType; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>): RotateControl

Parameters

eventHash

Partial<{ change: ((event: { delta: RotateDeltaType; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>

once

inherited

once

RotateControl

once(eventHash: Partial<{ change: ((event: { delta: RotateDeltaType; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>): RotateControl

Parameters

eventHash

Partial<{ change: ((event: { delta: RotateDeltaType; isKeyboard: boolean; isTouch: boolean }) => any); disable: ((event: { updateCursor: boolean }) => any); enable: ((event: { control: CameraControl; updateCursor: boolean }) => any); inputEnd: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; scrolling: boolean }) => any); inputStart: ((event: { inputType: "zoom" | "rotate" } & { isKeyboard: boolean; isTouch: boolean; srcEvent: MouseEvent | TouchEvent | KeyboardEvent }) => any); staticClick: ((event: { isTouch: boolean }) => any) }>

resize

resize

void

resize(hfov: number, aspect: number, width: number, height: number): void

Resize control to match target size.

Parameters

hfov

number

Camera horizontal fov in degrees

aspect

number

Camera aspect

width

number

New width

height

number

New height

source

sync

>=4.0.0

sync

void

sync(camera: Camera): void

Synchronize this control's state to current camera state

Parameters

camera

Camera

Camera's instance

source

trigger

inherited

trigger

RotateControl

trigger<K>(event: K, ...params: EventTriggerParams<RotateControlEvents, K>): RotateControl

Parameters

event

K

params

EventTriggerParams<RotateControlEvents, K>