@oicl/openbridge-webcomponents 0.0.15-dev-20240916083108 → 0.0.15-dev-20240923184809

package/src/navigation-instruments/compass-flat/compass-flat.ts

@@ -0,0 +1,221 @@
+import {LitElement, svg, SVGTemplateResult, unsafeCSS} from 'lit';
+import componentStyle from './compass-flat.css?inline';
+import {customElement, property} from 'lit/decorators.js';
+import {Tickmark, TickmarkType} from '../watch-flat/tickmark-flat';
+import '../watch-flat/watch-flat';
+
+export enum LabelPosition {
+  top = -45,
+  bottom = 50,
+}
+
+export enum LabelStyle {
+  regular = 'var(--instrument-tick-mark-secondary-color)',
+}
+
+export interface Label {
+  x: number;
+  y: LabelPosition;
+  text: string;
+}
+
+@customElement('obc-compass-flat')
+export class ObcCompassFlat extends LitElement {
+  @property({type: Boolean}) noPadding: boolean = true;
+  @property({type: Boolean}) FOVIndicator: boolean = false;
+  @property({type: Number}) padding: number = 16;
+  @property({type: Number}) heading = 0;
+  @property({type: Number}) courseOverGround = 0;
+  @property({type: Number}) tickInterval = 5;
+  @property({type: Number}) FOV = 45;
+  @property({type: Number}) minFOV = 45;
+  @property({type: Number}) maxFOV = 180;
+  labels: Label[] = [];
+
+  @property({type: Number}) containerWidth = 0;
+
+  private resizeObserver: ResizeObserver = new ResizeObserver((entries) => {
+    for (const entry of entries) {
+      this.containerWidth = entry.contentRect.width;
+      this.updateLabels();
+    }
+  });
+
+  override connectedCallback() {
+    super.connectedCallback();
+    this.resizeObserver.observe(this);
+  }
+
+  override disconnectedCallback() {
+    super.disconnectedCallback();
+    this.resizeObserver.unobserve(this);
+  }
+
+  private updateLabels() {
+    if (this.containerWidth < 192) {
+      this.labels = [];
+    } else if (this.containerWidth <= 300) {
+      this.labels = [
+        {x: -180, y: LabelPosition.top, text: 'S'},
+        {x: -90, y: LabelPosition.top, text: 'W'},
+        {x: 0, y: LabelPosition.top, text: 'N'},
+        {x: 90, y: LabelPosition.top, text: 'E'},
+        {x: 180, y: LabelPosition.top, text: 'S'},
+        {x: 270, y: LabelPosition.top, text: 'W'},
+        {x: 360, y: LabelPosition.top, text: 'N'},
+        {x: 450, y: LabelPosition.top, text: 'E'},
+        {x: 540, y: LabelPosition.top, text: 'S'},
+      ];
+    } else {
+      this.labels = [
+        {x: -180, y: LabelPosition.top, text: 'S'},
+        {x: -135, y: LabelPosition.top, text: 'SW'},
+        {x: -90, y: LabelPosition.top, text: 'W'},
+        {x: -45, y: LabelPosition.top, text: 'NW'},
+        {x: 0, y: LabelPosition.top, text: 'N'},
+        {x: 45, y: LabelPosition.top, text: 'NE'},
+        {x: 90, y: LabelPosition.top, text: 'E'},
+        {x: 135, y: LabelPosition.top, text: 'SE'},
+        {x: 180, y: LabelPosition.top, text: 'S'},
+        {x: 225, y: LabelPosition.top, text: 'SW'},
+        {x: 270, y: LabelPosition.top, text: 'W'},
+        {x: 315, y: LabelPosition.top, text: 'NW'},
+        {x: 360, y: LabelPosition.top, text: 'N'},
+        {x: 405, y: LabelPosition.top, text: 'NE'},
+        {x: 450, y: LabelPosition.top, text: 'E'},
+        {x: 495, y: LabelPosition.top, text: 'SE'},
+        {x: 540, y: LabelPosition.top, text: 'S'},
+      ];
+    }
+  }
+
+  private generateIntervalTickmarks(scale: number): Tickmark[] {
+    const tickmarks: Tickmark[] = [];
+    let cardinalInterval = 90;
+
+    if (this.containerWidth > 300) {
+      cardinalInterval = 45;
+    } else if (this.containerWidth < 192) {
+      cardinalInterval = 0;
+    }
+
+    for (
+      let angle = -180;
+      angle < this.maxFOV * 3;
+      angle += this.tickInterval
+    ) {
+      if (cardinalInterval !== 0 && angle % cardinalInterval === 0) {
+        continue;
+      }
+      tickmarks.push({angle: angle * scale, type: TickmarkType.secondary});
+    }
+
+    return tickmarks;
+  }
+
+  private generateCardinalTickmarks(scale: number): Tickmark[] {
+    const tickmarks: Tickmark[] = [];
+
+    for (const label of this.labels) {
+      tickmarks.push({angle: label.x * scale, type: TickmarkType.main});
+    }
+
+    return tickmarks;
+  }
+
+  private generateTickmarks(scale: number): Tickmark[] {
+    return [
+      ...this.generateCardinalTickmarks(scale),
+      ...this.generateIntervalTickmarks(scale),
+    ];
+  }
+
+  private renderFOVIndicator(): SVGTemplateResult[] {
+    const indicators: SVGTemplateResult[] = [];
+
+    const maxAdjustment = 10;
+    const minContainerWidth = 300;
+    const maxContainerWidth = 512;
+
+    let yAdjustment = 0;
+    if (this.containerWidth < maxContainerWidth) {
+      const widthRange = maxContainerWidth - minContainerWidth;
+      const scaleFactor =
+        (maxContainerWidth - this.containerWidth) / widthRange;
+      yAdjustment = scaleFactor * maxAdjustment;
+    }
+
+    const y = LabelPosition.bottom + yAdjustment;
+
+    indicators.push(svg`
+          <text x="-175" y=${y} class="label left" fill=${LabelStyle.regular}>
+            ${-this.FOV}\u00B0
+          </text>`);
+
+    indicators.push(svg`
+          <text x="0" y=${y} class="label" fill=${LabelStyle.regular}>
+            ${this.heading}\u00B0
+          </text>`);
+
+    indicators.push(svg`
+          <text x="175" y=${y} class="label right" fill=${LabelStyle.regular}>
+            ${this.FOV}\u00B0
+          </text>`);
+
+    return indicators;
+  }
+
+  private get HDGSvg(): SVGTemplateResult {
+    return svg`<g transform="translate(-24, -74)">
+          <path d="M36.7011 44.1445L36.6898 44.1379L36.6781 44.1318L24.2301 37.6823L24.0001 37.5631L23.7701 37.6823L11.3221 44.1318L11.3104 44.1379L11.2991 44.1445C9.25497 45.3438 6.78661 43.308 7.68828 41.0919L22.6036 4.43285C23.1096 3.18905 24.8906 3.18905 25.3967 4.43284L40.3119 41.0919C41.2136 43.308 38.7452 45.3438 36.7011 44.1445Z" fill="var(--instrument-enhanced-secondary-color)" stroke="var(--border-silhouette-color)"/>
+        </g>`;
+  }
+
+  private COGSvg(translation: number): SVGTemplateResult {
+    return svg`
+      <g transform="translate(${-24 + translation}, -74)">
+        <path d="M31.9025 36.0262L33.1068 36.6502L32.5956 35.3938L24.4632 15.406L24.0001 14.2677L23.537 15.406L15.4046 35.3938L14.8935 36.6502L16.0978 36.0262L24.0001 31.9319L31.9025 36.0262ZM36.7011 44.1445L36.6898 44.1379L36.6781 44.1318L24.2301 37.6823L24.0001 37.5631L23.7701 37.6823L11.3221 44.1318L11.3104 44.1379L11.2991 44.1445C9.25497 45.3438 6.78661 43.308 7.68828 41.0919L22.6036 4.43285C23.1096 3.18905 24.8906 3.18905 25.3967 4.43284L40.3119 41.0919C41.2136 43.308 38.7452 45.3438 36.7011 44.1445Z" fill="var(--instrument-enhanced-secondary-color)" stroke="var(--border-silhouette-color)"/>
+      </g>
+    `;
+  }
+
+  override render() {
+    let angleDiff = this.courseOverGround - this.heading;
+
+    if (angleDiff > this.maxFOV) {
+      angleDiff -= 360;
+    } else if (angleDiff < -this.maxFOV) {
+      angleDiff += 360;
+    }
+
+    this.FOV = Math.max(this.minFOV, Math.abs(angleDiff));
+
+    const baseOffset = 5;
+    const translationScale = (baseOffset * 35) / this.FOV;
+
+    const translation = angleDiff * translationScale;
+
+    const tickmarks = this.generateTickmarks(translationScale);
+    this.labels.map((l) => {
+      l.x = l.x * translationScale;
+    });
+
+    const viewBox = this.noPadding ? '-192 -128 384 128' : '-200 -144 400 144';
+
+    return svg`
+      <div class="container">
+        <obc-watch-flat .noPadding=${this.noPadding} .FOVIndicator=${this.FOVIndicator ? this.renderFOVIndicator() : []} .labels=${this.labels} .rotation=${this.heading} .tickmarks=${tickmarks} .tickmarkSpacing=${translationScale}></obc-watch-flat>
+        <svg viewBox=${viewBox} xmlns="http://www.w3.org/2000/svg"> 
+        ${this.HDGSvg}${this.COGSvg(translation)}
+      </div>
+    `;
+  }
+
+  static override styles = unsafeCSS(componentStyle);
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'obc-compass-flat': ObcCompassFlat;
+  }
+}

