molstar 3.0.0-dev.6 → 3.0.0

package/lib/mol-plugin/features.js

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2021 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ *
+ * @author David Sehnal <david.sehnal@gmail.com>
+ */
+export var PluginFeatureDetection = {
+    get preferWebGl1() {
+        if (typeof navigator === 'undefined' || typeof window === 'undefined')
+            return false;
+        // WebGL2 isn't working in MacOS 12.0.1 Safari 15.1, 15.2. It is working in Safari 15.4 tech preview, so disabling all versions before that.
+        // prefer webgl 1 based on the userAgent substring
+        var unpportedSafariVersions = [
+            'Version/15.1 Safari',
+            'Version/15.2 Safari',
+            'Version/15.3 Safari'
+        ];
+        if (unpportedSafariVersions.some(function (v) { return navigator.userAgent.indexOf(v) > 0; })) {
+            return true;
+        }
+        // Check for iOS device which enabled WebGL2 recently but it doesn't seem
+        // to be full up to speed yet.
+        // adapted from https://stackoverflow.com/questions/9038625/detect-if-device-is-ios
+        var isIOS = /iPad|iPhone|iPod/.test(navigator.userAgent);
+        var isAppleDevice = navigator.userAgent.includes('Macintosh');
+        var isTouchScreen = navigator.maxTouchPoints >= 4; // true for iOS 13 (and hopefully beyond)
+        return !window.MSStream && (isIOS || (isAppleDevice && isTouchScreen));
+    },
+    get wboit() {
+        if (typeof navigator === 'undefined' || typeof window === 'undefined')
+            return true;
+        // disable Wboit in Safari 15
+        return !/Version\/15.\d Safari/.test(navigator.userAgent);
+    }
+};
+//# sourceMappingURL=features.js.map

package/lib/mol-plugin/spec.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2018-2021 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2018-2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author David Sehnal <david.sehnal@gmail.com>
  * @author Alexander Rose <alexander.rose@weirdbyte.de>

package/lib/mol-plugin/spec.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2018-2021 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2018-2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author David Sehnal <david.sehnal@gmail.com>
  * @author Alexander Rose <alexander.rose@weirdbyte.de>
@@ -16,6 +16,7 @@ import { StateTransforms } from '../mol-plugin-state/transforms';
 import { BoxifyVolumeStreaming, CreateVolumeStreamingBehavior, InitVolumeStreaming } from '../mol-plugin/behavior/dynamic/volume-streaming/transformers';
 import { AnimateStateInterpolation } from '../mol-plugin-state/animation/built-in/state-interpolation';
 import { AnimateStructureSpin } from '../mol-plugin-state/animation/built-in/spin-structure';
