Class FpvCtrls

This class integrates three.js PointerLockControls directly in the engine's render loop, supporting runtime updates and dynamic enabling/disabling.

Index

Methods

create disable dispose enable get isEnabled isLocked lock moveForward moveRight moveUp set unlock use

Methods

create

create(): void

Creates three.js PointerLockControls.

Returns void

disable

disable(): void

Disables three.js PointerLockControls.

Returns void

dispose

dispose(): void

Disposes three.js PointerLockControls and cleans up their runtime resources.

Returns void

enable

enable(): void

Enables three.js PointerLockControls for the current camera.

Returns void

get

get(): Partial<FpvCtrlsCfg>

Returns the parameters currently used by three.js PointerLockControls.

Returns Partial<FpvCtrlsCfg>
A snapshot of the mutable first-person control settings.

isEnabled

isEnabled(): boolean

Returns whether three.js PointerLockControls are enabled.

Returns boolean

isLocked

isLocked(): boolean

Returns whether three.js PointerLockControls are currently locked.

Returns boolean

lock

lock(): void

Locks three.js PointerLockControls and starts pointer-look interaction.

Returns void

moveForward

moveForward(distance: number): void
Moves the controlled camera forward.
Parameters
- distance: number
  Distance to move in world units.
Returns void

moveRight

moveRight(distance: number): void
Moves the controlled camera to the right.
Parameters
- distance: number
  Distance to move in world units.
Returns void

moveUp

moveUp(distance: number): void
Moves the controlled camera up.
Parameters
- distance: number
  Distance to move in world units.
Returns void

set

set(params: Partial<FpvCtrlsCfg>): void
Updates one or more three.js PointerLockControls properties. FpvCtrls must be enabled.
Parameters
- params: Partial<FpvCtrlsCfg>
  Object containing any subset of first-person control parameters.
Returns void

unlock

unlock(): void

Unlocks three.js PointerLockControls and stops pointer-look interaction.

Returns void

use

use(extension: (fpvctrls: FpvCtrls) => void): void
Registers and executes a low-level extension function with access to the public FpvCtrls API.
Parameters
- extension: (fpvctrls: FpvCtrls) => void
  Function that receives the current FpvCtrls instance and can use its public members and methods.
Returns void

Remarks
This method is intended for advanced custom integrations where developers need direct access to the FpvCtrls instance. The extension is executed once immediately when use() is called.