Renderer · interface

ThirdPersonCameraOptions

Explained in Hello world.

interface ThirdPersonCameraOptions
import type { ThirdPersonCameraOptions } from '@driftengine/core';

Properties

NameTypeDescription
boomDistancenumber
boomRadiusnumber
boomMinDistancenumber
positionLambdanumber
fovLambdanumber
pitchMinnumber
pitchMaxnumber
initialPitchnumber
initialFovYDegnumber
boomTimingreadonlyoptionalPartial<BoomTiming>How fast the arm may change length. Absent keeps the numbers every rig had.
More

The defaults are written for an arm of several metres, where the speed ceilings bind and the obstruction is a railing sweeping across for a few frames. On a short arm neither ceiling binds, only the damping acts, and easing into a wall is the wrong trade — see BoomTiming, which carries the measurement and the immediate-retract spelling.

dampRollreadonlyoptionalbooleanWhether the rig damps the roll it is handed. Absent means yes, which every rig had.
More

False is for a caller that has already damped it, and that is not a niche: a consumer with a comfort setting on roll applies the same value to a first-person view, so a roll damped again here is damped twice and the setting stops meaning what it is asserted to mean. The rig's own damping exists so a subject snapping between surfaces cannot snap the view; a caller that has solved that itself is not asking for it twice.