Skip to main content

Class: PlumArcRotateCameraPointersInput

Defined in: packages/core/sdk/src/camera/PlumArcRotateCameraPointersInput.ts:3

Extends

  • ArcRotateCameraPointersInput

Constructors

Constructor

new PlumArcRotateCameraPointersInput(): PlumArcRotateCameraPointersInput

Returns

PlumArcRotateCameraPointersInput

Inherited from

ArcRotateCameraPointersInput.constructor

Properties

_altKey

protected _altKey: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:19

Whether keyboard modifier keys are pressed at time of last mouse event.

Inherited from

ArcRotateCameraPointersInput._altKey


_buttonsPressed

protected _buttonsPressed: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:27

Which mouse buttons were pressed at time of last mouse event. https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons

Inherited from

ArcRotateCameraPointersInput._buttonsPressed


_ctrlKey

protected _ctrlKey: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:20

Inherited from

ArcRotateCameraPointersInput._ctrlKey


_metaKey

protected _metaKey: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:21

Inherited from

ArcRotateCameraPointersInput._metaKey


_shiftKey

protected _shiftKey: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:22

Inherited from

ArcRotateCameraPointersInput._shiftKey


angularSensibilityX

angularSensibilityX: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:32

Defines the pointer angular sensibility along the X axis or how fast is the camera rotating.

Inherited from

ArcRotateCameraPointersInput.angularSensibilityX


angularSensibilityY

angularSensibilityY: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:37

Defines the pointer angular sensibility along the Y axis or how fast is the camera rotating.

Inherited from

ArcRotateCameraPointersInput.angularSensibilityY


buttons

buttons: number[]

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:27

Defines the buttons associated with the input to handle camera move.

Inherited from

ArcRotateCameraPointersInput.buttons


camera

camera: ArcRotateCamera

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:14

Defines the camera the input is attached to.

Inherited from

ArcRotateCameraPointersInput.camera


multiTouchPanAndZoom

multiTouchPanAndZoom: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:72

Defines whether panning is enabled for both pan (2 fingers swipe) and zoom (pinch) through multitouch.

Inherited from

ArcRotateCameraPointersInput.multiTouchPanAndZoom


multiTouchPanning

multiTouchPanning: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:67

Defines whether panning (2 fingers swipe) is enabled through multitouch.

Inherited from

ArcRotateCameraPointersInput.multiTouchPanning


panningSensibility

panningSensibility: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:63

Defines the pointer panning sensibility or how fast is the camera moving.

Inherited from

ArcRotateCameraPointersInput.panningSensibility


pinchDeltaPercentage

pinchDeltaPercentage: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:48

pinchDeltaPercentage will be used instead of pinchPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.

Inherited from

ArcRotateCameraPointersInput.pinchDeltaPercentage


pinchInwards

pinchInwards: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:76

Revers pinch action direction.

Inherited from

ArcRotateCameraPointersInput.pinchInwards


pinchPrecision

pinchPrecision: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:41

Defines the pointer pinch precision or how fast is the camera zooming.

Inherited from

ArcRotateCameraPointersInput.pinchPrecision


pinchZoom

pinchZoom: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:59

Defines whether zoom (2 fingers pinch) is enabled through multitouch

Inherited from

ArcRotateCameraPointersInput.pinchZoom


useNaturalPinchZoom

useNaturalPinchZoom: boolean

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:55

When useNaturalPinchZoom is true, multi touch zoom will zoom in such that any object in the plane at the camera's target point will scale perfectly with finger motion. Overrides pinchDeltaPercentage and pinchPrecision.

Inherited from

ArcRotateCameraPointersInput.useNaturalPinchZoom


MinimumRadiusForPinch

static MinimumRadiusForPinch: number

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:18

The minimum radius used for pinch, to avoid radius lock at 0

Inherited from

ArcRotateCameraPointersInput.MinimumRadiusForPinch

Methods

attachControl()

attachControl(noPreventDefault?): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:41

Attach the input controls to a specific dom element to get the input from.

Parameters

noPreventDefault?

boolean

Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)

Returns

void

Inherited from

ArcRotateCameraPointersInput.attachControl


detachControl()

detachControl(): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:45

Detach the current controls from the specified dom element.

Returns

void

Inherited from

ArcRotateCameraPointersInput.detachControl


getClassName()

getClassName(): string

Defined in: packages/core/sdk/src/camera/PlumArcRotateCameraPointersInput.ts:24

Gets the class name of the current input.

Returns

string

the class name

Overrides

ArcRotateCameraPointersInput.getClassName


getSimpleName()

getSimpleName(): string

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:55

Get the friendly name associated with the input class.

Returns

string

the input friendly name

Inherited from

ArcRotateCameraPointersInput.getSimpleName


onButtonDown()

onButtonDown(evt): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:118

Called each time a new POINTERDOWN event occurs. Ie, for each button press.

Parameters

evt

IPointerEvent

Defines the event to track

Returns

void

Inherited from

ArcRotateCameraPointersInput.onButtonDown


onButtonUp()

onButtonUp(_evt): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:124

Called each time a new POINTERUP event occurs. Ie, for each button release.

Parameters

_evt

IPointerEvent

Defines the event to track

Returns

void

Inherited from

ArcRotateCameraPointersInput.onButtonUp


onContextMenu()

onContextMenu(evt): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/BaseCameraPointersInput.d.ts:86

Called on JS contextmenu event. Override this method to provide functionality.

Parameters

evt

PointerEvent

the event to be handled

Returns

void

Inherited from

ArcRotateCameraPointersInput.onContextMenu


onDoubleTap()

onDoubleTap(): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:102

Called on pointer POINTERDOUBLETAP event.

Returns

void

Inherited from

ArcRotateCameraPointersInput.onDoubleTap


onLostFocus()

onLostFocus(): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:128

Called when window becomes inactive.

Returns

void

Inherited from

ArcRotateCameraPointersInput.onLostFocus


onMultiTouch()

onMultiTouch(pointA, pointB, previousPinchSquaredDistance, pinchSquaredDistance, previousMultiTouchPanPosition, multiTouchPanPosition): void

Defined in: node_modules/@babylonjs/core/Cameras/Inputs/arcRotateCameraPointersInput.d.ts:112

Called on pointer POINTERMOVE event if multiple touches are active.

Parameters

pointA

PointerTouch

point A

pointB

PointerTouch

point B

previousPinchSquaredDistance

number

distance between points in previous pinch

pinchSquaredDistance

number

distance between points in current pinch

previousMultiTouchPanPosition

PointerTouch

multi-touch position in previous step

multiTouchPanPosition

PointerTouch

multi-touch position in current step

Returns

void

Inherited from

ArcRotateCameraPointersInput.onMultiTouch


onTouch()

onTouch(point, offsetX, offsetY): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCameraPointersInput.ts:10

Called on pointer POINTERMOVE event if only a single touch is active.

Parameters

point

PointerTouch

current touch point

offsetX

number

offset on X

offsetY

number

offset on Y

Returns

void

Overrides

ArcRotateCameraPointersInput.onTouch