diff --git a/changelog.d/1787-cockpit-subject-camera-hud.md b/changelog.d/1787-cockpit-subject-camera-hud.md index eb1b463dd4..9231f3578b 100644 --- a/changelog.d/1787-cockpit-subject-camera-hud.md +++ b/changelog.d/1787-cockpit-subject-camera-hud.md @@ -1,10 +1,10 @@ -- Keep an application's Cockpit subject steady: a height its entry frame gave - holds while the floor is still cold, so the view no longer ends after the - floor wait; the camera keeps up when the browser draws few frames (at 5 a - second, one updated every frame fell 700 m behind a 30 m/s subject in a - minute); a provider's Live Signals rows change where they stand, their tone - included, and rows it drops leave before new ones come in, so a changing ETA - or a replaced row no longer pushes a steady warning off the list; progress - labels give CJK, kana and Hangul names the width they need; and labels, - entry face and look keep the words checked at registration when a later - read fails (German, @gekh, #1787). +- Keep an application's Cockpit subject steady. A subject whose entry frame + gives a height stands there until a later frame or the floor under it gives + another, so the view no longer ends while the floor loads. The camera keeps + up when the browser draws few frames: at 5 frames a second it used to fall + 700 m behind a 30 m/s subject in a minute. A provider's Live Signals rows + change where they stand, their tone included, and rows it drops leave + before new ones come in, so a changing ETA or a replaced row no longer + pushes a steady warning off the list. Progress labels give CJK, kana and + Hangul names the width they need. Labels, entry face and look keep their + last good words when a later read fails (German, @gekh, #1787). diff --git a/docs/CURRENT-STATE.md b/docs/CURRENT-STATE.md index 1a40abe9c3..1adff6c421 100644 --- a/docs/CURRENT-STATE.md +++ b/docs/CURRENT-STATE.md @@ -2743,8 +2743,8 @@ first in that order decides alone: when its gate is shut there is no entry rather than the next subject's. A frame places the eye `eye.upM` above `heightM` (the shared floor where the -frame gives none, or, while that floor is cold, the last height a frame gave, -the entry frame's included; with neither, the camera stays where it is and the HUD reads ACQUIRING SURFACE for +frame gives none, or, while that floor is cold, the last height the eye stood +at, a frame's or the floor's, at first the entry frame's; with neither, the camera stays where it is and the HUD reads ACQUIRING SURFACE for at most `COCKPIT_GROUND_WAIT_TIMEOUT_MS`, after which the view ends and the subject is released: no height stands in for a floor never read), slews toward `headingDeg` at the provider's rate, and may turn off the floor clamps (`groundClamp: false`, for a subject inside a @@ -2754,19 +2754,21 @@ exact, since an inertial anchor runs on at the frame's speed); `cameraIntervalMs camera every rendered frame. Each update turns the view, eases its lift and moves an inertial anchor by the time since the last one, at most a second past the interval (`cockpitSubjectStepSec`); an exact anchor stands where the frame -is. The update that first places the camera (after entry or a floor wait) -stands its anchor on the subject. A frame that is null, malformed or for another +is. The first update after entry (after any floor wait) stands its anchor on +the subject, as does the first to replace the entry frame's height with +another. A frame that is null, malformed or for another subject ends the view (`restoreTracking: false`), as an aircraft tracked meanwhile and the provider's layer turning off do; the exit control asks the provider to restore its subject. The generic HUD shows the provider's kicker, title, meta line, speed with its unit and tag, readout cards, always-visible source rows, banner, route card and Live Signals rows (each changes in place, -its tone included, and keeps the time it first appeared; rows the view no -longer lists leave before new ones come in), a veil that darkens the +its tone included, and keeps its time while it stays listed; one pushed off +comes back as the newest row; rows the view no longer lists leave before new +ones come in), a veil that darkens the picture under the HUD (with passing light streaks, which stand still under reduced motion), arrow-key look-around when the provider asks for it, and a progress line along the bottom edge (`src/cockpitProgress.js`: close ticks merge, -labels never overlap and are sized for CJK and emoji glyphs). Core translates none of the provider's text: a host +labels never overlap and are sized for CJK, kana and Hangul). Core translates none of the provider's text: a host words it for the page's language (`gods-eye-view/i18n`: `getLocale`, `onLocaleChange`). Its entry face, labels and look may be functions, read again when they are shown and on a change of language, as the diff --git a/src/cockpitProgress.js b/src/cockpitProgress.js index 6d31cdfe88..1761829798 100644 --- a/src/cockpitProgress.js +++ b/src/cockpitProgress.js @@ -30,31 +30,40 @@ const TONE_RANK = Object.freeze([ const stronger = (a, b) => TONE_RANK.indexOf(b) > TONE_RANK.indexOf(a) ? b : a; -/** - * Full-width glyphs in the BMP (CJK, kana, Hangul, full-width forms): about - * 1 em each. Astral ones (CJK extensions, emoji) are wide enough as any - * other two UTF-16 units (lineWidthPx). - */ -const WIDE_GLYPH = - /[\u1100-\u115F\u2E80-\u303E\u3041-\u33FF\u3400-\u4DBF\u4E00-\u9FFF\uA960-\uA97F\uAC00-\uD7A3\uF900-\uFAFF\uFE30-\uFE4F\uFF00-\uFF60\uFFE0-\uFFE6]/; +/** Full-width glyphs in the BMP: CJK, kana, Hangul, full-width forms. */ +const WIDE_GLYPHS = + /[\u1100-\u115F\u2E80-\u303E\u3041-\u33FF\u3400-\u4DBF\u4E00-\u9FFF\uA960-\uA97F\uAC00-\uD7A3\uF900-\uFAFF\uFE30-\uFE4F\uFF00-\uFF60\uFFE0-\uFFE6]/g; + +/** What a full-width glyph and any other UTF-16 unit take in a title (px). */ +const TITLE_PX = Object.freeze({ wide: 10.6, narrow: 6.4 }); +/** The same in a detail line (px). */ +const DETAIL_PX = Object.freeze({ + wide: 10 / 1.2 + 0.6, + narrow: 5.8 / 1.2 + 0.6, +}); /** * One line's width (px) in `.cockpit-progress-label` type (cockpitSubject.css: - * 10 px, 0.06 em spacing): 10.6 px a full-width glyph and 6.4 px each UTF-16 - * unit of any other, so an emoji or other astral glyph gets 12.8 px. + * 10 px, 0.06 em spacing) at the glyph widths `px`: about 1 em a full-width + * glyph and 0.58 em each UTF-16 unit of any other, so an astral glyph (an + * emoji, a CJK extension) counts as two and an emoji in the BMP (☕) as one, + * narrower than it is drawn. The detail line's `` is 1/1.2 the size; + * the 0.6 px spacing it inherits is not scaled. */ -function lineWidthPx(line) { - let wide = 0; - let narrow = 0; - for (const glyph of String(line ?? '')) - if (WIDE_GLYPH.test(glyph)) wide += 1; - else narrow += glyph.length; - return wide * 10.6 + narrow * 6.4; +function lineWidthPx(line, px) { + const text = String(line ?? ''); + const wide = text.match(WIDE_GLYPHS)?.length ?? 0; + return wide * px.wide + (text.length - wide) * px.narrow; } -/** A label's width estimate (px): its longer line and 8 px of padding. */ +/** A label's width estimate (px): its wider line and 8 px of padding. */ export function estimateProgressLabelPx(label) { - return Math.max(lineWidthPx(label?.text), lineWidthPx(label?.detail)) + 8; + return ( + Math.max( + lineWidthPx(label?.text, TITLE_PX), + lineWidthPx(label?.detail, DETAIL_PX), + ) + 8 + ); } /** diff --git a/src/cockpitProgress.test.mjs b/src/cockpitProgress.test.mjs index e1835caea8..04920ccd68 100644 --- a/src/cockpitProgress.test.mjs +++ b/src/cockpitProgress.test.mjs @@ -181,3 +181,23 @@ test('emoji and other astral glyphs in a progress label get at least 1 em each', ); } }); + +test('a label is as wide as its wider line, its smaller detail line included', () => { + // The detail line's is 1/1.2 of 10 px; its 0.6 px spacing is not. + const detailEmPx = 10 / 1.2 + 0.6; + const detail = '中央駅前'; // 4 full-width glyphs + const givenPx = estimateProgressLabelPx({ text: 'GATE', detail }); + assert.ok( + givenPx > estimateProgressLabelPx({ text: 'GATE', detail: '' }), + 'the wider detail line widens the label', + ); + assert.ok( + givenPx >= detail.length * detailEmPx + 8, + `${givenPx} px given, about ${detail.length * detailEmPx} px needed`, + ); + // A line takes less room as the smaller detail than as the title. + assert.ok( + estimateProgressLabelPx({ text: 'A', detail: 'CENTRAL STATION' }) < + estimateProgressLabelPx({ text: 'CENTRAL STATION', detail: '' }), + ); +}); diff --git a/src/cockpitSubjectProviders.js b/src/cockpitSubjectProviders.js index 94def7c828..fa0b4deffb 100644 --- a/src/cockpitSubjectProviders.js +++ b/src/cockpitSubjectProviders.js @@ -117,18 +117,23 @@ function lookOf(raw) { }); } +/** Promises worded members gave, each one's rejection caught once. */ +const caughtWords = new WeakSet(); + /** - * A worded member's `value` normalized: the value, or what it returns when it - * is a function called on `provider` (so it can follow the page's language); - * null when it is malformed or a read throws. Reading what it gives runs - * provider code too (a getter), so it is guarded as the call is; a promise is - * malformed, and its rejection is caught rather than left unhandled. + * A worded member as `read()` gives it, normalized: called on `provider` + * when it is a function (so it can follow the page's language); null when it + * is malformed (a promise too) or provider code throws. */ -function worded(provider, value, normalize) { +function worded(provider, read, normalize) { try { + const value = read(); const words = typeof value === 'function' ? value.call(provider) : value; if (typeof words?.then === 'function') { - Promise.resolve(words).catch(() => {}); + if (!caughtWords.has(words)) { + caughtWords.add(words); + Promise.resolve(words).catch(() => {}); + } return null; } return normalize(words) ?? null; @@ -137,16 +142,6 @@ function worded(provider, value, normalize) { } } -/** A provider's worded member `key` as it reads now (see `worded`). */ -function wordedNow(provider, key, normalize) { - try { - return worded(provider, provider[key], normalize); - } catch { - // A getter for the member threw. - return null; - } -} - /** A provider's name in a warning: its kind, cut, or its place in the list. */ function providerName(provider, order) { try { @@ -185,13 +180,13 @@ function refusal(provider, kinds) { * @returns {{face: object, labels: object, look: ?object}|string} */ function checkedWords(provider) { - const face = wordedNow(provider, 'entryFace', faceOf); + const face = worded(provider, () => provider.entryFace, faceOf); if (!face) return 'malformed entry face'; - const labels = wordedNow(provider, 'labels', labelsOf); + const labels = worded(provider, () => provider.labels, labelsOf); if (!labels) return 'labels need view, exit and exitText'; const lookValue = provider.look; if (lookValue == null) return { face, labels, look: null }; - const look = worded(provider, lookValue, lookOf); + const look = worded(provider, () => lookValue, lookOf); return look ? { face, labels, look } : 'look needs an aheadLabel'; } @@ -273,8 +268,6 @@ export function cockpitSubjectProviders( * seeded with the worded members `checkedWords` read. */ function keptProvider(provider, order, words) { - // Worded members are read again on each use (see above); the last good - // read stands in for one that is malformed or throws. let { face, labels, look } = words; // Look stays on or off, at its rest pitch, as read at registration. const restPitchDeg = look?.restPitchDeg ?? 0; @@ -284,16 +277,16 @@ function keptProvider(provider, order, words) { priority: finite(provider.priority) ? provider.priority : 0, order, get entryFace() { - face = wordedNow(provider, 'entryFace', faceOf) ?? face; + face = worded(provider, () => provider.entryFace, faceOf) ?? face; return face; }, get labels() { - labels = wordedNow(provider, 'labels', labelsOf) ?? labels; + labels = worded(provider, () => provider.labels, labelsOf) ?? labels; return labels; }, get look() { if (!look) return null; - const now = wordedNow(provider, 'look', lookOf); + const now = worded(provider, () => provider.look, lookOf); if (now) look = Object.freeze({ restPitchDeg, aheadLabel: now.aheadLabel }); return look; @@ -363,11 +356,11 @@ function candidateOf(raw) { * a position that is not finite, an eye with no valid `upM` (0..1000), or a * read of it that throws (a getter runs provider code). * A `heightM` that is not finite or lies outside - * COCKPIT_SUBJECT_MIN_HEIGHT_M..COCKPIT_SUBJECT_MAX_HEIGHT_M reads as null: - * the eye then stands on the shared floor, or at the last height a frame gave, - * the entry frame's included, while that is cold. The anchor is `'inertial'` by default for a frame with a valid - * speed, and `'exact'` when asked for or with no speed. An id is compared - * with `heldId` trimmed, as `cockpitSubjectCandidate` trims it. + * COCKPIT_SUBJECT_MIN_HEIGHT_M..COCKPIT_SUBJECT_MAX_HEIGHT_M reads as null, + * for the eye to stand on the shared floor (ui/cockpitCamera.js). The anchor + * is `'inertial'` by default for a frame with a valid speed, and `'exact'` + * when asked for or with no speed. An id is compared with `heldId` trimmed, + * as `cockpitSubjectCandidate` trims it. * @param {unknown} raw What `read()` returned. * @param {string} heldId The subject the view holds. * @returns {object|null} `{id, name, latitude, longitude, heightM, headingDeg, @@ -384,51 +377,57 @@ export function cockpitSubjectFrame(raw, heldId) { } function frameOf(raw, heldId) { - if (!isObject(raw) || typeof raw.id !== 'string' || raw.id.trim() !== heldId) - return null; - const latitude = raw.latitude; - const longitude = raw.longitude; + if (!isObject(raw)) return null; + // Each field read once: a getter on the frame runs provider code. + const { + id, + name, + latitude, + longitude, + heightM, + headingDeg: rawHeadingDeg, + courseDeg, + speedMps: rawSpeedMps, + stale, + groundClamp, + anchor, + eye: rawEye, + } = raw; + if (typeof id !== 'string' || id.trim() !== heldId) return null; if (!finite(latitude) || !finite(longitude) || Math.abs(latitude) > 90) return null; - const eye = isObject(raw.eye) ? raw.eye : null; - if (!eye || !finite(eye.upM) || eye.upM < 0 || eye.upM > 1000) return null; + if (!isObject(rawEye)) return null; + const { upM, forwardM, pitchDeg, minClearanceM } = rawEye; + if (!finite(upM) || upM < 0 || upM > 1000) return null; const heading = (value) => finite(value) ? ((value % 360) + 360) % 360 : null; - const headingDeg = heading(raw.headingDeg); - // Each read once: a getter on the frame runs provider code. - const rawSpeedMps = raw.speedMps; + const headingDeg = heading(rawHeadingDeg); const speedMps = finite(rawSpeedMps) && rawSpeedMps >= 0 ? rawSpeedMps : null; - const rawHeightM = raw.heightM; return { id: heldId, - name: cockpitSubjectText(raw.name, 64) || cockpitSubjectText(heldId, 64), + name: cockpitSubjectText(name, 64) || cockpitSubjectText(heldId, 64), latitude, longitude: ((((longitude + 180) % 360) + 360) % 360) - 180, heightM: - finite(rawHeightM) && - rawHeightM >= COCKPIT_SUBJECT_MIN_HEIGHT_M && - rawHeightM <= COCKPIT_SUBJECT_MAX_HEIGHT_M - ? rawHeightM + finite(heightM) && + heightM >= COCKPIT_SUBJECT_MIN_HEIGHT_M && + heightM <= COCKPIT_SUBJECT_MAX_HEIGHT_M + ? heightM : null, headingDeg, - courseDeg: heading(raw.courseDeg) ?? headingDeg, + courseDeg: heading(courseDeg) ?? headingDeg, speedMps, - stale: raw.stale === true, - groundClamp: raw.groundClamp !== false, + stale: stale === true, + groundClamp: groundClamp !== false, // An inertial anchor runs on at the frame's speed; with none it would // close on a moving subject at the correction's floor and fall behind. - anchor: raw.anchor === 'exact' || speedMps === null ? 'exact' : 'inertial', + anchor: anchor === 'exact' || speedMps === null ? 'exact' : 'inertial', eye: { - upM: eye.upM, - forwardM: - finite(eye.forwardM) && Math.abs(eye.forwardM) <= 500 - ? eye.forwardM - : 0, - pitchDeg: finite(eye.pitchDeg) ? clamp(eye.pitchDeg, -90, 90) : 0, + upM, + forwardM: finite(forwardM) && Math.abs(forwardM) <= 500 ? forwardM : 0, + pitchDeg: finite(pitchDeg) ? clamp(pitchDeg, -90, 90) : 0, minClearanceM: - finite(eye.minClearanceM) && eye.minClearanceM >= 0 - ? eye.minClearanceM - : 0, + finite(minClearanceM) && minClearanceM >= 0 ? minClearanceM : 0, }, }; } diff --git a/src/cockpitSubjectProviders.test.mjs b/src/cockpitSubjectProviders.test.mjs index 979442cb4d..9debba2f66 100644 --- a/src/cockpitSubjectProviders.test.mjs +++ b/src/cockpitSubjectProviders.test.mjs @@ -642,11 +642,15 @@ test('a provider whose getter throws is left out with one warning; the next is k ]); }); -test('a worded getter that starts throwing keeps the last good words', () => { - let failing = false; - const words = (value) => () => { - if (failing) throw new Error('translations unavailable'); - return value; +test('a worded getter that throws from its second read keeps the last good words', () => { + // Registration reads each once: the second read is the first use. + const once = (value) => { + let read = false; + return () => { + if (read) throw new Error('translations unavailable'); + read = true; + return value; + }; }; const definition = provider(); for (const [key, value] of Object.entries({ @@ -654,48 +658,20 @@ test('a worded getter that starts throwing keeps the last good words', () => { entryFace: { icon: 'commute', label: 'RIDE' }, look: { restPitchDeg: 10, aheadLabel: 'Look ahead' }, })) - Object.defineProperty(definition, key, { get: words(value) }); + Object.defineProperty(definition, key, { get: once(value) }); const { kept, warnings } = keep([definition]); assert.deepEqual(warnings, []); const [ride] = kept; - failing = true; assert.equal(ride.labels.view, 'Ride view'); assert.equal(ride.entryFace.label, 'RIDE'); assert.deepEqual(ride.look, { restPitchDeg: 10, aheadLabel: 'Look ahead' }); // So does a worded object whose own member throws when read. - failing = false; Object.defineProperty(definition, 'labels', { get: () => throwingGetter({ view: 'v', exit: 'e', exitText: 'x' }, 'view'), }); assert.equal(ride.labels.view, 'Ride view'); }); -for (const form of ['function', 'getter']) { - test(`worded members (as a ${form}) that throw from their second read keep the words checked at registration`, () => { - const definition = provider(); - for (const [key, value] of Object.entries({ - labels: { view: 'Ride view', exit: 'Exit ride view', exitText: 'EXIT' }, - entryFace: { icon: 'commute', label: 'RIDE' }, - look: { restPitchDeg: 10, aheadLabel: 'Look ahead' }, - })) { - let read = false; - const once = () => { - if (read) throw new Error('word bundle unloaded'); - read = true; - return value; - }; - if (form === 'function') definition[key] = once; - else Object.defineProperty(definition, key, { get: once }); - } - const { kept, warnings } = keep([definition]); - assert.deepEqual(warnings, []); - const [ride] = kept; - assert.equal(ride.labels.view, 'Ride view'); - assert.equal(ride.entryFace.label, 'RIDE'); - assert.deepEqual(ride.look, { restPitchDeg: 10, aheadLabel: 'Look ahead' }); - }); -} - test('a worded member that returns a rejected promise keeps the last good words, the rejection caught', async () => { const definition = provider(); const words = definition.labels; diff --git a/src/ui/cockpitCamera.js b/src/ui/cockpitCamera.js index ea371dab1b..0aaf4bcf25 100644 --- a/src/ui/cockpitCamera.js +++ b/src/ui/cockpitCamera.js @@ -357,6 +357,7 @@ function updateSubject(nowMs) { } this.lastSubjectFrame = frame; let heightM = frame.heightM; + let held = false; if (heightM === null) { this.services.warmGroundFloor?.([ { lat: frame.latitude, lon: frame.longitude }, @@ -366,8 +367,10 @@ function updateSubject(nowMs) { frame.longitude, ); // A frame with no height stands on the shared floor; while that is cold - // it keeps the last height it had, the entry frame's included. - heightM = Number.isFinite(floorM) ? floorM : this.subjectHeightM; + // the eye keeps the last height it stood at (a frame's or the floor's), + // at first the entry frame's. + held = !Number.isFinite(floorM); + heightM = held ? this.subjectHeightM : floorM; } if (!Number.isFinite(heightM)) { // Nothing to stand on yet, from the first frame: the camera stays where @@ -399,6 +402,14 @@ function updateSubject(nowMs) { } this.surfaceWaitStartedMs = 0; this.surfaceAcquiring = false; + if (!held) { + // The first height to replace the entry frame's places the anchor + // anew: an inertial one would close on it only at the horizontal + // correction's rate. + if (this.subjectHeightFromEntry && heightM !== this.subjectHeightM) + this.cockpitAnchorValid = false; + this.subjectHeightFromEntry = false; + } this.subjectHeightM = heightM; const target = fromDegrees(frame.longitude, frame.latitude, heightM); const dtSec = cockpitSubjectStepSec(nowMs - this.lastFrameMs, intervalMs); @@ -461,11 +472,11 @@ function updateSubject(nowMs) { * Aircraft pass none and look along the heading at the profile pitch. */ function placeCamera(target, info, nowMs, dtSec, profile, look = null) { - // The update that first sets the anchor stands it on the target: the time - // before it (an entry, a floor wait) moved nothing, so it has no step. + // An update that sets the anchor stands it on the target with no step: + // the first one (the time before it, an entry or a floor wait, moved + // nothing), and a subject's whose height replaced its entry frame's. const anchoring = !this.cockpitAnchorValid; if (anchoring) { - this.cockpitAnchor = clone(target); this.cockpitAnchorValid = true; this.subjectLiftM = null; } diff --git a/src/ui/cockpitController.js b/src/ui/cockpitController.js index ded0f1fd87..6bdd97f5f0 100644 --- a/src/ui/cockpitController.js +++ b/src/ui/cockpitController.js @@ -194,11 +194,10 @@ export class CockpitViewController { this.surfaceWaitStartedMs = 0; this.surfaceAcquiring = false; this.surfaceFallback = false; - /** - * The last height an application subject's frame gave, the entry frame's - * included (m). - */ + /** The height an application subject's eye last stood at (m). */ this.subjectHeightM = null; + /** Whether `subjectHeightM` is still the one its entry frame gave. */ + this.subjectHeightFromEntry = false; /** The ground clamp's eased lift under that subject's eye (m). */ this.subjectLiftM = null; /** diff --git a/src/ui/cockpitController.test.mjs b/src/ui/cockpitController.test.mjs index 077ed48bbe..9a08f13e77 100644 --- a/src/ui/cockpitController.test.mjs +++ b/src/ui/cockpitController.test.mjs @@ -495,6 +495,38 @@ test('Cockpit places the eye at its aircraft as the Cesium maths did', async () } }); +test("a live aircraft's first Cockpit update stands the anchor on it", async () => { + const Cesium = await import('cesium'); + const env = environment(); + try { + const target = Cesium.Cartesian3.fromDegrees(-97.67, 30.19, 1200); + const info = { + icao24: 'abc123', + layerId: 'flights', + track: 72, + velocityMps: 200, + latitude: 30.19, + longitude: -97.67, + onGround: false, + stale: false, + }; + const { owner, views } = cockpitOver({ info, target }); + // Entry was a while ago: the step would carry the anchor 20 m ahead. + owner.update(); + const expected = cesiumCockpitEye(Cesium, { + target, + info: { ...info, stale: true }, + heading: 72, + dtSec: 0, + liftM: 0, + }); + near(views[0].destination, expected.eye, 1e-6, 'first live eye'); + owner.dispose(); + } finally { + env.restore(); + } +}); + test('a grounded Cockpit probes the mesh from the camera and keeps the eye above the floor', async () => { const Cesium = await import('cesium'); const env = environment(); diff --git a/src/ui/cockpitInstruments.js b/src/ui/cockpitInstruments.js index 5e67a47e01..c7226fcb90 100644 --- a/src/ui/cockpitInstruments.js +++ b/src/ui/cockpitInstruments.js @@ -262,7 +262,6 @@ function updateSubjectHud(info, nowMs, forceContext) { for (const key of this.subjectSignalKeys ?? []) if (!keys.has(key)) this.dropCockpitSignal(key); this.subjectSignalKeys = keys; - // The view's rows are its current signals, each changed in place. for (const signal of hud.signals) this.pushCockpitSignal( `subject:${signal.id}`, diff --git a/src/ui/cockpitSignals.js b/src/ui/cockpitSignals.js index 997b978eee..96446163ef 100644 --- a/src/ui/cockpitSignals.js +++ b/src/ui/cockpitSignals.js @@ -43,8 +43,9 @@ export function publishCockpitSignals() { * Log a signal as the newest row, unless its key last said the same. * @param {{inPlace?: boolean}} [options] `inPlace`: a status row, such as a * provider's, that changes where it stands rather than log a new row, so a - * changing ETA never pushes a steady warning off the list; it keeps the - * time it first appeared, and comes back if newer rows pushed it off. + * changing ETA never pushes a steady warning off the list; it keeps its + * time while it stays listed, and one pushed off comes back as the newest + * row. */ export function pushCockpitSignal( key, @@ -55,8 +56,8 @@ export function pushCockpitSignal( { inPlace = false } = {}, ) { if (!title || !detail) return; - // Each field on its own, so no title and detail read as another pair; an - // in-place row also changes with its tone alone. + // JSON keeps the fields apart: joined with `|`, a title or detail holding a + // `|` read as another pair. An in-place row also changes with its tone alone. const signature = JSON.stringify([ title, detail, diff --git a/src/ui/cockpitSubjectView.test.mjs b/src/ui/cockpitSubjectView.test.mjs index 63d39455a9..7d6150f046 100644 --- a/src/ui/cockpitSubjectView.test.mjs +++ b/src/ui/cockpitSubjectView.test.mjs @@ -127,7 +127,10 @@ function subjectProvider(overrides = {}) { return { definition, subject, calls }; } -function fixture(t, { providers = [], vessel = null, layerOn = true } = {}) { +function fixture( + t, + { providers = [], vessel = null, layerOn = true, realSignals = false } = {}, +) { document.body.replaceChildren(); const host = document.body.appendChild(document.createElement('div')); const pinia = createPinia(); @@ -208,6 +211,7 @@ function fixture(t, { providers = [], vessel = null, layerOn = true } = {}) { instruments: (view) => store.publishInstruments(view), route: (view) => store.publishRoute(view), radar: (view) => store.publishRadar(view), + signals: realSignals ? (view) => store.publishSignals(view) : undefined, }, }); Object.assign(cockpit, { @@ -226,6 +230,11 @@ function fixture(t, { providers = [], vessel = null, layerOn = true } = {}) { maybeRefreshRegionalBrief() {}, showContextCard() {}, }); + if (realSignals) { + // The real Live Signals rows, published, not the recorder above. + delete cockpit.pushCockpitSignal; + delete cockpit.dropCockpitSignal; + } t.after(() => { cockpit.stop(); app.unmount(); @@ -285,6 +294,25 @@ async function settle() { /** The provider's last release call. */ const lastRelease = (calls) => calls.findLast(([name]) => name === 'release'); +/** + * Move `ride`'s subject east at `speedMps` from `startMs` (the manual clock's + * start) on an inertial anchor, its frame otherwise as it was with `extra` + * on top; returns where it is now (longitude). + */ +function movingEast(ride, startMs, speedMps, extra = {}) { + const eastNow = () => + eastM((speedMps * (performance.now() - startMs)) / 1000); + const base = ride.subject.frame; + ride.subject.frame = () => ({ + ...base, + longitude: eastNow(), + speedMps, + anchor: 'inertial', + ...extra, + }); + return eastNow; +} + /** The camera's height above the ellipsoid in its last shot (m). */ const shotHeight = (shots) => Cesium.Cartographic.fromCartesian(shots.at(-1).destination).height; @@ -614,16 +642,7 @@ test('an inertial subject drawn at 5 frames a second stays near its target', asy const startMs = 10_000; const clock = manualClock(t, startMs); const ride = subjectProvider(); - const SPEED_MPS = 30; - const eastNow = () => - eastM((SPEED_MPS * (performance.now() - startMs)) / 1000); - const base = ride.subject.frame; - ride.subject.frame = () => ({ - ...base, - longitude: eastNow(), - speedMps: SPEED_MPS, - anchor: 'inertial', - }); + const eastNow = movingEast(ride, startMs, 30); const { cockpit, shots } = fixture(t, { providers: [ride] }); cockpit.syncEntry(); assert.equal(cockpit.enter(), true); @@ -639,53 +658,38 @@ test('an inertial subject drawn at 5 frames a second stays near its target', asy ); }); -for (const [intervalMs, waitMs] of [ - [0, 1000], - [500, 2000], -]) { - test(`an inertial subject's first camera update after a ${waitMs} ms floor wait (interval ${intervalMs} ms) stands on it`, async (t) => { - const startMs = 10_000; - const clock = manualClock(t, startMs); - const SPEED_MPS = 30; - const eastNow = () => - eastM((SPEED_MPS * (performance.now() - startMs)) / 1000); - const ride = subjectProvider({ cameraIntervalMs: intervalMs }); - const base = ride.subject.frame; - ride.subject.frame = () => ({ - ...base, - heightM: null, - longitude: eastNow(), - speedMps: SPEED_MPS, - anchor: 'inertial', - eye: { ...base.eye, forwardM: 0 }, - }); - const { cockpit, shots, setFloor } = fixture(t, { providers: [ride] }); - setFloor(undefined); - cockpit.syncEntry(); - assert.equal(cockpit.enter(), true); - const before = shots.length; - const stepMs = intervalMs || 100; - for (let waited = stepMs; waited < waitMs; waited += stepMs) { - clock.advance(stepMs); - cockpit.update(); - } - assert.equal( - shots.length, - before, - 'no camera update while the floor is cold', - ); - setFloor(FLOOR_M); - clock.advance(stepMs); +test("an inertial subject's first camera update after a floor wait longer than its step stands on it", async (t) => { + const startMs = 10_000; + const clock = manualClock(t, startMs); + const intervalMs = 500; + const ride = subjectProvider({ cameraIntervalMs: intervalMs }); + const eastNow = movingEast(ride, startMs, 30, { heightM: null }); + const { cockpit, shots, setFloor } = fixture(t, { providers: [ride] }); + setFloor(undefined); + cockpit.syncEntry(); + assert.equal(cockpit.enter(), true); + const before = shots.length; + // 2 s cold: longer than the 1.5 s an update may step. + for (let waited = intervalMs; waited < 2000; waited += intervalMs) { + clock.advance(intervalMs); cockpit.update(); - const shot = Cesium.Cartographic.fromCartesian(shots[before].destination); - const leadM = - (Cesium.Math.toDegrees(shot.longitude) - eastNow()) * M_PER_DEG_LON; - assert.ok( - Math.abs(leadM) < 1, - `the first camera update leads the subject by ${leadM.toFixed(2)} m`, - ); - }); -} + } + assert.equal( + shots.length, + before, + 'no camera update while the floor is cold', + ); + setFloor(FLOOR_M); + clock.advance(intervalMs); + cockpit.update(); + const shot = Cesium.Cartographic.fromCartesian(shots[before].destination); + const leadM = + (Cesium.Math.toDegrees(shot.longitude) - eastNow()) * M_PER_DEG_LON; + assert.ok( + Math.abs(leadM) < 1, + `the first camera update leads the subject by ${leadM.toFixed(2)} m`, + ); +}); test('an exact anchor sits on the subject, wherever the frame moves it', async (t) => { const clock = manualClock(t, 10_000); @@ -1310,6 +1314,8 @@ test("a double-click on the selected vessel does not enter an application's subj everythingAt(t, 100, 100); cockpit.syncEntry(); assert.equal(store.presence.entryKind, 'vessel'); + // The first press of the double-click notes where the vessel is drawn. + cockpit.onScenePointerDown(); // The application's subject is selected after the vessel: it takes entry. clock.advance(500); ride.subject.candidate = { id: 'a1', name: 'Example 12', selectedAt: 1 }; @@ -1342,6 +1348,24 @@ test('the same double-click on the vessel alone enters its bridge', async (t) => assert.equal(cockpit.subjectKind, 'vessel'); }); +test("a moving vessel's first bridge update after entry stands the anchor on its fix", async (t) => { + const clock = manualClock(t, 10_000); + const { cockpit } = fixture(t, { vessel: VESSEL }); + cockpit.syncEntry(); + assert.equal(cockpit.enter(), true); + clock.advance(1000); + cockpit.update(); + const anchor = Cesium.Cartographic.fromCartesian( + Cesium.Cartesian3.clone(cockpit.cockpitAnchor), + ); + const fix = cockpit.vesselFix; + const gapM = Cesium.Cartesian3.distance( + Cesium.Cartesian3.fromRadians(anchor.longitude, anchor.latitude, 0), + Cesium.Cartesian3.fromDegrees(fix.longitude, fix.latitude, 0), + ); + assert.ok(gapM < 0.01, `the anchor is ${gapM.toFixed(2)} m from the fix`); +}); + test('a provider view with look turns with the arrow keys and words its readout', async (t) => { const clock = manualClock(t, 10_000); const ride = subjectProvider(); @@ -1390,10 +1414,7 @@ test('rows a HUD view no longer lists leave Live Signals', async (t) => { test('a signal still listed stays in Live Signals while another one changes', async (t) => { const clock = manualClock(t, 10_000); const ride = subjectProvider(); - const { cockpit } = fixture(t, { providers: [ride] }); - // The real Live Signals rows, not the fixture's recorder. - delete cockpit.pushCockpitSignal; - delete cockpit.dropCockpitSignal; + const { cockpit } = fixture(t, { providers: [ride], realSignals: true }); // The ETA is logged first, so it stands below the warning. const hudWith = (minutes) => ({ ...HUD, @@ -1454,17 +1475,19 @@ test('a signal still listed stays in Live Signals while another one changes', as test('a Live Signals row whose tone alone changes takes the new tone', async (t) => { const clock = manualClock(t, 10_000); const ride = subjectProvider(); - const { cockpit } = fixture(t, { providers: [ride] }); - delete cockpit.pushCockpitSignal; - delete cockpit.dropCockpitSignal; + const { cockpit, store } = fixture(t, { + providers: [ride], + realSignals: true, + }); const hudWith = (tone) => ({ ...HUD, signals: [ { id: 'doors', tone, title: 'DOORS', detail: 'door fault, car 2' }, ], }); + // The class of the row Live Signals shows. const doorsTone = () => - cockpit.signalItems.find((row) => row.key === 'subject:doors').tone; + store.signals.find((row) => row.title === 'DOORS').className; ride.subject.hud = hudWith('normal'); cockpit.syncEntry(); assert.equal(cockpit.enter(), true); @@ -1481,9 +1504,7 @@ test('a Live Signals row whose tone alone changes takes the new tone', async (t) test('rows a HUD view replaces leave before new ones push a listed one off', async (t) => { const clock = manualClock(t, 10_000); const ride = subjectProvider(); - const { cockpit } = fixture(t, { providers: [ride] }); - delete cockpit.pushCockpitSignal; - delete cockpit.dropCockpitSignal; + const { cockpit } = fixture(t, { providers: [ride], realSignals: true }); const row = (id, tone) => ({ id, tone, @@ -1510,3 +1531,36 @@ test('rows a HUD view replaces leave before new ones push a listed one off', asy `rows right after the change: ${keys.join(', ')}`, ); }); + +// An inertial subject placed at its entry frame's height while the floor was +// cold stands on the floor as soon as it warms, as an exact anchor does. +test('an inertial subject placed at its entry height stands on the floor once it warms', async (t) => { + const clock = manualClock(t, 10_000); + const ride = subjectProvider(); + ride.subject.frame = { + ...ride.subject.frame, + heightM: FLOOR_M, + speedMps: 0, + anchor: 'inertial', + eye: { ...ride.subject.frame.eye, forwardM: 0 }, + }; + const { cockpit, shots, setFloor } = fixture(t, { providers: [ride] }); + setFloor(undefined); + cockpit.syncEntry(); + assert.equal(cockpit.enter(), true); + ride.subject.frame = { ...ride.subject.frame, heightM: null }; + clock.advance(100); + cockpit.update(); + assert.ok(Math.abs(shotHeight(shots) - (FLOOR_M + 3.5)) < 0.01); + const floorM = FLOOR_M - 100; + setFloor(floorM); + for (let i = 0; i < 10; i += 1) { + clock.advance(100); + cockpit.update(); + } + const heightM = shotHeight(shots); + assert.ok( + Math.abs(heightM - (floorM + 3.5)) < 1, + `1 s after the floor came the eye is at ${heightM.toFixed(2)} m, not ${floorM + 3.5} m`, + ); +}); diff --git a/src/ui/cockpitTrackingController.js b/src/ui/cockpitTrackingController.js index 314a8c1b38..3cfcc76fb9 100644 --- a/src/ui/cockpitTrackingController.js +++ b/src/ui/cockpitTrackingController.js @@ -516,9 +516,10 @@ function enterSubject(provider) { this.surfaceAcquiring = false; this.surfaceFallback = false; this.cockpitAnchorValid = false; - // A height the entry frame gave is where the eye stands until a later frame - // or the warmed floor gives another. + // The entry frame's height, if any, stands in for a cold floor + // (updateSubject). this.subjectHeightM = frame.heightM; + this.subjectHeightFromEntry = true; this.lookRestPitchDeg = provider.look?.restPitchDeg ?? null; this.resetLook({ immediate: true }); this.active = true;