+import { AnimateCameraRock } from '../mol-plugin-state/animation/built-in/camera-rock';
 export { PluginSpec };
 var PluginSpec;
 (function (PluginSpec) {
@@ -67,6 +68,7 @@ export var DefaultPluginSpec = function () { return ({
         PluginSpec.Action(StateTransforms.Representation.UnwindStructureAssemblyRepresentation3D),
         PluginSpec.Action(StateTransforms.Representation.OverpaintStructureRepresentation3DFromScript),
         PluginSpec.Action(StateTransforms.Representation.TransparencyStructureRepresentation3DFromScript),
+        PluginSpec.Action(StateTransforms.Representation.ClippingStructureRepresentation3DFromScript),
         PluginSpec.Action(StateTransforms.Representation.SubstanceStructureRepresentation3DFromScript),
         PluginSpec.Action(AssignColorVolume),
         PluginSpec.Action(StateTransforms.Volume.VolumeFromCcp4),
@@ -94,6 +96,7 @@ export var DefaultPluginSpec = function () { return ({
     animations: [
         AnimateModelIndex,
         AnimateCameraSpin,
+        AnimateCameraRock,
         AnimateStateSnapshots,
         AnimateAssemblyUnwind,
         AnimateStructureSpin,

package/lib/mol-plugin/util/viewport-screenshot.d.ts

@@ -45,6 +45,10 @@ declare class ViewportScreenshotHelper extends PluginComponent {
                 roughness: number;
                 bumpiness: number;
             }>;
+            clip: PD.Normalize<{
+                variant: any;
+                objects: any;
+            }>;
         }>, "on">>;
     };
     readonly behaviors: {
@@ -73,6 +77,10 @@ declare class ViewportScreenshotHelper extends PluginComponent {
                     roughness: number;
                     bumpiness: number;
                 }>;
+                clip: PD.Normalize<{
+                    variant: any;
+                    objects: any;
+                }>;
             }>, "on">>;
         }>>;
         cropParams: import("rxjs").BehaviorSubject<{
@@ -109,6 +117,10 @@ declare class ViewportScreenshotHelper extends PluginComponent {
                 roughness: number;
                 bumpiness: number;
             }>;
+            clip: PD.Normalize<{
+                variant: any;
+                objects: any;
+            }>;
         }>, "on">>;
     }>;
     get cropParams(): {

package/lib/mol-plugin/version.js

@@ -1,2 +1,2 @@
-export var PLUGIN_VERSION = '3.0.0-dev.6';
-export var PLUGIN_VERSION_DATE = new Date(typeof __MOLSTAR_DEBUG_TIMESTAMP__ !== 'undefined' ? __MOLSTAR_DEBUG_TIMESTAMP__ : 1639948444658);
+export var PLUGIN_VERSION = '3.0.0';
+export var PLUGIN_VERSION_DATE = new Date(typeof __MOLSTAR_DEBUG_TIMESTAMP__ !== 'undefined' ? __MOLSTAR_DEBUG_TIMESTAMP__ : 1642990267291);

package/lib/mol-plugin-state/actions/file.d.ts

@@ -4,15 +4,16 @@
  * @author Alexander Rose <alexander.rose@weirdbyte.de>
  */
 import { StateAction } from '../../mol-state';
+import { Asset } from '../../mol-util/assets';
 import { ParamDefinition as PD } from '../../mol-util/param-definition';
 import { PluginStateObject } from '../objects';
 export declare const OpenFiles: StateAction<PluginStateObject.Root, void, PD.Normalize<{
-    files: import("../../mol-util/assets").Asset.File[] | null;
+    files: Asset.File[] | null;
     format: PD.NamedParams<PD.Normalize<unknown>, "auto"> | PD.NamedParams<string, "specific">;
     visuals: boolean;
 }>>;
 export declare const DownloadFile: StateAction<PluginStateObject.Root, void, PD.Normalize<{
-    url: string | import("../../mol-util/assets").Asset.Url;
+    url: string | Asset.Url;
     format: string;
     isBinary: boolean;
     visuals: boolean;

package/lib/mol-plugin-state/actions/file.js

@@ -6,8 +6,10 @@
 import { __awaiter, __generator } from "tslib";
 import { StateAction } from '../../mol-state';
 import { Task } from '../../mol-task';
+import { Asset } from '../../mol-util/assets';
 import { getFileInfo } from '../../mol-util/file-info';
 import { ParamDefinition as PD } from '../../mol-util/param-definition';
+import { unzip } from '../../mol-util/zip/zip';
 import { PluginStateObject } from '../objects';
 export var OpenFiles = StateAction.build({
     display: { name: 'Open Files', description: 'Load one or more files and optionally create default visuals' },
@@ -31,53 +33,87 @@ export var OpenFiles = StateAction.build({
                 case 0:
                     plugin.behaviors.layout.leftPanelTabName.next('data');
                     return [4 /*yield*/, state.transaction(function () { return __awaiter(void 0, void 0, void 0, function () {
-                            var _i, _a, file, info, isBinary, data, provider, parsed, e_1;
-                            var _b, _c;
-                            return __generator(this, function (_d) {
-                                switch (_d.label) {
+                            var processFile, _i, _a, file, zippedFiles, _b, _c, _d, _e, _f, fn, filedata, asset, e_1;
+                            return __generator(this, function (_g) {
+                                switch (_g.label) {
                                     case 0:
                                         if (params.files === null) {
                                             plugin.log.error('No file(s) selected');
                                             return [2 /*return*/];
                                         }
+                                        processFile = function (file) { return __awaiter(void 0, void 0, void 0, function () {
+                                            var info, isBinary, data, provider, parsed;
+                                            var _a, _b;
+                                            return __generator(this, function (_c) {
+                                                switch (_c.label) {
+                                                    case 0:
+                                                        info = getFileInfo(file.file);
+                                                        isBinary = plugin.dataFormats.binaryExtensions.has(info.ext);
+                                                        return [4 /*yield*/, plugin.builders.data.readFile({ file: file, isBinary: isBinary })];
+                                                    case 1:
+                                                        data = (_c.sent()).data;
+                                                        provider = params.format.name === 'auto'
+                                                            ? plugin.dataFormats.auto(info, (_a = data.cell) === null || _a === void 0 ? void 0 : _a.obj)
+                                                            : plugin.dataFormats.get(params.format.params);
+                                                        if (!provider) {
+                                                            plugin.log.warn("OpenFiles: could not find data provider for '".concat(info.name, ".").concat(info.ext, "'"));
+                                                            return [2 /*return*/];
+                                                        }
+                                                        return [4 /*yield*/, provider.parse(plugin, data)];
+                                                    case 2:
+                                                        parsed = _c.sent();
+                                                        if (!params.visuals) return [3 /*break*/, 4];
+                                                        return [4 /*yield*/, ((_b = provider.visuals) === null || _b === void 0 ? void 0 : _b.call(provider, plugin, parsed))];
+                                                    case 3:
+                                                        _c.sent();
+                                                        _c.label = 4;
+                                                    case 4: return [2 /*return*/];
+                                                }
+                                            });
+                                        }); };
                                         _i = 0, _a = params.files;
-                                        _d.label = 1;
+                                        _g.label = 1;
                                     case 1:
-                                        if (!(_i < _a.length)) return [3 /*break*/, 9];
+                                        if (!(_i < _a.length)) return [3 /*break*/, 14];
                                         file = _a[_i];
-                                        _d.label = 2;
+                                        _g.label = 2;
                                     case 2:
-                                        _d.trys.push([2, 7, , 8]);
-                                        info = getFileInfo(file.file);
-                                        isBinary = plugin.dataFormats.binaryExtensions.has(info.ext);
-                                        return [4 /*yield*/, plugin.builders.data.readFile({ file: file, isBinary: isBinary })];
-                                    case 3:
-                                        data = (_d.sent()).data;
-                                        provider = params.format.name === 'auto'
-                                            ? plugin.dataFormats.auto(info, (_b = data.cell) === null || _b === void 0 ? void 0 : _b.obj)
-                                            : plugin.dataFormats.get(params.format.params);
-                                        if (!provider) {
-                                            plugin.log.warn("OpenFiles: could not find data provider for '".concat(info.name, ".").concat(info.ext, "'"));
-                                            return [3 /*break*/, 8];
-                                        }
-                                        return [4 /*yield*/, provider.parse(plugin, data)];
+                                        _g.trys.push([2, 12, , 13]);
+                                        if (!(file.file && file.name.toLowerCase().endsWith('.zip'))) return [3 /*break*/, 9];
+                                        _b = unzip;
+                                        _c = [taskCtx];
+                                        return [4 /*yield*/, file.file.arrayBuffer()];
+                                    case 3: return [4 /*yield*/, _b.apply(void 0, _c.concat([_g.sent()]))];
                                     case 4:
-                                        parsed = _d.sent();
-                                        if (!params.visuals) return [3 /*break*/, 6];
-                                        return [4 /*yield*/, ((_c = provider.visuals) === null || _c === void 0 ? void 0 : _c.call(provider, plugin, parsed))];
+                                        zippedFiles = _g.sent();
+                                        _d = 0, _e = Object.entries(zippedFiles);
+                                        _g.label = 5;
                                     case 5:
-                                        _d.sent();
-                                        _d.label = 6;
-                                    case 6: return [3 /*break*/, 8];
+                                        if (!(_d < _e.length)) return [3 /*break*/, 8];
+                                        _f = _e[_d], fn = _f[0], filedata = _f[1];
+                                        asset = Asset.File(new File([filedata], fn));
+                                        return [4 /*yield*/, processFile(asset)];
+                                    case 6:
+                                        _g.sent();
+                                        _g.label = 7;
                                     case 7:
-                                        e_1 = _d.sent();
+                                        _d++;
+                                        return [3 /*break*/, 5];
+                                    case 8: return [3 /*break*/, 11];
+                                    case 9: return [4 /*yield*/, processFile(file)];
+                                    case 10:
+                                        _g.sent();
+                                        _g.label = 11;
+                                    case 11: return [3 /*break*/, 13];
+                                    case 12:
+                                        e_1 = _g.sent();
                                         console.error(e_1);
                                         plugin.log.error("Error opening file '".concat(file.name, "'"));
-                                        return [3 /*break*/, 8];
-                                    case 8:
+                                        return [3 /*break*/, 13];
+                                    case 13:
                                         _i++;
                                         return [3 /*break*/, 1];
-                                    case 9: return [2 /*return*/];
+                                    case 14: return [2 /*return*/];
                                 }
                             });
                         }); }).runInContext(taskCtx)];

package/lib/mol-plugin-state/actions/structure.d.ts

@@ -14,6 +14,7 @@ export declare const PdbDownloadProvider: {
     pdbe: PD.Group<PD.Normalize<{
         variant: "updated" | "updated-bcif" | "updtaed-bcif" | "archival";
     }>>;
+    pdbj: PD.Group<PD.Normalize<unknown>>;
 };
 export declare type PdbDownloadProvider = keyof typeof PdbDownloadProvider;
 export { DownloadStructure };

package/lib/mol-plugin-state/actions/structure.js

@@ -17,6 +17,7 @@ import { CustomModelProperties, CustomStructureProperties, TrajectoryFromModelAn
 import { Asset } from '../../mol-util/assets';
 import { PluginConfig } from '../../mol-plugin/config';
 import { getFileInfo } from '../../mol-util/file-info';
+import { assertUnreachable } from '../../mol-util/type-helpers';
 var DownloadModelRepresentationOptions = function (plugin) {
     var representationDefault = plugin.config.get(PluginConfig.Structure.DefaultRepresentationPreset) || PresetStructureRepresentations.auto.id;
     return PD.Group({
@@ -33,6 +34,7 @@ export var PdbDownloadProvider = {
     'pdbe': PD.Group({
         variant: PD.Select('updated-bcif', [['updated-bcif', 'Updated (bcif)'], ['updated', 'Updated'], ['archival', 'Archival']]),
     }, { label: 'PDBe', isFlat: true }),
+    'pdbj': PD.EmptyGroup({ label: 'PDBj' }),
 };
 export { DownloadStructure };
 var DownloadStructure = StateAction.build({
@@ -108,14 +110,12 @@ var DownloadStructure = StateAction.build({
                     format = src.params.format;
                     return [3 /*break*/, 15];
                 case 2: return [4 /*yield*/, (src.params.provider.server.name === 'pdbe'
-                        ? src.params.provider.server.params.variant === 'updated'
-                            ? getDownloadParams(src.params.provider.id, function (id) { return "https://www.ebi.ac.uk/pdbe/static/entry/".concat(id.toLowerCase(), "_updated.cif"); }, function (id) { return "PDBe: ".concat(id, " (updated cif)"); }, false)
-                            : src.params.provider.server.params.variant === 'updated-bcif'
-                                ? getDownloadParams(src.params.provider.id, function (id) { return "https://www.ebi.ac.uk/pdbe/entry-files/download/".concat(id.toLowerCase(), ".bcif"); }, function (id) { return "PDBe: ".concat(id, " (updated cif)"); }, true)
-                                : getDownloadParams(src.params.provider.id, function (id) { return "https://www.ebi.ac.uk/pdbe/static/entry/".concat(id.toLowerCase(), ".cif"); }, function (id) { return "PDBe: ".concat(id, " (cif)"); }, false)
-                        : src.params.provider.server.params.encoding === 'cif'
-                            ? getDownloadParams(src.params.provider.id, function (id) { return "https://files.rcsb.org/download/".concat(id.toUpperCase(), ".cif"); }, function (id) { return "RCSB: ".concat(id, " (cif)"); }, false)
-                            : getDownloadParams(src.params.provider.id, function (id) { return "https://models.rcsb.org/".concat(id.toUpperCase(), ".bcif"); }, function (id) { return "RCSB: ".concat(id, " (bcif)"); }, true))];
+                        ? getPdbeDownloadParams(src)
+                        : src.params.provider.server.name === 'pdbj'
+                            ? getPdbjDownloadParams(src)
+                            : src.params.provider.server.name === 'rcsb'
+                                ? getRcsbDownloadParams(src)
+                                : assertUnreachable(src))];
                 case 3:
                     downloadParams = _b.sent();
                     asTrajectory = !!src.params.options.asTrajectory;
@@ -267,6 +267,39 @@ function getDownloadParams(src, url, label, isBinary) {
         });
     });
 }
+function getPdbeDownloadParams(src) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (src.name !== 'pdb' || src.params.provider.server.name !== 'pdbe')
+                throw new Error('expected pdbe');
+            return [2 /*return*/, src.params.provider.server.params.variant === 'updated'
+                    ? getDownloadParams(src.params.provider.id, function (id) { return "https://www.ebi.ac.uk/pdbe/static/entry/".concat(id.toLowerCase(), "_updated.cif"); }, function (id) { return "PDBe: ".concat(id, " (updated cif)"); }, false)
+                    : src.params.provider.server.params.variant === 'updated-bcif'
+                        ? getDownloadParams(src.params.provider.id, function (id) { return "https://www.ebi.ac.uk/pdbe/entry-files/download/".concat(id.toLowerCase(), ".bcif"); }, function (id) { return "PDBe: ".concat(id, " (updated cif)"); }, true)
+                        : getDownloadParams(src.params.provider.id, function (id) { return "https://www.ebi.ac.uk/pdbe/static/entry/".concat(id.toLowerCase(), ".cif"); }, function (id) { return "PDBe: ".concat(id, " (cif)"); }, false)];
+        });
+    });
+}
+function getPdbjDownloadParams(src) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (src.name !== 'pdb' || src.params.provider.server.name !== 'pdbj')
+                throw new Error('expected pdbj');
+            return [2 /*return*/, getDownloadParams(src.params.provider.id, function (id) { return "https://data.pdbjbk1.pdbj.org/pub/pdb/data/structures/divided/mmCIF/".concat(id.toLowerCase().substring(1, 3), "/").concat(id.toLowerCase(), ".cif"); }, function (id) { return "PDBj: ".concat(id, " (cif)"); }, false)];
+        });
+    });
+}
+function getRcsbDownloadParams(src) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (src.name !== 'pdb' || src.params.provider.server.name !== 'rcsb')
+                throw new Error('expected rcsb');
+            return [2 /*return*/, src.params.provider.server.params.encoding === 'cif'
+                    ? getDownloadParams(src.params.provider.id, function (id) { return "https://files.rcsb.org/download/".concat(id.toUpperCase(), ".cif"); }, function (id) { return "RCSB PDB: ".concat(id, " (cif)"); }, false)
+                    : getDownloadParams(src.params.provider.id, function (id) { return "https://models.rcsb.org/".concat(id.toUpperCase(), ".bcif"); }, function (id) { return "RCSB PDB: ".concat(id, " (bcif)"); }, true)];
+        });
+    });
+}
 export var UpdateTrajectory = StateAction.build({
     display: { name: 'Update Trajectory' },
     params: {

package/lib/mol-plugin-state/animation/built-in/camera-rock.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ *
+ * @author Alexander Rose <alexander.rose@weirdbyte.de>
+ */
+import { Camera } from '../../../mol-canvas3d/camera';
+import { PluginStateAnimation } from '../model';
+declare type State = {
+    snapshot: Camera.Snapshot;
+};
+export declare const AnimateCameraRock: PluginStateAnimation<{
+    durationInMs: number;
+    speed: number;
+    angle: number;
+}, State | undefined>;
+export {};

package/lib/mol-plugin-state/animation/built-in/camera-rock.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) 2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ *
+ * @author Alexander Rose <alexander.rose@weirdbyte.de>
+ */
+import { __assign, __awaiter, __generator } from "tslib";
+import { clamp } from '../../../mol-math/interpolate';
+import { Quat } from '../../../mol-math/linear-algebra/3d/quat';
+import { Vec3 } from '../../../mol-math/linear-algebra/3d/vec3';
+import { degToRad } from '../../../mol-math/misc';
+import { ParamDefinition as PD } from '../../../mol-util/param-definition';
+import { PluginStateAnimation } from '../model';
+var _dir = Vec3(), _axis = Vec3(), _rot = Quat();
+export var AnimateCameraRock = PluginStateAnimation.create({
+    name: 'built-in.animate-camera-rock',
+    display: { name: 'Camera Rock', description: 'Rock the 3D scene around the x-axis in view space' },
+    isExportable: true,
+    params: function () { return ({
+        durationInMs: PD.Numeric(4000, { min: 100, max: 20000, step: 100 }),
+        speed: PD.Numeric(1, { min: 1, max: 10, step: 1 }, { description: 'How many times to rock from side to side.' }),
+        angle: PD.Numeric(10, { min: 0, max: 180, step: 1 }, { description: 'How many degrees to rotate in each direction.' }),
+    }); },
+    initialState: function (p, ctx) { return ({ snapshot: ctx.canvas3d.camera.getSnapshot() }); },
+    getDuration: function (p) { return ({ kind: 'fixed', durationMs: p.durationInMs }); },
+    teardown: function (_, state, ctx) {
+        var _a;
+        (_a = ctx.canvas3d) === null || _a === void 0 ? void 0 : _a.requestCameraReset({ snapshot: state.snapshot, durationMs: 0 });
+    },
+    apply: function (animState, t, ctx) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var snapshot, phase, angle, position;
+            return __generator(this, function (_c) {
+                if (t.current === 0) {
+                    return [2 /*return*/, { kind: 'next', state: animState }];
+                }
+                snapshot = animState.snapshot;
+                if (snapshot.radiusMax < 0.0001) {
+                    return [2 /*return*/, { kind: 'finished' }];
+                }
+                phase = t.animation
+                    ? ((_a = t.animation) === null || _a === void 0 ? void 0 : _a.currentFrame) / (t.animation.frameCount + 1)
+                    : clamp(t.current / ctx.params.durationInMs, 0, 1);
+                angle = Math.sin(phase * ctx.params.speed * Math.PI * 2) * degToRad(ctx.params.angle);
+                Vec3.sub(_dir, snapshot.position, snapshot.target);
+                Vec3.normalize(_axis, snapshot.up);
+                Quat.setAxisAngle(_rot, _axis, angle);
+                Vec3.transformQuat(_dir, _dir, _rot);
+                position = Vec3.add(Vec3(), snapshot.target, _dir);
+                (_b = ctx.plugin.canvas3d) === null || _b === void 0 ? void 0 : _b.requestCameraReset({ snapshot: __assign(__assign({}, snapshot), { position: position }), durationMs: 0 });
+                if (phase >= 0.99999) {
+                    return [2 /*return*/, { kind: 'finished' }];
+                }
+                return [2 /*return*/, { kind: 'next', state: animState }];
+            });
+        });
+    }
+});
+//# sourceMappingURL=camera-rock.js.map

