📄 `FirstPersonControls.js`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	13
🧱 Classes	1
📦 Imports	4
📊 Variables & Constants	10

📚 Table of Contents¶

Imports
Variables & Constants
Functions
Classes

🛠️ File Location:¶

📂 examples/jsm/controls/FirstPersonControls.js

📦 Imports¶

Name	Source
`Controls`	`three`
`MathUtils`	`three`
`Spherical`	`three`
`Vector3`	`three`

Variables & Constants¶

Name	Type	Kind	Value	Exported
`_lookDirection`	`any`	let/var	`new Vector3()`	✗
`_spherical`	`any`	let/var	`new Spherical()`	✗
`_target`	`any`	let/var	`new Vector3()`	✗
`_targetPosition`	`any`	let/var	`new Vector3()`	✗
`heightDelta`	`number`	let/var	`y - this.heightMin`	✗
`actualMoveSpeed`	`number`	let/var	`delta * this.movementSpeed`	✗
`actualLookSpeed`	`number`	let/var	`delta * this.lookSpeed`	✗
`verticalLookRatio`	`number`	let/var	`1`	✗
`position`	`any`	let/var	`this.object.position`	✗
`quaternion`	`any`	let/var	`this.object.quaternion`	✗

Functions¶

`FirstPersonControls.connect(element: any): void`¶

Parameters:

element any

Returns: void

Calls:

super.connect
window.addEventListener
this.domElement.addEventListener

Code

connect( element ) {

        super.connect( element );

        window.addEventListener( 'keydown', this._onKeyDown );
        window.addEventListener( 'keyup', this._onKeyUp );

        this.domElement.addEventListener( 'pointermove', this._onPointerMove );
        this.domElement.addEventListener( 'pointerdown', this._onPointerDown );
        this.domElement.addEventListener( 'pointerup', this._onPointerUp );
        this.domElement.addEventListener( 'contextmenu', this._onContextMenu );

    }

`FirstPersonControls.disconnect(): void`¶

Returns: void

Calls:

window.removeEventListener
this.domElement.removeEventListener

Code

disconnect() {

        window.removeEventListener( 'keydown', this._onKeyDown );
        window.removeEventListener( 'keyup', this._onKeyUp );

        this.domElement.removeEventListener( 'pointerdown', this._onPointerMove );
        this.domElement.removeEventListener( 'pointermove', this._onPointerDown );
        this.domElement.removeEventListener( 'pointerup', this._onPointerUp );
        this.domElement.removeEventListener( 'contextmenu', this._onContextMenu );

    }

`FirstPersonControls.dispose(): void`¶

Returns: void

Calls:

this.disconnect

Code

dispose() {

        this.disconnect();

    }

`FirstPersonControls.handleResize(): void`¶

JSDoc:

/**
     * Must be called if the application window is resized.
     */

Returns: void

Code

handleResize() {

        if ( this.domElement === document ) {

            this._viewHalfX = window.innerWidth / 2;
            this._viewHalfY = window.innerHeight / 2;

        } else {

            this._viewHalfX = this.domElement.offsetWidth / 2;
            this._viewHalfY = this.domElement.offsetHeight / 2;

        }

    }

`FirstPersonControls.lookAt(x: any, y: number, z: number): FirstPersonControls`¶

JSDoc:

/**
     * Rotates the camera towards the defined target position.
     *
     * @param {number|Vector3} x - The x coordinate of the target position or alternatively a vector representing the target position.
     * @param {number} y - The y coordinate of the target position.
     * @param {number} z - The z coordinate of the target position.
     * @return {FirstPersonControls} A reference to this controls.
     */

Parameters:

x any
y number
z number

Returns: FirstPersonControls

Calls:

_target.copy
_target.set
this.object.lookAt
this._setOrientation

Code

lookAt( x, y, z ) {

        if ( x.isVector3 ) {

            _target.copy( x );

        } else {

            _target.set( x, y, z );

        }

        this.object.lookAt( _target );

        this._setOrientation();

        return this;

    }

`FirstPersonControls.update(delta: any): void`¶

Parameters:

delta any

Returns: void

Calls:

MathUtils.clamp
this.object.translateZ
this.object.translateX
this.object.translateY
Math.max
Math.min
MathUtils.degToRad
MathUtils.mapLinear
_targetPosition.setFromSphericalCoords( 1, phi, theta ).add
this.object.lookAt

Code