package/src/navigation-instruments/main-engine/main-engine.css

@@ -0,0 +1,17 @@
+* {
+    box-sizing: border-box;
+}
+
+.container {
+    position: relative;
+    width: 100%;
+    height: 100%;
+}
+
+.container>* {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+}

package/src/navigation-instruments/main-engine/main-engine.stories.ts

@@ -0,0 +1,54 @@
+import type {Meta, StoryObj} from '@storybook/web-components';
+import {ObcMainEngine} from './main-engine';
+import './main-engine';
+import {beta6Decorator, widthDecorator} from '../../storybook-util';
+import {InstrumentState} from '../types';
+
+const meta: Meta<typeof ObcMainEngine> = {
+  title: 'Navigation instruments/Main Engine',
+  tags: ['autodocs'],
+  component: 'obc-main-engine',
+  args: {
+    width: 352,
+    thrust: 50,
+    thrustSetpoint: 30,
+    speed: 50,
+    speedSetpoint: 30,
+  },
+  argTypes: {
+    width: {control: {type: 'range', min: 32, max: 1028, step: 1}},
+    thrust: {control: {type: 'range', min: -100, max: 100, step: 1}},
+    thrustSetpoint: {control: {type: 'range', min: -100, max: 100, step: 1}},
+    speed: {control: {type: 'range', min: 0, max: 100, step: 1}},
+    speedSetpoint: {control: {type: 'range', min: 0, max: 100, step: 1}},
+    state: {
+      options: Object.values(InstrumentState),
+    },
+  },
+  decorators: [widthDecorator, beta6Decorator],
+} satisfies Meta<ObcMainEngine>;
+
+export default meta;
+type Story = StoryObj<ObcMainEngine>;
+
+export const InCommand: Story = {
+  args: {
+    state: InstrumentState.inCommand,
+  },
+};
+
+export const Active: Story = {
+  args: {
+    state: InstrumentState.active,
+  },
+};
+
+export const Off: Story = {
+  args: {
+    state: InstrumentState.off,
+    speed: 0,
+    thrust: 0,
+    speedSetpoint: 0,
+    thrustSetpoint: 0,
+  },
+};