package/lib/mol-plugin-state/animation/built-in/camera-spin.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2020-2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author David Sehnal <david.sehnal@gmail.com>
  */

package/lib/mol-plugin-state/animation/built-in/camera-spin.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2020-2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author David Sehnal <david.sehnal@gmail.com>
  */
@@ -12,11 +12,11 @@ import { PluginStateAnimation } from '../model';
 var _dir = Vec3(), _axis = Vec3(), _rot = Quat();
 export var AnimateCameraSpin = PluginStateAnimation.create({
     name: 'built-in.animate-camera-spin',
-    display: { name: 'Camera Spin' },
+    display: { name: 'Camera Spin', description: 'Spin the 3D scene around the x-axis in view space' },
     isExportable: true,
     params: function () { return ({
         durationInMs: PD.Numeric(4000, { min: 100, max: 20000, step: 100 }),
-        speed: PD.Numeric(1, { min: 1, max: 10, step: 1 }, { description: 'How many times to spin in the specified dutation.' }),
+        speed: PD.Numeric(1, { min: 1, max: 10, step: 1 }, { description: 'How many times to spin in the specified duration.' }),
         direction: PD.Select('cw', [['cw', 'Clockwise'], ['ccw', 'Counter Clockwise']], { cycle: true })
     }); },
     initialState: function (_, ctx) { var _a; return ({ snapshot: (_a = ctx.canvas3d) === null || _a === void 0 ? void 0 : _a.camera.getSnapshot() }); },
@@ -37,11 +37,9 @@ export var AnimateCameraSpin = PluginStateAnimation.create({
                 if (snapshot.radiusMax < 0.0001) {
                     return [2 /*return*/, { kind: 'finished' }];
                 }
-                phase = clamp(t.current / ctx.params.durationInMs, 0, 1);
-                if (phase >= 0.99999) {
-                    (_a = ctx.plugin.canvas3d) === null || _a === void 0 ? void 0 : _a.requestCameraReset({ snapshot: snapshot, durationMs: 0 });
-                    return [2 /*return*/, { kind: 'finished' }];
-                }
+                phase = t.animation
+                    ? ((_a = t.animation) === null || _a === void 0 ? void 0 : _a.currentFrame) / (t.animation.frameCount + 1)
+                    : clamp(t.current / ctx.params.durationInMs, 0, 1);
                 angle = 2 * Math.PI * phase * ctx.params.speed * (ctx.params.direction === 'ccw' ? -1 : 1);
                 Vec3.sub(_dir, snapshot.position, snapshot.target);
                 Vec3.normalize(_axis, snapshot.up);
@@ -49,6 +47,9 @@ export var AnimateCameraSpin = PluginStateAnimation.create({
                 Vec3.transformQuat(_dir, _dir, _rot);
                 position = Vec3.add(Vec3(), snapshot.target, _dir);
                 (_b = ctx.plugin.canvas3d) === null || _b === void 0 ? void 0 : _b.requestCameraReset({ snapshot: __assign(__assign({}, snapshot), { position: position }), durationMs: 0 });
+                if (phase >= 0.99999) {
+                    return [2 /*return*/, { kind: 'finished' }];
+                }
                 return [2 /*return*/, { kind: 'next', state: animState }];
             });
         });

package/lib/mol-plugin-state/animation/model.d.ts

@@ -56,6 +56,10 @@ declare namespace PluginStateAnimation {
     interface Time {
         lastApplied: number;
         current: number;
+        animation?: {
+            currentFrame: number;
+            frameCount: number;
+        };
     }
     type ApplyResult<S> = {
         kind: 'finished';

package/lib/mol-plugin-state/builder/structure/hierarchy-preset.d.ts

@@ -28,7 +28,7 @@ export declare namespace TrajectoryHierarchyPresetProvider {
                 [x: string]: any;
             }>;
         }>> | undefined>;
-        representationPreset: PD.Base<"auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined>;
+        representationPreset: PD.Base<"auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined>;
     };
 }
 export declare const PresetTrajectoryHierarchy: {
@@ -41,7 +41,7 @@ export declare const PresetTrajectoryHierarchy: {
             autoAttach: any;
             properties: any;
         }>> | undefined;
-        representationPreset: "auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
+        representationPreset: "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
         model: PD.Normalize<PD.Normalize<{
             modelIndex: any;
         }>> | undefined;
@@ -86,7 +86,7 @@ export declare const PresetTrajectoryHierarchy: {
             autoAttach: any;
             properties: any;
         }>> | undefined;
-        representationPreset: "auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
+        representationPreset: "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
         useDefaultIfSingleModel: boolean | undefined;
         representationPresetParams: PD.Normalize<{
             ignoreHydrogens: any;
@@ -116,7 +116,7 @@ export declare const PresetTrajectoryHierarchy: {
             autoAttach: any;
             properties: any;
         }>> | undefined;
-        representationPreset: "auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
+        representationPreset: "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
         model: PD.Normalize<PD.Normalize<{
             modelIndex: any;
         }>> | undefined;
@@ -137,7 +137,7 @@ export declare const PresetTrajectoryHierarchy: {
             autoAttach: any;
             properties: any;
         }>> | undefined;
-        representationPreset: "auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
+        representationPreset: "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
         model: PD.Normalize<PD.Normalize<{
             modelIndex: any;
         }>> | undefined;
@@ -158,7 +158,7 @@ export declare const PresetTrajectoryHierarchy: {
             autoAttach: any;
             properties: any;
         }>> | undefined;
-        representationPreset: "auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
+        representationPreset: "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
         model: PD.Normalize<PD.Normalize<{
             modelIndex: any;
         }>> | undefined;

package/lib/mol-plugin-state/builder/structure/hierarchy.d.ts

@@ -23,7 +23,7 @@ export declare class TrajectoryHierarchyBuilder {
             autoAttach: any;
             properties: any;
         }>> | undefined;
-        representationPreset: "auto" | "empty" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
+        representationPreset: "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface" | undefined;
         model: PD.Normalize<PD.Normalize<{
             modelIndex: any;
         }>> | undefined;