Feature/new build simulators

README.md

@@ -46,7 +46,6 @@ const netConnectionSettings = {
 };
 
 const simulariumController = new SimulariumController();
-// todo show correct call of changeFile to load trajectory
 
 class Viewer extends React.Component {
 
@@ -66,6 +65,16 @@ class Viewer extends React.Component {
                 }
     }
 
+    public componentDidMount(): void {
+    // Load a trajectory by calling `changeFile`.
+    // You can do this here in a lifecycle method or call it later,
+    // whenever you’re ready to switch files.
+        simulariumController.changeFile({
+            fileName: "actin012_3.h5",
+            netConnectionSettings: netConnectionSettings,
+        });
+    }
+
     handleTimeChange = (timeData) => {
         console.log(timeData)
     }
@@ -92,6 +101,7 @@ class Viewer extends React.Component {
                     showPaths={this.state.showPaths}
                 />)
     }
+}
 ```
 
 ## Run an example app locally

examples/src/Components/ConversionForm/index.tsx

@@ -7,7 +7,6 @@ interface InputFormProps {
     templateData: { [key: string]: any };
     type: string;
     submitFile: (data) => void;
-    onReturned: () => void;
 }
 
 class InputForm extends React.Component<InputFormProps> {

examples/src/Viewer.tsx

@@ -138,7 +138,6 @@ class Viewer extends React.Component<InputParams, ViewerState> {
         this.handleJsonMeshData = this.handleJsonMeshData.bind(this);
         this.handleTimeChange = this.handleTimeChange.bind(this);
         this.loadFile = this.loadFile.bind(this);
-        this.clearPendingFile = this.clearPendingFile.bind(this);
         this.convertFile = this.convertFile.bind(this);
         this.handleResize = this.handleResize.bind(this);
         this.state = initialState;
@@ -341,7 +340,6 @@ class Viewer extends React.Component<InputParams, ViewerState> {
                 fileName
             )
             .then(() => {
-                this.clearPendingFile();
                 this.setState({ awaitingConversion: true });
             })
             .catch((err) => {
@@ -360,7 +358,6 @@ class Viewer extends React.Component<InputParams, ViewerState> {
                 this.smoldynInput
             )
             .then(() => {
-                this.clearPendingFile();
                 this.setState({ awaitingConversion: true });
             })
             .catch((err) => {
@@ -369,17 +366,17 @@ class Viewer extends React.Component<InputParams, ViewerState> {
             });
     }
 
-    public clearPendingFile() {
-        this.setState({ filePending: null });
-    }
-
     public loadFile(trajectoryFile, fileName, geoAssets?) {
         const simulariumFile = fileName.includes(".simularium")
             ? trajectoryFile
             : null;
         this.setState({ initialPlay: true });
         return simulariumController
-            .handleFileChange(simulariumFile, fileName, geoAssets)
+            .changeFile({
+                simulariumFile,
+                fileName,
+                geoAssets,
+            })
             .catch(console.log);
     }
 
@@ -597,13 +594,11 @@ class Viewer extends React.Component<InputParams, ViewerState> {
             clientSimulator: true,
             simulariumFile: { name: fileId, data: null },
         });
-        simulariumController.changeFile(
-            {
-                netConnectionSettings: this.netConnectionSettings,
-                requestJson: true,
-            },
-            fileId
-        );
+        simulariumController.changeFile({
+            fileName: fileId,
+            netConnectionSettings: this.netConnectionSettings,
+            requestJson: true,
+        });
     }
 
     private handleFileSelect(file: string) {
@@ -626,8 +621,17 @@ class Viewer extends React.Component<InputParams, ViewerState> {
             return;
         }
         if (fileId.simulatorType === SimulatorModes.localClientSimulator) {
-            const clientSim = this.configureLocalClientSimulator(fileId.id);
-            simulariumController.changeFile(clientSim, fileId.id);
+            const { clientSimulator } = this.configureLocalClientSimulator(
+                fileId.id
+            );
+            if (!clientSimulator) {
+                console.warn("No client simulator implementation found");
+                return;
+            }
+            simulariumController.changeFile({
+                fileName: fileId.id,
+                clientSimulatorImpl: clientSimulator,
+            });
             this.setState({
                 clientSimulator: true,
             });
@@ -640,12 +644,10 @@ class Viewer extends React.Component<InputParams, ViewerState> {
             this.setState({
                 simulariumFile: { name: fileId.id, data: null },
             });
-            simulariumController.changeFile(
-                {
-                    netConnectionSettings: this.netConnectionSettings,
-                },
-                fileId.id
-            );
+            simulariumController.changeFile({
+                fileName: fileId.id,
+                netConnectionSettings: this.netConnectionSettings,
+            });
         }
     }
 
@@ -748,7 +750,6 @@ class Viewer extends React.Component<InputParams, ViewerState> {
                 <ConversionForm
                     {...this.state.filePending}
                     submitFile={(obj) => this.convertFile(obj, fileType)}
-                    onReturned={this.clearPendingFile}
                 />
             );
         }

src/simularium/ClientSimulator.ts → src/Simulator/ClientSimulator.ts

@@ -1,19 +1,19 @@
 import jsLogger from "js-logger";
 import { ILogger } from "js-logger";
 
+import { ISimulator } from "../Simulator/ISimulator.js";
+import {
+    IClientSimulatorImpl,
+    ClientMessageEnum,
+} from "../simularium/index.js";
 import {
-    VisDataMessage,
     TrajectoryFileInfo,
-    PlotConfig,
-    Plot,
+    VisDataMessage,
     Metrics,
-} from "./types.js";
-import {
-    ClientMessageEnum,
-    ClientPlayBackType,
-    IClientSimulatorImpl,
-} from "./localSimulators/IClientSimulatorImpl.js";
-import { ISimulator } from "./ISimulator.js";
+    Plot,
+    PlotConfig,
+} from "../simularium/types.js";
+import { ClientSimulatorParams } from "./types.js";
 
 // a ClientSimulator is a ISimulator that is expected to run purely in procedural javascript in the browser client,
 // with the procedural implementation in a IClientSimulatorImpl
@@ -30,7 +30,11 @@ export class ClientSimulator implements ISimulator {
     public onPlotDataArrive: (msg: Plot[]) => void;
     public handleError: (error: Error) => void;
 
-    public constructor(sim: IClientSimulatorImpl) {
+    public constructor(params: ClientSimulatorParams) {
+        const { clientSimulatorImpl } = params;
+        if (!clientSimulatorImpl) {
+            throw new Error("ClientSimulator requires a IClientSimulatorImpl");
+        }
         this.logger = jsLogger.get("netconnection");
         this.logger.setLevel(jsLogger.DEBUG);
 
@@ -49,7 +53,7 @@ export class ClientSimulator implements ISimulator {
         this.onPlotDataArrive = () => {
             /* do nothing */
         };
-        this.localSimulator = sim;
+        this.localSimulator = clientSimulatorImpl;
     }
 
     public setTrajectoryFileInfoHandler(
@@ -168,7 +172,6 @@ export class ClientSimulator implements ISimulator {
     public initialize(fileName: string): Promise<void> {
         const jsonData = {
             msgType: ClientMessageEnum.ID_VIS_DATA_REQUEST,
-            mode: ClientPlayBackType.ID_TRAJECTORY_FILE_PLAYBACK,
             fileName: fileName,
         };
 
@@ -205,7 +208,6 @@ export class ClientSimulator implements ISimulator {
         this.sendSimulationRequest(
             {
                 msgType: ClientMessageEnum.ID_VIS_DATA_REQUEST,
-                mode: ClientPlayBackType.ID_TRAJECTORY_FILE_PLAYBACK,
                 frameNumber: startFrameNumber,
             },
             "Request Single Frame"

src/simularium/ISimulator.ts → src/Simulator/ISimulator.ts

@@ -4,7 +4,7 @@ import {
     PlotConfig,
     Plot,
     Metrics,
-} from "./types.js";
+} from "../simularium/types.js";
 
 /**
 From the caller's perspective, this interface is a contract for a 

src/simularium/LocalFileSimulator.ts → src/Simulator/LocalFileSimulator.ts

@@ -8,9 +8,10 @@ import {
     PlotConfig,
     Plot,
     Metrics,
-} from "./types.js";
+} from "../simularium/types.js";
 import { ISimulator } from "./ISimulator.js";
-import type { ISimulariumFile } from "./ISimulariumFile.js";
+import type { ISimulariumFile } from "../simularium/ISimulariumFile.js";
+import { LocalFileSimulatorParams } from "./types.js";
 
 // a LocalFileSimulator is a ISimulator that plays back the contents of
 // a drag-n-drop trajectory file (a ISimulariumFile object)
@@ -27,8 +28,12 @@ export class LocalFileSimulator implements ISimulator {
     private playbackIntervalId = 0;
     private currentPlaybackFrameIndex = 0;
 
-    public constructor(simulariumFile: ISimulariumFile) {
-        this.fileName = "";
+    public constructor(params: LocalFileSimulatorParams) {
+        const { fileName, simulariumFile } = params;
+        if (!simulariumFile) {
+            throw new Error("LocalFileSimulator requires a ISimulariumFile");
+        }
+        this.fileName = fileName;
         this.simulariumFile = simulariumFile;
         this.logger = jsLogger.get("netconnection");
         this.logger.setLevel(jsLogger.DEBUG);

src/simularium/RemoteSimulator.ts → src/Simulator/RemoteSimulator.ts

@@ -1,24 +1,24 @@
 import jsLogger from "js-logger";
 import { ILogger } from "js-logger";
-import { FrontEndError, ErrorLevel } from "./FrontEndError.js";
+import { FrontEndError, ErrorLevel } from "../simularium/FrontEndError.js";
 import {
     NetMessageEnum,
     MessageEventLike,
     WebsocketClient,
-} from "./WebsocketClient.js";
+} from "../simularium/WebsocketClient.js";
 import type {
     NetMessage,
     ErrorMessage,
-    NetConnectionParams,
-} from "./WebsocketClient.js";
+} from "../simularium/WebsocketClient.js";
 import { ISimulator } from "./ISimulator.js";
 import {
     Metrics,
     Plot,
     PlotConfig,
     TrajectoryFileInfoV2,
     VisDataMessage,
-} from "./types.js";
+} from "../simularium/types.js";
+import { RemoteSimulatorParams } from "./types.js";
 
 // a RemoteSimulator is a ISimulator that connects to the Octopus backend server
 // and plays back a trajectory specified in the NetConnectionParams
@@ -34,15 +34,20 @@ export class RemoteSimulator implements ISimulator {
     private jsonResponse: boolean;
 
     public constructor(
-        netConnectionSettings: NetConnectionParams,
-        errorHandler?: (error: FrontEndError) => void,
-        jsonResponse = false
+        params: RemoteSimulatorParams,
+        errorHandler?: (error: FrontEndError) => void
     ) {
+        const { netConnectionSettings, fileName, requestJson = false } = params;
+        if (!params.netConnectionSettings || !params.fileName) {
+            throw new FrontEndError(
+                "RemoteSimulator requires NetConnectionParams and file name."
+            );
+        }
         this.webSocketClient = new WebsocketClient(
             netConnectionSettings,
             errorHandler
         );
-        this.lastRequestedFile = "";
+        this.lastRequestedFile = fileName;
         this.handleError =
             errorHandler ||
             (() => {
@@ -51,7 +56,7 @@ export class RemoteSimulator implements ISimulator {
 
         this.logger = jsLogger.get("netconnection");
         this.logger.setLevel(jsLogger.DEBUG);
-        this.jsonResponse = jsonResponse;
+        this.jsonResponse = requestJson;
 
         this.onTrajectoryFileInfoArrive = () => {
             /* do nothing */
@@ -87,6 +92,10 @@ export class RemoteSimulator implements ISimulator {
         this.handleError = handler;
     }
 
+    public isConnectedToRemoteServer(): boolean {
+        return this.webSocketClient.socketIsValid();
+    }
+
     /**
      * WebSocket Simulation Control
      */

src/Simulator/SimulatorFactory.ts

@@ -0,0 +1,33 @@
+import { ClientSimulator } from "./ClientSimulator";
+import { LocalFileSimulator } from "./LocalFileSimulator";
+import { RemoteSimulator } from "./RemoteSimulator";
+import {
+    SimulatorParams,
+    RemoteSimulatorParams,
+    ClientSimulatorParams,
+    LocalFileSimulatorParams,
+} from "./types";
+
+export const getSimulatorClassFromParams = (params?: SimulatorParams) => {
+    if (!params || !params.fileName) {
+        return { simulatorClass: null, typedParams: null };
+    }
+    if ("netConnectionSettings" in params) {
+        return {
+            simulatorClass: RemoteSimulator,
+            typedParams: params as RemoteSimulatorParams,
+        };
+    } else if ("clientSimulatorImpl" in params) {
+        return {
+            simulatorClass: ClientSimulator,
+            typedParams: params as ClientSimulatorParams,
+        };
+    } else if ("simulariumFile" in params) {
+        return {
+            simulatorClass: LocalFileSimulator,
+            typedParams: params as LocalFileSimulatorParams,
+        };
+    } else {
+        return { simulatorClass: null, typedParams: null };
+    }
+};

src/Simulator/types.ts

@@ -0,0 +1,26 @@
+import { NetConnectionParams, IClientSimulatorImpl } from "../simularium";
+import { ISimulariumFile } from "../simularium/ISimulariumFile";
+
+export interface BaseSimulatorParams {
+    fileName: string;
+}
+
+export interface RemoteSimulatorParams extends BaseSimulatorParams {
+    netConnectionSettings?: NetConnectionParams;
+    requestJson?: boolean;
+    prefetchFrames?: boolean;
+}
+
+export interface ClientSimulatorParams extends BaseSimulatorParams {
+    clientSimulatorImpl?: IClientSimulatorImpl;
+}
+
+export interface LocalFileSimulatorParams extends BaseSimulatorParams {
+    simulariumFile?: ISimulariumFile;
+    geoAssets?: { [key: string]: string };
+}
+
+export type SimulatorParams =
+    | RemoteSimulatorParams
+    | ClientSimulatorParams
+    | LocalFileSimulatorParams;