Class: PointerLockControls2

Extra-Helpers.PointerLockControls2

Hierarchy

• EventDispatcher<PointerLockControls2EventMap>

  ↳ PointerLockControls2

Implements

• ICameraControls<PointerLockControls2EventMap>

Properties

domElement

• Readonly domElement: HTMLElement

---

object

• Readonly object: Object3D<Object3DEventMap>

Implementation of

ICameraControls.object

---

isLocked

• isLocked: boolean = false

---

enabled

• enabled: boolean = true

Implementation of

ICameraControls.enabled

---

minPolarAngle

• minPolarAngle: number = 0

---

maxPolarAngle

• maxPolarAngle: number = Math.PI

---

pointerSpeed

• pointerSpeed: number = 1.0

---

autoLockOnClick

• autoLockOnClick: boolean = true

Constructors

constructor

• new PointerLockControls2(camera, domElement)

Parameters

Name	Type
camera	Object3D<Object3DEventMap>
domElement	HTMLElement

Overrides

EventDispatcher<PointerLockControls2EventMap\>.constructor

Methods

onElementClick

▸ onElementClick(event): void

Parameters

Name	Type
event	Event

Returns

void

---

onMouseMove

▸ onMouseMove(event): void

Parameters

Name	Type
event	MouseEvent

Returns

void

---

onPointerlockChange

▸ onPointerlockChange(): void

Returns

void

---

onPointerlockError

▸ onPointerlockError(): void

Returns

void

---

connect

▸ connect(): void

Returns

void

---

disconnect

▸ disconnect(): void

Returns

void

---

dispose

▸ dispose(): void

Returns

void

Implementation of

ICameraControls.dispose

---

getDirection

▸ getDirection(v): Vector3

Parameters

Name	Type
v	Vector3

Returns

Vector3

---

moveForward

▸ moveForward(distance): void

Parameters

Name	Type
distance	number

Returns

void

---

moveRight

▸ moveRight(distance): void

Parameters

Name	Type
distance	number

Returns

void

---

lock

▸ lock(): void

Returns

void

---

unlock

▸ unlock(): void

Returns

void

---

update

▸ update(): void

Returns

void

Implementation of

ICameraControls.update