package/src/navigation-instruments/main-engine/main-engine.ts

@@ -0,0 +1,160 @@
+import {LitElement, html, unsafeCSS, svg, nothing} from 'lit';
+import {customElement, property} from 'lit/decorators.js';
+import compentStyle from './main-engine.css?inline';
+import {InstrumentState} from '../types';
+import {
+  atSetpoint,
+  convertThrustAdvices,
+  thrusterColors,
+  thrusterTopSingleSided,
+  setpointSvg,
+} from '../thruster/thruster';
+import {LinearAdvice} from '../thruster/advice';
+
+@customElement('obc-main-engine')
+export class ObcMainEngine extends LitElement {
+  @property({type: Number}) thrust: number = 0;
+  @property({type: Number}) thrustSetpoint: number | undefined;
+  @property({type: Boolean}) thrustTouching: boolean = false;
+  @property({type: Boolean}) atThrustSetpoint: boolean = false;
+  @property({type: Number}) speed: number = 0;
+  @property({type: Number}) speedSetpoint: number | undefined;
+  @property({type: Boolean}) speedTouching: boolean = false;
+  @property({type: Boolean}) atSpeedSetpoint: boolean = false;
+  @property({type: Boolean}) disableAutoAtThrustSetpoint: boolean = false;
+  @property({type: Boolean}) disableAutoAtSpeedSetpoint: boolean = false;
+  @property({type: Number}) autoAtThrustSetpointDeadband: number = 1;
+  @property({type: Number}) autoAtSpeedSetpointDeadband: number = 1;
+  @property({type: Number}) thrustSetpointAtZeroDeadband: number = 0.5;
+  @property({type: Number}) speedSetpointAtZeroDeadband: number = 0.5;
+  @property({type: String}) state: InstrumentState = InstrumentState.inCommand;
+  @property({type: Array}) thrustAdvices: LinearAdvice[] = [];
+
+  override render() {
+    const thrustSetpointAtZero =
+      Math.abs(this.thrustSetpoint || 0) < this.thrustSetpointAtZeroDeadband;
+    const speedSetpointAtZero =
+      Math.abs(this.speedSetpoint || 0) < this.speedSetpointAtZeroDeadband;
+    const thrustAtSetpoint = atSetpoint(this.thrust, this.thrustSetpoint, {
+      atSetpoint: this.atThrustSetpoint,
+      autoAtSetpoint: !this.disableAutoAtThrustSetpoint,
+      autoSetpointDeadband: this.autoAtThrustSetpointDeadband,
+      touching: this.thrustTouching,
+    });
+    const cThrust = thrusterColors(
+      {
+        atSetpoint: thrustAtSetpoint,
+        touching: this.thrustTouching,
+      },
+      this.state
+    );
+    const speedAtSetpoint = atSetpoint(this.speed, this.speedSetpoint, {
+      atSetpoint: this.atSpeedSetpoint,
+      autoAtSetpoint: !this.disableAutoAtSpeedSetpoint,
+      autoSetpointDeadband: this.autoAtSpeedSetpointDeadband,
+      touching: this.speedTouching,
+    });
+    const cSpeed = thrusterColors(
+      {
+        atSetpoint: speedAtSetpoint,
+        touching: this.speedTouching,
+      },
+      this.state
+    );
+    const container = svg`<rect x="-80" y="-176" width="160" height="352" fill="var(--instrument-frame-primary-color)" stroke="var(--instrument-frame-tertiary-color)" rx="8"/>`;
+    const border = svg`<rect x="-80" y="-176" width="160" height="352" fill="none" stroke="var(--instrument-frame-tertiary-color)" rx="8" vector-effect="non-scaling-stroke"/>`;
+    const frameLeft = svg`<rect x="-56" y="-176" width="48" height="352" fill="var(--instrument-frame-secondary-color)" vector-effect="non-scaling-stroke" stroke="var(--instrument-frame-secondary-color)"/>`;
+    const frameRight = svg`<rect x="8" y="-176" width="48" height="352" fill="var(--instrument-frame-secondary-color)" vector-effect="non-scaling-stroke" stroke="var(--instrument-frame-secondary-color)"/>`;
+    const thrustCenter = svg`<rect x="8" y="-2" height="4" width="72" fill="${cThrust.zeroLineColor}" stroke=${cThrust.zeroLineColor} vector-effect="non-scaling-stroke"/>`;
+    const {topAdvices: topThrustAdvice, bottomAdvices: bottomThrustAdvice} =
+      convertThrustAdvices(this.thrustAdvices, this.thrust);
+    const thrustTop = svg`<g transform="translate(44, 0)">
+      ${thrusterTopSingleSided(
+        174,
+        Math.max(this.thrust, 0),
+        {box: cThrust.boxColor, container: ''},
+        {
+          hideContainer: true,
+          hideTicks: cThrust.hideTicks,
+          flipAdicePattern: false,
+          narrow: false,
+        },
+        topThrustAdvice
+      )}</g>`;
+    const thrusterBottom = svg`<g transform="rotate(180) scale(-1,1) translate(44)">
+     ${thrusterTopSingleSided(
+       174,
+       Math.max(-this.thrust, 0),
+       {box: cThrust.boxColor, container: ''},
+       {
+         hideContainer: true,
+         hideTicks: cThrust.hideTicks,
+         flipAdicePattern: false,
+         narrow: false,
+       },
+       bottomThrustAdvice
+     )}</g>`;
+    const thrustSetpoint =
+      this.thrustSetpoint !== undefined
+        ? svg`<g transform="translate(44, 0)">${setpointSvg(
+            174,
+            this.thrustSetpoint,
+            thrustSetpointAtZero,
+            {
+              fill: cThrust.setPointColor,
+              stroke: 'var(--border-silhouette-color)',
+            },
+            {
+              inCommand: this.state === InstrumentState.inCommand,
+              singleSided: true,
+              narrow: false,
+            }
+          )}</g>`
+        : nothing;
+
+    const speedHeight = 352 * (this.speed / 100) + 2;
+    const speedY = 176 - speedHeight;
+    const speedBoxColor =
+      this.state === InstrumentState.inCommand
+        ? 'var(--instrument-enhanced-tertiary-color)'
+        : 'var(--instrument-regular-tertiary-color)';
+    const speedBox = svg`<rect x="-56" y=${speedY} width="48" height=${speedHeight} fill=${speedBoxColor} stroke=${speedBoxColor} vector-effect="non-scaling-stroke">`;
+    const speedLine = svg`<rect x="-56" y=${speedY - 2} width="48" height="4" rx="2" fill=${cSpeed.boxColor} stroke=${cSpeed.boxColor}/>
+`;
+    const speedSetpoint =
+      this.speedSetpoint !== undefined
+        ? svg`<g transform="scale(-1 1) translate(44, 176)">${setpointSvg(
+            350,
+            this.speedSetpoint,
+            speedSetpointAtZero,
+            {
+              fill: cSpeed.setPointColor,
+              stroke: 'var(--border-silhouette-color)',
+            },
+            {
+              inCommand: this.state === InstrumentState.inCommand,
+              singleSided: true,
+              narrow: false,
+            }
+          )}</g>`
+        : nothing;
+
+    return html`
+      <div class="container">
+        <svg viewbox="-100 -200 200 400">
+          ${container} ${frameLeft} ${frameRight} ${thrustCenter} ${thrustTop}
+          ${thrusterBottom} ${speedBox} ${speedLine} ${border} ${thrustSetpoint}
+          ${speedSetpoint}
+        </svg>
+      </div>
+    `;
+  }
+
+  static override styles = unsafeCSS(compentStyle);
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'obc-main-engine': ObcMainEngine;
+  }
+}

