Class: PointerLockControls2

Extra-Helpers.PointerLockControls2

Hierarchy

• SimpleEventDispatcher<TPointerLockEvents>

  ↳ PointerLockControls2

Implements

• ICameraControls<TPointerLockEvents>

Properties

domElement

• Readonly domElement: HTMLElement

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:25

---

object

• Readonly object: Object3D<Event, string>

Implementation of

ICameraControls.object

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:26

---

isLocked

• isLocked: boolean = false

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:27

---

enabled

• enabled: boolean = true

Implementation of

ICameraControls.enabled

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:29

---

minPolarAngle

• minPolarAngle: number = 0

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:33

---

maxPolarAngle

• maxPolarAngle: number = Math.PI

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:34

---

pointerSpeed

• pointerSpeed: number = 1.0

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:36

---

autoLockOnClick

• autoLockOnClick: boolean = true

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:38

Constructors

constructor

• new PointerLockControls2(camera, domElement)

Parameters

Name	Type
camera	Object3D<Event, string>
domElement	HTMLElement

Overrides

SimpleEventDispatcher<TPointerLockEvents\>.constructor

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:40

Methods

onElementClick

▸ onElementClick(event): void

Parameters

Name	Type
event	Event

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:55

---

onMouseMove

▸ onMouseMove(event): void

Parameters

Name	Type
event	MouseEvent

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:68

---

onPointerlockChange

▸ onPointerlockChange(): void

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:77

---

onPointerlockError

▸ onPointerlockError(): void

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:95

---

connect

▸ connect(): void

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:101

---

disconnect

▸ disconnect(): void

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:110

---

dispose

▸ dispose(): void

Returns

void

Implementation of

ICameraControls.dispose

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:119

---

getDirection

▸ getDirection(v): Vector3

Parameters

Name	Type
v	Vector3

Returns

Vector3

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:133

---

moveForward

▸ moveForward(distance): void

Parameters

Name	Type
distance	number

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:139

---

moveRight

▸ moveRight(distance): void

Parameters

Name	Type
distance	number

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:152

---

lock

▸ lock(): void

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:160

---

unlock

▸ unlock(): void

Returns

void

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:166

---

update

▸ update(): void

Returns

void

Implementation of

ICameraControls.update

Defined in

webgi/src/helpers/threejs/PointerLockControls2.ts:172