feat: implement TOCA/POCA plugin for satellite closest approach calculations

Author: thkruz

src/plugins/keeptrack-plugins-configuration.ts

@@ -62,7 +62,7 @@ export type KeepTrackPluginsConfiguration = {
   NextLaunchesPlugin?: PluginConfiguration;
   OrbitReferences?: PluginConfiguration;
   SatellitePhotos?: PluginConfiguration;
-  SatelliteSelection?: PluginConfiguration;
+  TocaPocaPlugin?: PluginConfiguration;
   Planetarium?: PluginConfiguration;
   EciPlot?: PluginConfiguration;
   EcfPlot?: PluginConfiguration;

src/plugins/plugins.ts

@@ -55,7 +55,6 @@ import { SatInfoBoxSensor } from './sat-info-box-sensor/sat-info-box-sensor';
 import { SatInfoBox } from './sat-info-box/sat-info-box';
 import { SatelliteFov } from './satellite-fov/satellite-fov';
 import { SatellitePhotos } from './satellite-photos/satellite-photos';
-import { SatelliteSelection } from './satellite-selection/satellite-selection';
 import { ScenarioManagementPlugin } from './scenario-management/scenario-management';
 import { ScreenRecorder } from './screen-recorder/screen-recorder';
 import { Screenshot } from './screenshot/screenshot';
@@ -74,6 +73,7 @@ import { TimeMachine } from './time-machine/time-machine';
 import { TimeSlider } from './time-slider/time-slider';
 import { SatelliteTimeline } from './timeline-satellite/satellite-timeline';
 import { SensorTimeline } from './timeline-sensor/sensor-timeline';
+import { TocaPocaPlugin } from './toca-poca-plugin/toca-poca-plugin';
 import { TooltipsPlugin } from './tooltips/tooltips';
 import { TrackingImpactPredict } from './tracking-impact-predict/tracking-impact-predict';
 import { TransponderChannelData } from './transponder-channel-data/transponder-channel-data';
@@ -188,7 +188,7 @@ export class PluginManager {
         { init: () => new ProximityOps().init(), config: plugins.ProximityOps },
         { init: () => new OrbitReferences().init(), config: plugins.OrbitReferences },
         { init: () => new Collisions().init(), config: plugins.Collisions },
-        { init: () => new SatelliteSelection().init(), config: plugins.SatelliteSelection },
+        { init: () => new TocaPocaPlugin().init(), config: plugins.TocaPocaPlugin },
         { init: () => new OrbitGuardMenuPlugin().init(), config: plugins.OrbitGuardMenuPlugin },
         { init: () => new TrackingImpactPredict().init(), config: plugins.TrackingImpactPredict },
         { init: () => new Breakup().init(), config: plugins.Breakup },

src/plugins/satellite-selection/satellite-selection.css renamed to src/plugins/toca-poca-plugin/toca-poca-plugin.css

@@ -21,21 +21,22 @@
  * /////////////////////////////////////////////////////////////////////////////
  */
 
+import { OemSatellite } from '@app/app/objects/oem-satellite';
 import { MenuMode } from '@app/engine/core/interfaces';
 import { PluginRegistry } from '@app/engine/core/plugin-registry';
 import { ServiceLocator } from '@app/engine/core/service-locator';
 import { EventBus } from '@app/engine/events/event-bus';
 import { EventBusEvent } from '@app/engine/events/event-bus-events';
+import { dateFormat } from '@app/engine/utils/dateFormat';
 import { html } from '@app/engine/utils/development/formatter';
 import { errorManagerInstance } from '@app/engine/utils/errorManager';
 import { getEl } from '@app/engine/utils/get-el';
 import { showLoading } from '@app/engine/utils/showLoading';
-import { dateFormat } from '@app/engine/utils/dateFormat';
-import { DetailedSatellite, EciVec3, Kilometers, RIC } from '@ootk/src/main';
+import { BaseObject, DetailedSatellite, EciVec3, Kilometers, RIC } from '@ootk/src/main';
+import SatelliteSelectionPng from '@public/img/icons/satellite-selection.png';
 import { ClickDragOptions, KeepTrackPlugin } from '../../engine/plugins/base-plugin';
 import { SelectSatManager } from '../select-sat-manager/select-sat-manager';
-import SatelliteSelectionPng from '@public/img/icons/satellite-selection.png';
-import './satellite-selection.css';
+import './toca-poca-plugin.css';
 
 export interface TocaPocaEvent {
   time: Date;
@@ -46,8 +47,8 @@ export interface TocaPocaEvent {
   relativeVelocity: number;
 }
 
-export class SatelliteSelection extends KeepTrackPlugin {
-  readonly id = 'SatelliteSelection';
+export class TocaPocaPlugin extends KeepTrackPlugin {
+  readonly id = 'TocaPocaPlugin';
   dependencies_ = [SelectSatManager.name];
 
   private selectSatManager_: SelectSatManager;
@@ -56,6 +57,8 @@ export class SatelliteSelection extends KeepTrackPlugin {
   private tocaPocaList_: TocaPocaEvent[] = [];
   private selectSatIdOnCruncher_: number | null = null;
 
+  menuMode: MenuMode[] = [MenuMode.EXPERIMENTAL, MenuMode.ALL];
+
   // Configuration
   private readonly propagationDays_ = 7; // Look ahead 7 days
   private readonly timeStep_ = 60; // 60 second intervals
@@ -88,8 +91,6 @@ export class SatelliteSelection extends KeepTrackPlugin {
     maxWidth: 800,
   };
 
-  menuMode: MenuMode[] = [MenuMode.BASIC, MenuMode.ADVANCED, MenuMode.ALL];
-
   constructor() {
     super();
     this.selectSatManager_ = PluginRegistry.getPlugin(SelectSatManager) as unknown as SelectSatManager;
@@ -109,8 +110,8 @@ export class SatelliteSelection extends KeepTrackPlugin {
 
     EventBus.getInstance().on(EventBusEvent.uiManagerFinal, this.uiManagerFinal_.bind(this));
 
-    EventBus.getInstance().on(EventBusEvent.selectSatData, (sat: DetailedSatellite) => {
-      if (sat.isSatellite()) {
+    EventBus.getInstance().on(EventBusEvent.selectSatData, (sat: DetailedSatellite | BaseObject | OemSatellite) => {
+      if (sat instanceof DetailedSatellite) {
         this.primarySatellite_ = sat;
         if (this.isMenuButtonActive) {
           this.updateSatelliteInfo_();
@@ -153,6 +154,7 @@ export class SatelliteSelection extends KeepTrackPlugin {
 
       if (!selectedSat || !selectedSat.isSatellite()) {
         errorManagerInstance.warn('Please select a satellite first!');
+
         return;
       }
 
@@ -207,11 +209,12 @@ export class SatelliteSelection extends KeepTrackPlugin {
   private calculateTocaPoca_() {
     if (!this.primarySatellite_ || !this.targetSatellite_) {
       errorManagerInstance.warn('Please select both a primary and target satellite!');
+
       return;
     }
 
     try {
-      const events: TocaPocaEvent[] = [];
+      // const events: TocaPocaEvent[] = [];
       const timeManagerInstance = ServiceLocator.getTimeManager();
       const propagationSeconds = this.propagationDays_ * 24 * 60 * 60;
 
@@ -245,7 +248,7 @@ export class SatelliteSelection extends KeepTrackPlugin {
               sat1Position: sat1J2000.position,
               sat2Position: sat2J2000.position,
               relativeVelocity: Math.sqrt(
-                ric.velocity.x ** 2 + ric.velocity.y ** 2 + ric.velocity.z ** 2
+                ric.velocity.x ** 2 + ric.velocity.y ** 2 + ric.velocity.z ** 2,
               ),
             });
           }
@@ -271,14 +274,15 @@ export class SatelliteSelection extends KeepTrackPlugin {
         this.createTable_();
       }
     } catch (error) {
-      errorManagerInstance.error(`Error calculating TOCA/POCA: ${error}`, 'satellite-selection.ts');
+      errorManagerInstance.error(error, 'satellite-selection.ts', `Error calculating TOCA/POCA: ${error}`);
       this.clearTable_();
     }
   }
 
   private createTable_(): void {
     try {
       const tbl = <HTMLTableElement>getEl(`${this.id}-table`);
+
       tbl.innerHTML = '';
 
       this.createHeaders_(tbl);
@@ -290,6 +294,7 @@ export class SatelliteSelection extends KeepTrackPlugin {
 
   private clearTable_(): void {
     const tbl = <HTMLTableElement>getEl(`${this.id}-table`);
+
     tbl.innerHTML = '';
   }
 
@@ -299,6 +304,7 @@ export class SatelliteSelection extends KeepTrackPlugin {
 
     for (const name of names) {
       const column = tr.insertCell();
+
       column.appendChild(document.createTextNode(name));
       column.setAttribute('style', 'text-decoration: underline; font-weight: bold;');
     }
@@ -338,6 +344,7 @@ export class SatelliteSelection extends KeepTrackPlugin {
 
   private createCell_(tr: HTMLTableRowElement, text: string): void {
     const cell = tr.insertCell();
+
     cell.appendChild(document.createTextNode(text));
   }
 }

src/plugins/satellite-selection/satellite-selection.ts renamed to src/plugins/toca-poca-plugin/toca-poca-plugin.ts

@@ -108,6 +108,10 @@ export const defaultPlugins = <KeepTrackPluginsConfiguration>{
     enabled: true,
     order: 81,
   },
+  TocaPocaPlugin: {
+    enabled: true,
+    order: 82,
+  },
   Collisions: {
     enabled: true,
     order: 90,