molstar
Version:
A comprehensive macromolecular library.
277 lines (276 loc) • 14.3 kB
JavaScript
/**
* Copyright (c) 2018-2025 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>
* @author Adam Midlik <midlik@gmail.com>
*/
import { produce } from '../mol-util/produce.js';
import { merge } from 'rxjs';
import { Canvas3DContext, Canvas3DParams } from '../mol-canvas3d/canvas3d.js';
import { PluginComponent } from '../mol-plugin-state/component.js';
import { PluginStateObject as SO } from '../mol-plugin-state/objects.js';
import { State } from '../mol-state/index.js';
import { UUID } from '../mol-util/index.js';
import { ParamDefinition as PD } from '../mol-util/param-definition.js';
import { PluginBehavior } from './behavior.js';
import { PluginCommands } from './commands.js';
import { PluginConfig } from './config.js';
import { AnimateStateSnapshotTransition } from '../mol-plugin-state/animation/built-in/state-snapshots.js';
import { Scheduler } from '../mol-task/index.js';
import { memoizeLatest } from '../mol-util/memoize.js';
export { PluginState };
class PluginState extends PluginComponent {
get animation() { return this.plugin.managers.animation; }
getSnapshot(params) {
var _a, _b, _c;
const p = { ...this.snapshotParams.value, ...params };
return {
id: UUID.create22(),
data: p.data ? this.data.getSnapshot() : void 0,
behaviour: p.behavior ? this.behaviors.getSnapshot() : void 0,
animation: p.animation ? this.animation.getSnapshot() : void 0,
startAnimation: p.startAnimation ? !!p.startAnimation : void 0,
camera: p.camera ? {
current: this.plugin.canvas3d.camera.getSnapshot(),
transitionStyle: p.cameraTransition.name,
transitionDurationInMs: ((_a = p === null || p === void 0 ? void 0 : p.cameraTransition) === null || _a === void 0 ? void 0 : _a.name) === 'animate' ? p.cameraTransition.params.durationInMs : void 0
} : void 0,
canvas3dContext: p.canvas3dContext ? { props: (_b = this.plugin.canvas3dContext) === null || _b === void 0 ? void 0 : _b.props } : void 0,
canvas3d: p.canvas3d ? { props: (_c = this.plugin.canvas3d) === null || _c === void 0 ? void 0 : _c.props } : void 0,
interactivity: p.interactivity ? { props: this.plugin.managers.interactivity.props } : void 0,
structureFocus: this.plugin.managers.structure.focus.getSnapshot(),
structureSelection: p.structureSelection ? this.plugin.managers.structure.selection.getSnapshot() : void 0,
structureComponentManager: p.componentManager ? {
options: this.plugin.managers.structure.component.state.options
} : void 0,
durationInMs: p === null || p === void 0 ? void 0 : p.durationInMs
};
}
async setSnapshot(snapshot) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
await this.animation.stop();
// this needs to go 1st since these changes are already baked into the behavior and data state
if ((_a = snapshot.structureComponentManager) === null || _a === void 0 ? void 0 : _a.options)
this.plugin.managers.structure.component._setSnapshotState((_b = snapshot.structureComponentManager) === null || _b === void 0 ? void 0 : _b.options);
if (snapshot.behaviour)
await this.plugin.runTask(this.behaviors.setSnapshot(snapshot.behaviour));
if (snapshot.data)
await this.plugin.runTask(this.data.setSnapshot(snapshot.data));
if ((_c = snapshot.canvas3d) === null || _c === void 0 ? void 0 : _c.props) {
const settings = PD.normalizeParams(Canvas3DParams, snapshot.canvas3d.props, 'children');
if (((_d = snapshot.camera) === null || _d === void 0 ? void 0 : _d.current) || ((_e = snapshot.camera) === null || _e === void 0 ? void 0 : _e.focus)) {
// Avoid multiple camera transitions (creates ugly cases when camera in old and new snapshot is the same)
settings.camera = undefined;
settings.cameraClipping = undefined;
settings.cameraFog = undefined;
}
await PluginCommands.Canvas3D.SetSettings(this.plugin, { settings });
}
if ((_f = snapshot.canvas3dContext) === null || _f === void 0 ? void 0 : _f.props) {
const props = PD.normalizeParams(Canvas3DContext.Params, snapshot.canvas3dContext.props, 'children');
(_g = this.plugin.canvas3dContext) === null || _g === void 0 ? void 0 : _g.setProps(props);
}
if (snapshot.interactivity) {
if (snapshot.interactivity.props)
this.plugin.managers.interactivity.setProps(snapshot.interactivity.props);
}
if (snapshot.structureFocus) {
this.plugin.managers.structure.focus.setSnapshot(snapshot.structureFocus);
}
if (snapshot.structureSelection) {
this.plugin.managers.structure.selection.setSnapshot(snapshot.structureSelection);
}
if (snapshot.animation) {
this.animation.setSnapshot(snapshot.animation);
}
if ((_h = snapshot.camera) === null || _h === void 0 ? void 0 : _h.current) {
PluginCommands.Camera.Reset(this.plugin, {
snapshot: snapshot.camera.current,
durationMs: snapshot.camera.transitionStyle === 'animate' ? snapshot.camera.transitionDurationInMs : undefined,
});
}
else if ((_j = snapshot.camera) === null || _j === void 0 ? void 0 : _j.focus) {
PluginCommands.Camera.FocusObject(this.plugin, {
...snapshot.camera.focus,
durationMs: snapshot.camera.transitionStyle === 'animate' ? snapshot.camera.transitionDurationInMs : undefined,
});
}
if (typeof (snapshot === null || snapshot === void 0 ? void 0 : snapshot.onLoadMarkdownCommands) === 'object' && Object.keys(snapshot.onLoadMarkdownCommands).length > 0) {
this.plugin.managers.markdownExtensions.tryExecute('click', snapshot.onLoadMarkdownCommands);
}
if (snapshot.startAnimation) {
this.animation.start();
return;
}
if ((_k = snapshot.transition) === null || _k === void 0 ? void 0 : _k.autoplay) {
await Scheduler.immediatePromise();
this.animation.play(AnimateStateSnapshotTransition, {});
}
}
async setAnimationSnapshot(snapshot, frameIndex) {
var _a, _b, _c, _d;
await this.animation.stopStateTransitionAnimation();
const { transition } = snapshot;
if (!transition)
return;
const finalIndex = Math.min(frameIndex, transition.frames.length - 1);
const frame = (_a = transition.frames[finalIndex]) !== null && _a !== void 0 ? _a : snapshot.data;
if (frame.data)
await this.plugin.runTask(this.data.setSnapshot(frame.data));
if ((_b = frame.canvas3d) === null || _b === void 0 ? void 0 : _b.props) {
const settings = PD.normalizeParams(Canvas3DParams, frame.canvas3d.props, 'children');
(_c = this.plugin.canvas3d) === null || _c === void 0 ? void 0 : _c.setProps(settings);
}
if ((_d = frame.camera) === null || _d === void 0 ? void 0 : _d.current) {
PluginCommands.Camera.Reset(this.plugin, {
snapshot: frame.camera.current,
durationMs: frame.camera.transitionStyle === 'animate' ? frame.camera.transitionDurationInMs : undefined,
});
}
if (!frameIndex && typeof (snapshot === null || snapshot === void 0 ? void 0 : snapshot.onLoadMarkdownCommands) === 'object' && Object.keys(snapshot.onLoadMarkdownCommands).length > 0) {
this.plugin.managers.markdownExtensions.tryExecute('click', snapshot.onLoadMarkdownCommands);
}
}
updateTransform(state, a, params, canUndo) {
const tree = state.build().to(a).update(params);
return PluginCommands.State.Update(this.plugin, { state, tree, options: { canUndo } });
}
hasBehavior(behavior) {
return this.behaviors.tree.transforms.has(behavior.id);
}
updateBehavior(behavior, params) {
const tree = this.behaviors.build();
if (!this.behaviors.tree.transforms.has(behavior.id)) {
const defaultParams = behavior.createDefaultParams(void 0, this.plugin);
tree.to(PluginBehavior.getCategoryId(behavior)).apply(behavior, produce(defaultParams, params), { ref: behavior.id });
}
else {
tree.to(behavior.id).update(params);
}
return this.plugin.runTask(this.behaviors.updateTree(tree));
}
dispose() {
this.behaviors.cells.forEach(cell => {
var _a, _b, _c, _d;
if (PluginBehavior.Behavior.is(cell.obj)) {
(_b = (_a = cell.obj.data).unregister) === null || _b === void 0 ? void 0 : _b.call(_a);
(_d = (_c = cell.obj.data).dispose) === null || _d === void 0 ? void 0 : _d.call(_c);
}
});
super.dispose();
this.data.dispose();
this.behaviors.dispose();
this.animation.dispose();
}
constructor(plugin) {
super();
this.plugin = plugin;
this.data = State.create(new SO.Root({}), { runTask: this.plugin.runTask, globalContext: this.plugin, historyCapacity: this.plugin.config.get(PluginConfig.State.HistoryCapacity) });
this.behaviors = State.create(new PluginBehavior.Root({}), { runTask: this.plugin.runTask, globalContext: this.plugin, rootState: { isLocked: true } });
this.events = {
cell: {
stateUpdated: merge(this.data.events.cell.stateUpdated, this.behaviors.events.cell.stateUpdated),
created: merge(this.data.events.cell.created, this.behaviors.events.cell.created),
removed: merge(this.data.events.cell.removed, this.behaviors.events.cell.removed),
},
object: {
created: merge(this.data.events.object.created, this.behaviors.events.object.created),
removed: merge(this.data.events.object.removed, this.behaviors.events.object.removed),
updated: merge(this.data.events.object.updated, this.behaviors.events.object.updated)
}
};
this.snapshotParams = this.ev.behavior(PluginState.DefaultSnapshotParams);
this.setSnapshotParams = (params) => {
this.snapshotParams.next({ ...PluginState.DefaultSnapshotParams, ...params });
};
}
}
(function (PluginState) {
PluginState.SnapshotParams = {
durationInMs: PD.Numeric(1500, { min: 100, max: 15000, step: 100 }, { label: 'Duration in ms' }),
data: PD.Boolean(true),
behavior: PD.Boolean(false),
structureSelection: PD.Boolean(false),
componentManager: PD.Boolean(true),
animation: PD.Boolean(true),
startAnimation: PD.Boolean(false),
canvas3d: PD.Boolean(true),
canvas3dContext: PD.Boolean(true),
interactivity: PD.Boolean(true),
camera: PD.Boolean(true),
cameraTransition: PD.MappedStatic('animate', {
animate: PD.Group({
durationInMs: PD.Numeric(250, { min: 100, max: 5000, step: 500 }, { label: 'Duration in ms' }),
}),
instant: PD.Group({})
}, { options: [['animate', 'Animate'], ['instant', 'Instant']] }),
image: PD.Boolean(false),
};
PluginState.DefaultSnapshotParams = PD.getDefaultValues(PluginState.SnapshotParams);
PluginState.getMinFrameDuration = memoizeLatest((snapshot) => {
if (!snapshot)
return 1000 / 60;
const { transition } = snapshot;
if (!transition)
return 1000 / 60;
let minDuration = Infinity;
for (const frame of transition.frames) {
if (frame.durationInMs > 0 && frame.durationInMs < minDuration) {
minDuration = frame.durationInMs;
}
}
if (!Number.isFinite(minDuration))
return 1000 / 60;
return minDuration;
});
PluginState.getStateTransitionDuration = memoizeLatest((snapshot) => {
if (!snapshot)
return undefined;
const { transition } = snapshot;
if (!transition)
return undefined;
let totalDuration = 0;
for (let i = 0; i < transition.frames.length; i++) {
const frame = transition.frames[i];
totalDuration += frame.durationInMs;
}
return totalDuration;
});
PluginState.getStateTransitionFrameTime = memoizeLatest((snapshot, frameIndex) => {
if (!snapshot || frameIndex === undefined)
return 0;
const { transition } = snapshot;
if (!transition)
return 0;
let currentDuration = 0;
for (let i = 0; i < frameIndex; i++) {
if (transition.frames.length <= i)
break;
const frame = transition.frames[i];
currentDuration += frame.durationInMs;
}
return currentDuration;
});
function getStateTransitionFrameIndex(snapshot, timestamp) {
var _a;
const { transition } = snapshot;
if (!(transition === null || transition === void 0 ? void 0 : transition.frames.length))
return undefined;
let t = timestamp;
if (transition.loop) {
t %= (_a = PluginState.getStateTransitionDuration(snapshot)) !== null && _a !== void 0 ? _a : 1;
}
let currentDuration = 0;
if (t <= transition.frames[0].durationInMs)
return 0;
for (let i = 0; i < transition.frames.length; i++) {
if (currentDuration >= t)
return i;
const frame = transition.frames[i];
currentDuration += frame.durationInMs;
}
return transition.frames.length - 1;
}
PluginState.getStateTransitionFrameIndex = getStateTransitionFrameIndex;
})(PluginState || (PluginState = {}));