Issue #877: switch from PluginUIContext to PluginContext

src/TmImageRenderer/index.ts

@@ -23,7 +23,7 @@ import { HeadlessPluginContext } from '../mol-plugin/headless-plugin-context';
 import { DefaultPluginSpec } from '../mol-plugin/spec';
 import { ExternalModules, STYLIZED_POSTPROCESSING } from '../mol-plugin/util/headless-screenshot';
 import { setFSModule } from '../mol-util/data-source';
-import { MembraneOrientationPreset, TMDETMembraneOrientation } from '../tmdet-extension/behavior';
+import { MembraneOrientationPreset } from '../tmdet-extension/behavior';
 import { TmDetColorThemeProvider } from '../tmdet-extension/tmdet-color-theme';
 import { TmDetLabelProvider } from '../tmdet-extension/labeling';
 

src/tmdet-extension/behavior.ts

@@ -24,7 +24,6 @@ import { DefaultQueryRuntimeTable } from '../mol-script/runtime/query/compiler';
 import { StructureSelectionQuery, StructureSelectionCategory } from '../mol-plugin-state/helpers/structure-selection-query';
 import { MolScriptBuilder as MS } from '../mol-script/language/builder';
 import { GenericRepresentationRef } from '../mol-plugin-state/manager/structure/hierarchy-state';
-import { PluginUIContext } from '../mol-plugin-ui/context';
 
 
 // TMDET imports
@@ -133,7 +132,7 @@ export const isTransmembrane = StructureSelectionQuery('Residues Embedded in Mem
 
 
 
-export async function loadWithUNITMPMembraneRepresentation(plugin: PluginUIContext, params: any) {
+export async function loadWithUNITMPMembraneRepresentation(plugin: PluginContext, params: any) {
     //storeCameraSnapshot(plugin); // store if it is not stored yet
 
     //loadInitialSnapshot(plugin); // load if there is a stored one
@@ -161,14 +160,14 @@ export async function loadWithUNITMPMembraneRepresentation(plugin: PluginUIConte
     })(); }, 500);
 }
 