package/src/navigation-instruments/thruster/advice.ts

@@ -84,20 +84,24 @@ export function renderAdvice(
             ${singleSidedTickmark(height, advice.max, tickmarkStyle)}
         `;
   } else {
-    let mainColor;
+    let strokeColor;
     let tickmarkStyle;
+    let fillColor: string;
     if (advice.state === AdviceState.hinted) {
-      mainColor = 'var(--instrument-frame-tertiary-color)';
+      strokeColor = 'var(--instrument-frame-tertiary-color)';
+      fillColor = 'none';
       tickmarkStyle = TickmarkStyle.hinted;
     } else if (advice.state === AdviceState.regular) {
-      mainColor = 'var(--instrument-regular-secondary-color)';
+      strokeColor = 'var(--instrument-regular-secondary-color)';
+      fillColor = 'none';
       tickmarkStyle = TickmarkStyle.regular;
     } else {
-      mainColor = 'var(--instrument-enhanced-secondary-color)';
+      strokeColor = 'var(--instrument-enhanced-secondary-color)';
+      fillColor = strokeColor;
       tickmarkStyle = TickmarkStyle.regular;
     }
     return svg`
-            ${adviceMask(height, advice.min, advice.max, mainColor, mainColor)}
+            ${adviceMask(height, advice.min, advice.max, fillColor, strokeColor)}
             ${singleSidedTickmark(height, advice.min, tickmarkStyle)}
             ${singleSidedTickmark(height, advice.max, tickmarkStyle)}
         `;

package/src/navigation-instruments/thruster/thruster.stories.ts

@@ -12,6 +12,7 @@ const meta: Meta<typeof ObcThruster> = {
   component: 'obc-thruster',
   args: {width: 320},
   argTypes: {
+    width: {control: {type: 'range', min: 32, max: 1028, step: 1}},
     thrust: {control: {type: 'range', min: -100, max: 100, step: 1}},
     setpoint: {control: {type: 'range', min: -100, max: 100, step: 1}},
     state: {