Interface PointerLockControls

Pointer lock controls

Hierarchy

EventDispatcher
- PointerLockControls

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PointerLockControls(camera: I3JS.Camera, domElement?: HTMLElement): I3JS.PointerLockControls
new PointerLockControls(): I3JS.PointerLockControls

Inherited from EventDispatcher.constructor
- Defined in lib/threejs-library/types/three/examples/controls.ts:318
Creates eventDispatcher object. It needs to be call with '.call' to add the functionality to an object.

Parameters
- camera: I3JS.Camera
- Optional domElement: HTMLElement
Returns I3JS.PointerLockControls
Inherited from EventDispatcher.constructor
- Defined in lib/threejs-library/types/three/core.ts:768
Creates eventDispatcher object. It needs to be call with '.call' to add the functionality to an object.

Returns I3JS.PointerLockControls

Properties

domElement

domElement: HTMLElement

isLocked

isLocked: boolean

maxPolarAngle

maxPolarAngle: number

minPolarAngle

minPolarAngle: number

Methods

addEventListener

addEventListener<T>(type: T, listener: EventListener<Event, T, I3JS.PointerLockControls>): void

Inherited from EventDispatcher.addEventListener
- Defined in lib/threejs-library/types/three/core.ts:775
Adds a listener to an event type.

Type parameters
- T: string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, I3JS.PointerLockControls>
  
  The that gets called when the event is fired.
Returns void

connect

connect(): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:329
Returns void

disconnect

disconnect(): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:330
Returns void

dispatchEvent

dispatchEvent(event: Event): void

Inherited from EventDispatcher.dispatchEvent
- Defined in lib/threejs-library/types/three/core.ts:795
Fire an event type.

Parameters
- event: Event
Returns void

dispose

dispose(): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:331
Returns void

getDirection

getDirection(v: I3JS.Vector3): I3JS.Vector3

- Defined in lib/threejs-library/types/three/examples/controls.ts:333
Parameters
- v: I3JS.Vector3
Returns I3JS.Vector3

getObject

getObject(): I3JS.Camera

- Defined in lib/threejs-library/types/three/examples/controls.ts:332
Returns I3JS.Camera

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Event, T, I3JS.PointerLockControls>): boolean

Inherited from EventDispatcher.hasEventListener
- Defined in lib/threejs-library/types/three/core.ts:782
Checks if listener is added to an event type.

Type parameters
- T: string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, I3JS.PointerLockControls>
  
  The that gets called when the event is fired.
Returns boolean

lock

lock(): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:336
Returns void

moveForward

moveForward(distance: number): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:334
Parameters
- distance: number
Returns void

moveRight

moveRight(distance: number): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:335
Parameters
- distance: number
Returns void

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Event, T, I3JS.PointerLockControls>): void

Inherited from EventDispatcher.removeEventListener
- Defined in lib/threejs-library/types/three/core.ts:789
Removes a listener from an event type.

Type parameters
- T: string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, T, I3JS.PointerLockControls>
  
  The listener that gets removed.
Returns void

unlock

unlock(): void

- Defined in lib/threejs-library/types/three/examples/controls.ts:337
Returns void

Generated using TypeDoc