PointerLockControls: Add .pointerSpeed.

[ChrisCrossCrash]

Related issue: #23513

Description

This PR adds a new mouseSpeed property to PointerLockControls. Changing this property changes the mouse sensitivity for controlling the camera look direction. The PR also adds a new optional options parameter to the constructor for setting mouseSpeed when a new PointerLockControls instance is made.

[WestLangley]

The PR also adds a new optional options parameter to the constructor

We do not have that option in the the other controls, so I'd omit it.

This PR adds a new mouseSpeed property

As implemented in this PR, the units of mouseSpeed are radians per pixel. Don't forget to update the docs.

//

Or, maybe better, implement it like so:

_euler.y -= movementX * 0.002 * mouseSpeed;

In that case, mouseSpeed would be unit-less, and have a default value of 1.

I'd defer to @mrdoob for the choice of parameterization.

[mrdoob]

The PR also adds a new optional options parameter to the constructor

We do not have that option in the the other controls, so I'd omit it.

Agreed.

Or, maybe better, implement it like so:

_euler.y -= movementX * 0.002 * mouseSpeed;

In that case, mouseSpeed would be unit-less, and have a default value of 1.

Agreed too.

[mrdoob]

I think I can make these changes directly here... 🤔

[mrdoob]

One more issue... Should it be pointerSpeed instead of mouseSpeed?

[WestLangley]

Should it be pointerSpeed instead of mouseSpeed?

Maybe trackingSpeed? That is the term macOS uses for the mouse sensitivity parameter.

[Mugen87]

I vote for pointerSpeed. Fits best to PointerLockControls.

[ChrisCrossCrash]

These are all great ideas! I've added two more commits.

The first renames mouseSpeed to pointerSpeed. I tend to agree with @Mugen87 that it's a nice fit because it goes well with PointerLockControls. I can change it if you prefer.

The second commit adds documentation for the pointerSpeed property.

Please let me know if there's anything else you would like me to change, or feel free to make your own changes.

[mrdoob]

Thanks!