-async function downloadRegionDescriptor(plugin: PluginUIContext, params: any): Promise<any> {
+async function downloadRegionDescriptor(plugin: PluginContext, params: any): Promise<any> {
     // run a fetch task
     const downloadResult: string = await plugin.runTask(plugin.fetch({ url: params.regionDescriptorUrl })) as string;
     const pdbtmDescriptor: any = JSON.parse(downloadResult);
     return pdbtmDescriptor;
 }
 
-async function createStructureRepresentation(plugin: PluginUIContext, pdbtmDescriptor: any) {
+async function createStructureRepresentation(plugin: PluginContext, pdbtmDescriptor: any) {
     // get the first structure of the first model
     const structure: StateObjectRef<PMS> = plugin.managers.structure.hierarchy.current.models[0].structures[0].cell;
     const components = await createStructureComponents(plugin, structure);
@@ -178,7 +177,7 @@ async function createStructureRepresentation(plugin: PluginUIContext, pdbtmDescr
     await buildStructureRepresentation(plugin, pdbtmDescriptor, components);
 }
 
-async function createStructureComponents(plugin: PluginUIContext, structure: StateObjectCell<PMS, StateTransform<StateTransformer<StateObject<any, StateObject.Type<any>>, StateObject<any, StateObject.Type<any>>, any>>>) {
+async function createStructureComponents(plugin: PluginContext, structure: StateObjectCell<PMS, StateTransform<StateTransformer<StateObject<any, StateObject.Type<any>>, StateObject<any, StateObject.Type<any>>, any>>>) {
     return {
         polymer: await plugin.builders.structure.tryCreateComponentStatic(structure, 'polymer'),
         ligand: await plugin.builders.structure.tryCreateComponentStatic(structure, 'ligand'),
@@ -186,7 +185,7 @@ async function createStructureComponents(plugin: PluginUIContext, structure: Sta
     };
 }
 
-async function buildStructureRepresentation(plugin: PluginUIContext, pdbtmDescriptor: PDBTMDescriptor, components: ComponentsType) {
+async function buildStructureRepresentation(plugin: PluginContext, pdbtmDescriptor: PDBTMDescriptor, components: ComponentsType) {
     const builder = plugin.builders.structure.representation;
     const update = plugin.build();
     if (components.polymer) {
@@ -204,7 +203,7 @@ async function buildStructureRepresentation(plugin: PluginUIContext, pdbtmDescri
     await update.commit();
 }
 
-async function loadStructure(ctx: PluginUIContext, params: any, pdbtmDescriptor: PDBTMDescriptor): Promise<void> {
+async function loadStructure(ctx: PluginContext, params: any, pdbtmDescriptor: PDBTMDescriptor): Promise<void> {
 
     // replace original symmetry format function
     registerTmDetSymmetry(pdbtmDescriptor);
@@ -236,7 +235,7 @@ async function loadStructure(ctx: PluginUIContext, params: any, pdbtmDescriptor:
 }
 
 
-async function downloadData(ctx: PluginUIContext, params: any, pdbtmDescriptor: PDBTMDescriptor) {
+async function downloadData(ctx: PluginContext, params: any, pdbtmDescriptor: PDBTMDescriptor) {
 
     const builders = ctx.builders;
     let downloadResult = await ctx.runTask(ctx.fetch({ url: params.structureUrl, type: "string" }));

src/tmdet-extension/camera.ts

@@ -1,66 +0,0 @@
-/**
- * Copyright (C) 2022, Protein Bioinformatics Research Group, RCNS
- *
- * Licensed under CC BY-NC 4.0, see LICENSE file for more info.
- *
- * @author Gabor Tusnady <tusnady.gabor@ttk.hu>
- * @author Csongor Gerdan <gerdan.csongor@ttk.hu>
- */
-
-import { PluginUIContext } from '../mol-plugin-ui/context';
-import { Quat, Vec3 } from '../mol-math/linear-algebra';
-import { PluginCommands } from '../mol-plugin/commands';
-import { Camera } from '../mol-canvas3d/camera';
-import { DebugUtil } from './debug-utils';
-
-let initialSnapshot: Camera.Snapshot;
-
-export function storeCameraSnapshot(plugin: PluginUIContext): void {
-    if (!initialSnapshot) {
-        initialSnapshot = plugin.canvas3d!.camera.getSnapshot();
-        DebugUtil.log('initialSnapshot stored:', initialSnapshot);
-    }
-}
-
-export function loadInitialSnapshot(plugin: PluginUIContext): void {
-    if (!initialSnapshot) {
-        DebugUtil.log('initialSnapshot is undefined');
-    } else {
-        DebugUtil.log('Loading initial snapshot:', initialSnapshot);
-        PluginCommands.Camera.Reset(plugin, { snapshot: initialSnapshot });
-    }
-}
-
-export async function rotateCamera(plugin: PluginUIContext) {
-    function rot90q(v: Vec3, axis: Vec3 = Vec3.create(1, 0, 0)): Vec3 {
-        const q = Quat.setAxisAngle(Quat(), axis, -Math.PI/2);
-        return Vec3.transformQuat(Vec3(), v, q);
-    }
-    function sub(v: Vec3, u: Vec3): Vec3 {
-        return Vec3.sub(Vec3(), v, u);
-    }
-    function add(v: Vec3, u: Vec3): Vec3 {
-        return Vec3.add(Vec3(), v, u);
-    }
-
-    if (!plugin.canvas3d) {
-        return;
-    }
-
-    const cam = plugin.canvas3d!.camera;
-    const snapshot = cam.getSnapshot();
-    const newSnapshot = {
-        ...snapshot,
-        // target + rotateBy90(postition - target)
-        position: add(snapshot.target, rot90q(sub(snapshot.position, snapshot.target))),
-        target: snapshot.target,
-        up: Vec3.negUnitZ
-    };
-    const duration = 100;
-    PluginCommands.Camera.Reset(plugin, { snapshot: newSnapshot, durationMs: duration }).then(() => {
-        setTimeout(()=> {
-            requestAnimationFrame(() => plugin.canvas3d?.requestCameraReset());
-        }, duration + 50); // The 2nd reset needs some delay
-    });
-
-}

src/tmdet-extension/debug-utils.ts

@@ -14,19 +14,18 @@ import { Model } from "../mol-model/structure";
 import { AtomicConformation } from "../mol-model/structure/model/properties/atomic";
 import { createStructureRepresentationParams } from "../mol-plugin-state/helpers/structure-representation-params";
 import { StateTransforms } from "../mol-plugin-state/transforms";
-import { PluginUIContext } from "../mol-plugin-ui/context";
+import { PluginContext } from "../mol-plugin/context";
 import { Expression } from "../mol-script/language/expression";
 import { Color } from "../mol-util/color";
-import { rotateCamera as RC } from "./camera";
 import { TmDetDescriptorCache } from "./prop";
 import { getChainExpression as GCE, getCurrentHierarchy as GCH, transformationForStateTransform, transformWholeModel } from "./transformation";
 import { PDBTMTransformationMatrix } from "./types";
 
 export namespace DebugUtil {
-    let plugin: PluginUIContext;
+    let plugin: PluginContext;
     let logEnabled = false;
 
-    export function init(ctx: PluginUIContext) {
+    export function init(ctx: PluginContext) {
         plugin = ctx;
     }
 
@@ -165,14 +164,4 @@ export namespace DebugUtil {
         transformWholeModel(plugin, tmx!);
     }
 
-    //
-    // Camera
-    //
-    export function rotateCamera() {
-        RC(plugin);
-    }
-
-    export function requestCameraReset() {
-        requestAnimationFrame(() => plugin.canvas3d?.requestCameraReset({ durationMs: 1000 }));
-    }
 }

tsconfig.renderer.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "es5",
+    "alwaysStrict": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "sourceMap": false,
+    "noUnusedLocals": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "module": "CommonJS",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "importHelpers": true,
+    "noEmitHelpers": true,
+    "allowSyntheticDefaultImports": true,
+    "jsx": "react",
+    "lib": [ "es6", "dom", "esnext.asynciterable", "es2016" ],
+    "rootDir": "src",
+    "outDir": "./lib/commonjs"
+  },
+  "include": [ "src/TmImageRenderer/*" ],
+  "exclude": [
+    "node_modules"
+  ]
+}