update( delta ) {

        if ( this.enabled === false ) return;

        if ( this.heightSpeed ) {

            const y = MathUtils.clamp( this.object.position.y, this.heightMin, this.heightMax );
            const heightDelta = y - this.heightMin;

            this._autoSpeedFactor = delta * ( heightDelta * this.heightCoef );

        } else {

            this._autoSpeedFactor = 0.0;

        }

        const actualMoveSpeed = delta * this.movementSpeed;

        if ( this._moveForward || ( this.autoForward && ! this._moveBackward ) ) this.object.translateZ( - ( actualMoveSpeed + this._autoSpeedFactor ) );
        if ( this._moveBackward ) this.object.translateZ( actualMoveSpeed );

        if ( this._moveLeft ) this.object.translateX( - actualMoveSpeed );
        if ( this._moveRight ) this.object.translateX( actualMoveSpeed );

        if ( this._moveUp ) this.object.translateY( actualMoveSpeed );
        if ( this._moveDown ) this.object.translateY( - actualMoveSpeed );

        let actualLookSpeed = delta * this.lookSpeed;

        if ( ! this.activeLook ) {

            actualLookSpeed = 0;

        }

        let verticalLookRatio = 1;

        if ( this.constrainVertical ) {

            verticalLookRatio = Math.PI / ( this.verticalMax - this.verticalMin );

        }

        this._lon -= this._pointerX * actualLookSpeed;
        if ( this.lookVertical ) this._lat -= this._pointerY * actualLookSpeed * verticalLookRatio;

        this._lat = Math.max( - 85, Math.min( 85, this._lat ) );

        let phi = MathUtils.degToRad( 90 - this._lat );
        const theta = MathUtils.degToRad( this._lon );

        if ( this.constrainVertical ) {

            phi = MathUtils.mapLinear( phi, 0, Math.PI, this.verticalMin, this.verticalMax );

        }

        const position = this.object.position;

        _targetPosition.setFromSphericalCoords( 1, phi, theta ).add( position );

        this.object.lookAt( _targetPosition );

    }

`FirstPersonControls._setOrientation(): void`¶

Returns: void

Calls:

_lookDirection.set( 0, 0, - 1 ).applyQuaternion
_spherical.setFromVector3
MathUtils.radToDeg

Code

_setOrientation() {

        const quaternion = this.object.quaternion;

        _lookDirection.set( 0, 0, - 1 ).applyQuaternion( quaternion );
        _spherical.setFromVector3( _lookDirection );

        this._lat = 90 - MathUtils.radToDeg( _spherical.phi );
        this._lon = MathUtils.radToDeg( _spherical.theta );

    }

`onPointerDown(event: any): void`¶

Parameters:

event any

Returns: void

Calls:

this.domElement.focus

Code

function onPointerDown( event ) {

    if ( this.domElement !== document ) {

        this.domElement.focus();

    }

    if ( this.activeLook ) {

        switch ( event.button ) {

            case 0: this._moveForward = true; break;
            case 2: this._moveBackward = true; break;

        }

    }

    this.mouseDragOn = true;

}

`onPointerUp(event: any): void`¶

Parameters:

event any

Returns: void

Code

function onPointerUp( event ) {

    if ( this.activeLook ) {

        switch ( event.button ) {

            case 0: this._moveForward = false; break;
            case 2: this._moveBackward = false; break;

        }

    }

    this.mouseDragOn = false;

}

`onPointerMove(event: any): void`¶

Parameters:

event any

Returns: void

Code

function onPointerMove( event ) {

    if ( this.domElement === document ) {

        this._pointerX = event.pageX - this._viewHalfX;
        this._pointerY = event.pageY - this._viewHalfY;

    } else {

        this._pointerX = event.pageX - this.domElement.offsetLeft - this._viewHalfX;
        this._pointerY = event.pageY - this.domElement.offsetTop - this._viewHalfY;

    }

}

`onKeyDown(event: any): void`¶

Parameters:

event any

Returns: void

Code

function onKeyDown( event ) {

    switch ( event.code ) {

        case 'ArrowUp':
        case 'KeyW': this._moveForward = true; break;

        case 'ArrowLeft':
        case 'KeyA': this._moveLeft = true; break;

        case 'ArrowDown':
        case 'KeyS': this._moveBackward = true; break;

        case 'ArrowRight':
        case 'KeyD': this._moveRight = true; break;

        case 'KeyR': this._moveUp = true; break;
        case 'KeyF': this._moveDown = true; break;

    }

}

`onKeyUp(event: any): void`¶

Parameters:

event any

Returns: void

Code

function onKeyUp( event ) {

    switch ( event.code ) {

        case 'ArrowUp':
        case 'KeyW': this._moveForward = false; break;

        case 'ArrowLeft':
        case 'KeyA': this._moveLeft = false; break;

        case 'ArrowDown':
        case 'KeyS': this._moveBackward = false; break;

        case 'ArrowRight':
        case 'KeyD': this._moveRight = false; break;

        case 'KeyR': this._moveUp = false; break;
        case 'KeyF': this._moveDown = false; break;

    }

}

`onContextMenu(event: any): void`¶

Parameters:

event any

Returns: void

Calls:

event.preventDefault

Code

function onContextMenu( event ) {

    if ( this.enabled === false ) return;

    event.preventDefault();

}

Classes¶