Documentation / scene / FPSCameraController
Class: FPSCameraController
Defined in: libs/scene/src/camera/fps.ts:36
FPS camera controller
Extends
Constructors
Constructor
new FPSCameraController(
options?):FPSCameraController
Defined in: libs/scene/src/camera/fps.ts:61
Creates an instance of FPSCameraController
Parameters
options?
The creation options
Returns
FPSCameraController
Overrides
BaseCameraController.constructor
Accessors
enabled
Get Signature
get enabled():
boolean
Defined in: libs/scene/src/camera/base.ts:224
Check if the controller is enabled.
Returns
boolean
Set Signature
set enabled(
value):void
Defined in: libs/scene/src/camera/base.ts:227
Parameters
value
boolean
Returns
void
Inherited from
Methods
_getCamera()
_getCamera():
Camera
Defined in: libs/scene/src/camera/base.ts:204
Get the attached camera.
Returns
The current camera or null if none is attached.
Inherited from
BaseCameraController._getCamera
_setCamera()
_setCamera(
camera):void
Defined in: libs/scene/src/camera/base.ts:215
Attach a camera to the controller.
If the camera changes, the controller will call reset() so subclasses can reinitialize state that depends on the camera.
Parameters
camera
The camera to attach.
Returns
void
Inherited from
BaseCameraController._setCamera
lookAt()
lookAt(
from,to,up):void
Defined in: libs/scene/src/camera/base.ts:237
Convenience method that delegates to camera.lookAt.
Parameters
from
Vector3
Camera position.
to
Vector3
Look-at target.
up
Vector3
Up direction.
Returns
void
Inherited from
onMouseDown()
onMouseDown(
evt):boolean
Defined in: libs/scene/src/camera/base.ts:253
Handle pointer down (mouse/touch/pen) events.
Parameters
evt
The pointer event.
Returns
boolean
true if handled and should stop further processing; otherwise false.
Inherited from
BaseCameraController.onMouseDown
onMouseUp()
onMouseUp(
evt):boolean
Defined in: libs/scene/src/camera/base.ts:262
Handle pointer up events.
Parameters
evt
The pointer event.
Returns
boolean
true if handled; otherwise false.
Inherited from
BaseCameraController.onMouseUp
onMouseWheel()
onMouseWheel(
evt):boolean
Defined in: libs/scene/src/camera/base.ts:273
Handle mouse wheel (scroll) events.
Typical usage: zoom/dolly control, FOV adjustments.
Parameters
evt
The wheel event.
Returns
boolean
true if handled; otherwise false.
Inherited from
BaseCameraController.onMouseWheel
onMouseMove()
onMouseMove(
evt):boolean
Defined in: libs/scene/src/camera/base.ts:284
Handle pointer move events.
Typical usage: orbit, pan, or look controls based on button/modifier state.
Parameters
evt
The pointer event.
Returns
boolean
true if handled; otherwise false.
Inherited from
BaseCameraController.onMouseMove
onKeyDown()
onKeyDown(
evt):boolean
Defined in: libs/scene/src/camera/base.ts:295
Handle key down events.
Typical usage: WASD navigation, modifiers for speed, toggling modes.
Parameters
evt
The keyboard event.
Returns
boolean
true if handled; otherwise false.
Inherited from
BaseCameraController.onKeyDown
onKeyUp()
onKeyUp(
evt):boolean
Defined in: libs/scene/src/camera/base.ts:304
Handle key up events.
Parameters
evt
The keyboard event.
Returns
boolean
true if handled; otherwise false.
Inherited from
update()
update():
void
Defined in: libs/scene/src/camera/base.ts:317
Per-frame update.
Subclasses should override this to:
- Integrate velocities/accelerations and apply damping.
- Smoothly interpolate camera transforms.
- Clamp angles/distances/FOV, etc.
Called once per frame by the owning system.
Returns
void
Inherited from
_onMouseWheel()
protected_onMouseWheel(_evt):boolean
Defined in: libs/scene/src/camera/base.ts:345
Mouse wheel handler for subclasses to override.
Parameters
_evt
Wheel event.
Returns
boolean
true if handled; otherwise false.
Inherited from
BaseCameraController._onMouseWheel
reset()
reset():
void
Defined in: libs/scene/src/camera/fps.ts:84
Reset the controller's internal state.
Called automatically when a camera is attached via _setCamera. Subclasses should override this to reset accumulators, velocities, targets, etc.
Returns
void
Overrides
_onMouseDown()
protected_onMouseDown(evt):boolean
Defined in: libs/scene/src/camera/fps.ts:99
Mouse down event handler
Parameters
evt
Returns
boolean
Boolean value indices whether this event was handled
Overrides
BaseCameraController._onMouseDown
_onMouseUp()
protected_onMouseUp(evt):boolean
Defined in: libs/scene/src/camera/fps.ts:112
Pointer up handler for subclasses to override.
Parameters
evt
Pointer event.
Returns
boolean
true if handled; otherwise false.
Overrides
BaseCameraController._onMouseUp
_onMouseMove()
protected_onMouseMove(evt):boolean
Defined in: libs/scene/src/camera/fps.ts:123
Pointer move handler for subclasses to override.
Parameters
evt
Pointer event.
Returns
boolean
true if handled; otherwise false.
Overrides
BaseCameraController._onMouseMove
_onKeyDown()
protected_onKeyDown(evt):boolean
Defined in: libs/scene/src/camera/fps.ts:169
Key down handler for subclasses to override.
Parameters
evt
Keyboard event.
Returns
boolean
true if handled; otherwise false.
Overrides
BaseCameraController._onKeyDown
_onKeyUp()
protected_onKeyUp(evt):boolean
Defined in: libs/scene/src/camera/fps.ts:198
Key up handler for subclasses to override.
Parameters
evt
Keyboard event.
Returns
boolean
true if handled; otherwise false.
Overrides
setOptions()
setOptions(
opt?):void
Defined in: libs/scene/src/camera/fps.ts:227
Set options
Parameters
opt?
options
Returns
void
_onUpdate()
protected_onUpdate():void
Defined in: libs/scene/src/camera/fps.ts:235
Per-frame update handler for subclasses to override.
Returns
void