Class: SurfaceControls

Defined in: src/SurfaceControls.ts:17

Natural surface manipulation controls - RGL/SUMA style Implements virtual trackball rotation for intuitive 3D manipulation

Extends

• EventDispatcher

Constructors

Constructor

new SurfaceControls(
   camera, 
   domElement, 
   config?): SurfaceControls;

Defined in: src/SurfaceControls.ts:84

Parameters

camera

Camera

domElement

HTMLElement

config?

SurfaceControlsConfig = {}

Returns

SurfaceControls

Overrides

EventDispatcher.constructor

Properties

camera

camera: Camera;

Defined in: src/SurfaceControls.ts:18

---

domElement

domElement: HTMLElement;

Defined in: src/SurfaceControls.ts:19

---

enabled

enabled: boolean;

Defined in: src/SurfaceControls.ts:20

---

rotateSpeed

rotateSpeed: number;

Defined in: src/SurfaceControls.ts:23

---

zoomSpeed

zoomSpeed: number;

Defined in: src/SurfaceControls.ts:24

---

panSpeed

panSpeed: number;

Defined in: src/SurfaceControls.ts:25

---

enableRotate

enableRotate: boolean;

Defined in: src/SurfaceControls.ts:26

---

enableZoom

enableZoom: boolean;

Defined in: src/SurfaceControls.ts:27

---

enablePan

enablePan: boolean;

Defined in: src/SurfaceControls.ts:28

---

enableDamping

enableDamping: boolean;

Defined in: src/SurfaceControls.ts:29

---

dampingFactor

dampingFactor: number;

Defined in: src/SurfaceControls.ts:30

---

minDistance

minDistance: number;

Defined in: src/SurfaceControls.ts:31

---

maxDistance

maxDistance: number;

Defined in: src/SurfaceControls.ts:32

---

target

target: Vector3;

Defined in: src/SurfaceControls.ts:35

---

mouseButtons

readonly mouseButtons: object;

Defined in: src/SurfaceControls.ts:38

LEFT

LEFT: MOUSE = THREE.MOUSE.ROTATE;

MIDDLE

MIDDLE: MOUSE = THREE.MOUSE.DOLLY;

RIGHT

RIGHT: MOUSE = THREE.MOUSE.PAN;

---

state

readonly state: object;

Defined in: src/SurfaceControls.ts:44

NONE

NONE: number = -1;

ROTATE

ROTATE: number = 0;

DOLLY

DOLLY: number = 1;

PAN

PAN: number = 2;

TOUCH_ROTATE

TOUCH_ROTATE: number = 3;

TOUCH_PAN

TOUCH_PAN: number = 4;

TOUCH_DOLLY_PAN

TOUCH_DOLLY_PAN: number = 5;

TOUCH_DOLLY_ROTATE

TOUCH_DOLLY_ROTATE: number = 6;

---

currentState

currentState: number;

Defined in: src/SurfaceControls.ts:55

Methods

handleResize()

handleResize(): void;

Defined in: src/SurfaceControls.ts:159

Returns

void

---

getMouseOnBall()

getMouseOnBall(pageX, pageY): Vector3;

Defined in: src/SurfaceControls.ts:168

Parameters

pageX

number

pageY

number

Returns

Vector3

---

rotateCamera()

rotateCamera(): void;

Defined in: src/SurfaceControls.ts:191

Returns

void

---

panCamera()

panCamera(): void;

Defined in: src/SurfaceControls.ts:229

Returns

void

---

dollyCamera()

dollyCamera(): void;

Defined in: src/SurfaceControls.ts:269

Returns

void

---

update()

update(): void;

Defined in: src/SurfaceControls.ts:283

Returns

void

---

onMouseDown()

onMouseDown(event): void;

Defined in: src/SurfaceControls.ts:295

Parameters

event

MouseEvent

Returns

void

---

onMouseMove()

onMouseMove(event): void;

Defined in: src/SurfaceControls.ts:329

Parameters

event

MouseEvent

Returns

void

---

onMouseUp()

onMouseUp(event): void;

Defined in: src/SurfaceControls.ts:357

Parameters

event

MouseEvent

Returns

void

---

onMouseWheel()

onMouseWheel(event): void;

Defined in: src/SurfaceControls.ts:366

Parameters

event

WheelEvent

Returns

void

---

onTouchStart()

onTouchStart(event): void;

Defined in: src/SurfaceControls.ts:378

Parameters

event

TouchEvent

Returns

void

---

onTouchMove()

onTouchMove(event): void;

Defined in: src/SurfaceControls.ts:408

Parameters

event

TouchEvent

Returns

void

---

onTouchEnd()

onTouchEnd(event): void;

Defined in: src/SurfaceControls.ts:448

Parameters

event

TouchEvent

Returns

void

---

dispose()

dispose(): void;

Defined in: src/SurfaceControls.ts:454

Returns

void

---

reset()

reset(): void;

Defined in: src/SurfaceControls.ts:466

Returns

void

---

saveState()

saveState(): void;

Defined in: src/SurfaceControls.ts:474

Returns

void

---

restoreState()

restoreState(): void;

Defined in: src/SurfaceControls.ts:480

Returns

void

---

getTarget()

getTarget(): Vector3;

Defined in: src/SurfaceControls.ts:489

Returns

Vector3