tecs.gfx.flycamera3d
A free-fly controller turns mouse and keyboard input into a 3D camera pose.
The controller is deliberately a camera tool rather than a character controller. It has no gravity or collision, so render showcases and editor views can move through large scenes without creating physics geometry. Click the left mouse button to enter relative mouse mode, press Tab to release it, and call update from a frame-phase system:
const controller = tecs.gfx.flycamera3d.new(
app.input, app.window, camera,
{moveSpeed = 5, sprintMultiplier = 4}
)
world:addSystem({
name = "game.FlyCamera",
phase = tecs.ecs.phases.Update,
run = function(dt: number)
controller:update(dt)
end,
})WASD moves along the view, Q and E move down and up in world space, and Shift multiplies the speed. The constructor caches physical scancodes, and update allocates nothing.
Module contents
Types
| Type | Kind | Description |
|---|---|---|
Controller | record | Controls one perspective camera with relative mouse and keyboard input. |
Options | type | Defines optional free-fly camera behavior. |
Functions
| Function | Kind | Description |
|---|---|---|
new | function |
Types#
Controllerrecord#
record Controller ...Controls one perspective camera with relative mouse and keyboard input.
Members
| Name | Kind | Description |
|---|---|---|
camera | field | Read-only. |
moveSpeed | field | Caller-writable. |
sprintMultiplier | field | Caller-writable. |
lookSensitivity | field | Caller-writable. |
maxPitch | field | Caller-writable. |
yaw | field | Read-only. |
pitch | field | Read-only. |
captured | field | Read-only. |
setCaptured | method | Requests or releases relative mouse mode. |
update | method | Applies this frame's input to the camera. |
moveSpeedfield#
moveSpeed: numberCaller-writable. Sets ordinary movement speed in world units per second.
sprintMultiplierfield#
sprintMultiplier: numberCaller-writable. Multiplies movement speed while Shift is held.
lookSensitivityfield#
lookSensitivity: numberCaller-writable. Sets radians of rotation per mouse-motion unit.
maxPitchfield#
maxPitch: numberCaller-writable. Limits absolute pitch in radians below pi divided by two.
capturedfield#
captured: booleanRead-only. Reports whether this controller currently owns relative mouse input.
setCapturedmethod#
setCaptured: function(exclusive self: Controller, captured: boolean): booleanRequests or releases relative mouse mode.
Arguments
| Name | Type | Description |
|---|---|---|
exclusive self | Controller | |
captured | boolean | The caller passes true to hide and capture the pointer or false to release it. |
Returns
| Type | Description |
|---|---|
boolean | Returns whether the platform reached the requested state. |
updatemethod#
update: function(exclusive self: Controller, dt: number): nilApplies this frame's input to the camera.
A left click captures the pointer and returns without consuming the absolute motion that produced that click. Tab releases it. While captured, WASD moves along the view, Q and E move vertically, Shift sprints, and relative mouse motion changes yaw and pitch.
Arguments
| Name | Type | Description |
|---|---|---|
exclusive self | Controller | |
dt | number | The caller supplies a non-negative frame duration in seconds. |
Returns
| Type | Description |
|---|---|
nil |
Optionstype#
type Options = {
--- Caller-writable. Sets ordinary movement speed in world units per second
--- and defaults to 5.
moveSpeed: number?,
--- Caller-writable. Multiplies movement speed while Shift is held and
--- defaults to 4.
sprintMultiplier: number?,
--- Caller-writable. Sets radians of rotation per mouse-motion unit and
--- defaults to 0.0025.
lookSensitivity: number?,
--- Caller-writable. Limits absolute pitch in radians and defaults to 89
--- degrees.
maxPitch: number?
}Defines optional free-fly camera behavior.
Functions#
newfunction#
function new(source: input.Input, target: window.Window, camera: Camera3D, options: Options?): ControllerArguments
| Name | Type | Description |
|---|---|---|
source | input.Input | |
target | window.Window | |
camera | Camera3D | |
options | Options? |
Returns
| Type | Description |
|---|---|
Controller |