[page:EventDispatcher] →

# 指针锁定控制器（[name]）

该类的实现是基于[link:https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API Pointer Lock API]的。 对于第一人称3D游戏来说， [name] 是一个非常完美的选择。

## 进口

[name] 是一个附加组件，必须显式导入。 请参阅 [link:#manual/introduction/Installation Installation / Addons].

`import { PointerLockControls } from 'three/addons/controls/PointerLockControls.js';`

## 代码示例

`const controls = new PointerLockControls( camera, document.body ); // add event listener to show/hide a UI (e.g. the game's menu) controls.addEventListener( 'lock', function () { menu.style.display = 'none'; } ); controls.addEventListener( 'unlock', function () { menu.style.display = 'block'; } );`

## 例子

[example:misc_controls_pointerlock misc / controls / pointerlock ]

## 构造函数

### [name]( [param:Camera camera], [param:HTMLDOMElement domElement] )

[page:Camera camera]: 渲染场景的摄像机。

[page:HTMLDOMElement domElement]: 用于事件监听的HTML元素。

创建一个新的 [name] 实例。

## 事件

### change

当用户移动鼠标时触发。

### lock

当指针状态为 “locked” （即鼠标被捕获）时触发。

### unlock

当指针状态为 “unlocked” （即鼠标不再被捕获）时触发。

## 属性

### [property:HTMLDOMElement domElement]

该 HTMLDOMElement 用于监听鼠标/触摸事件，该属性必须在构造函数中传入。在此处改变它将不会设置新的事件监听。

### [property:Boolean isLocked]

控制器是否被锁定。

### [property:Float maxPolarAngle]

摄像机的俯仰角上限限制。范围为0到Math.PI弧度之间。默认值为Math.PI。

### [property:Float minPolarAngle]

摄像机的俯仰角下限限制。范围为0到Math.PI弧度之间。默认值为0。

## Methods

共有方法请参见其基类[page:EventDispatcher]。

### [method:undefined connect] ()

添加控制器的事件监听。

### [method:undefined disconnect] ()

移除控制器的事件监听。

### [method:Vector3 getDirection] ( [param:Vector3 target] )

[page:Vector3 target]: 目标向量。

返回摄像机的观看方向。

### [method:undefined lock] ()

激活指针锁定。

### [method:undefined moveForward] ( [param:Number distance] )

[page:Number distance]: 距离（区分正负）。

平行于xz平面，向前移动摄像机。假定camera.up是y朝上。

### [method:undefined moveRight] ( [param:Number distance] )

[page:Number distance]: 距离（区分正负）。

平行于xz平面，向侧面移动摄像机。

### [method:undefined unlock] ()

退出指针锁定。

## 源代码

[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/PointerLockControls.js examples/jsm/controls/PointerLockControls.js]