molstar
Version:
A comprehensive macromolecular library.
203 lines (202 loc) • 11.9 kB
JavaScript
;
/**
* Copyright (c) 2018-2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
*
* @author Adam Midlik <midlik@gmail.com>
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.InitMeshStreaming = exports.MeshVisualTransformer = exports.MeshVisualGroupTransformer = exports.MeshStreamingTransformer = exports.MeshServerTransformer = void 0;
const mesh_1 = require("../../../mol-geo/geometry/mesh/mesh");
const objects_1 = require("../../../mol-plugin-state/objects");
const representation_1 = require("../../../mol-repr/shape/representation");
const mol_state_1 = require("../../../mol-state");
const mol_task_1 = require("../../../mol-task");
const mol_util_1 = require("../../../mol-util");
const param_definition_1 = require("../../../mol-util/param-definition");
const mesh_extension_1 = require("../mesh-extension");
const behavior_1 = require("./behavior");
const server_info_1 = require("./server-info");
// // // // // // // // // // // // // // // // // // // // // // // //
exports.MeshServerTransformer = (0, mesh_extension_1.VolsegTransform)({
name: 'mesh-server-info',
from: objects_1.PluginStateObject.Root,
to: server_info_1.MeshServerInfo,
params: server_info_1.MeshServerInfo.Params,
})({
apply({ a, params }, plugin) {
params.serverUrl = params.serverUrl.replace(/\/*$/, ''); // trim trailing slash
const description = params.entryId;
return new server_info_1.MeshServerInfo({ ...params }, { label: 'Mesh Server', description: description });
}
});
// // // // // // // // // // // // // // // // // // // // // // // //
exports.MeshStreamingTransformer = (0, mesh_extension_1.VolsegTransform)({
name: 'mesh-streaming-from-server-info',
display: { name: 'Mesh Streaming' },
from: server_info_1.MeshServerInfo,
to: behavior_1.MeshStreaming,
params: a => behavior_1.MeshStreaming.Params.create(a.data),
})({
canAutoUpdate() { return true; },
apply({ a, params }, plugin) {
return mol_task_1.Task.create('Mesh Streaming', async (ctx) => {
const behavior = new behavior_1.MeshStreaming.Behavior(plugin, a.data, params);
await behavior.update(params);
return new behavior_1.MeshStreaming(behavior, { label: 'Mesh Streaming', description: behavior.getDescription() });
});
},
update({ a, b, oldParams, newParams }) {
return mol_task_1.Task.create('Update Mesh Streaming', async (ctx) => {
if (a.data.source !== b.data.parentData.source || a.data.entryId !== b.data.parentData.entryId) {
return mol_state_1.StateTransformer.UpdateResult.Recreate;
}
b.data.parentData = a.data;
await b.data.update(newParams);
b.description = b.data.getDescription();
return mol_state_1.StateTransformer.UpdateResult.Updated;
});
}
});
// export type MeshVisualGroupTransformer = typeof MeshVisualGroupTransformer;
exports.MeshVisualGroupTransformer = (0, mesh_extension_1.VolsegTransform)({
name: 'mesh-visual-group-from-streaming',
display: { name: 'Mesh Visuals for a Segment' },
from: behavior_1.MeshStreaming,
to: objects_1.PluginStateObject.Group,
params: {
/** Shown on the node in GUI */
label: param_definition_1.ParamDefinition.Text('', { isHidden: true }),
/** Shown on the node in GUI (gray letters) */
description: param_definition_1.ParamDefinition.Text(''),
segmentId: param_definition_1.ParamDefinition.Numeric(behavior_1.NO_SEGMENT, {}, { isHidden: true }),
opacity: param_definition_1.ParamDefinition.Numeric(-1, { min: 0, max: 1, step: 0.01 }),
}
})({
apply({ a, params }, plugin) {
trySetAutoOpacity(params, a);
return new objects_1.PluginStateObject.Group({ opacity: params.opacity }, params);
},
update({ a, b, oldParams, newParams }, plugin) {
if ((0, mol_util_1.shallowEqualObjects)(oldParams, newParams)) {
return mol_state_1.StateTransformer.UpdateResult.Unchanged;
}
newParams.label || (newParams.label = oldParams.label); // Protect against resetting params to invalid defaults
if (newParams.segmentId === behavior_1.NO_SEGMENT)
newParams.segmentId = oldParams.segmentId; // Protect against resetting params to invalid defaults
trySetAutoOpacity(newParams, a);
b.label = newParams.label;
b.description = newParams.description;
b.data.opacity = newParams.opacity;
return mol_state_1.StateTransformer.UpdateResult.Updated;
},
canAutoUpdate({ oldParams, newParams }, plugin) {
return newParams.description === oldParams.description;
},
});
function trySetAutoOpacity(params, parent) {
if (params.opacity === -1) {
const isBgSegment = parent.data.backgroundSegments[params.segmentId];
if (isBgSegment !== undefined) {
params.opacity = isBgSegment ? mesh_extension_1.BACKGROUND_OPACITY : mesh_extension_1.FOREROUND_OPACITY;
}
}
}
// // // // // // // // // // // // // // // // // // // // // // // //
exports.MeshVisualTransformer = (0, mesh_extension_1.VolsegTransform)({
name: 'mesh-visual-from-streaming',
display: { name: 'Mesh Visual from Streaming' },
from: behavior_1.MeshStreaming,
to: objects_1.PluginStateObject.Shape.Representation3D,
params: {
/** Must be set to PluginStateObject reference to self */
ref: param_definition_1.ParamDefinition.Text('', { isHidden: true, isEssential: true }), // QUESTION what is isEssential
/** Identification of the mesh visual, e.g. 'low-2' */
tag: param_definition_1.ParamDefinition.Text('', { isHidden: true, isEssential: true }),
/** Opacity of the visual (not to be set directly, but controlled by the opacity of the parent Group, and by VisualInfo.visible) */
opacity: param_definition_1.ParamDefinition.Numeric(-1, { min: 0, max: 1, step: 0.01 }, { isHidden: true }),
}
})({
apply({ a, params, spine }, plugin) {
return mol_task_1.Task.create('Mesh Visual', async (ctx) => {
var _a, _b, _c;
const visualInfo = a.data.visuals[params.tag];
if (!visualInfo)
throw new Error(`VisualInfo with tag '${params.tag}' is missing.`);
const groupData = (_a = spine.getAncestorOfType(objects_1.PluginStateObject.Group)) === null || _a === void 0 ? void 0 : _a.data;
params.opacity = visualInfo.visible ? ((_b = groupData === null || groupData === void 0 ? void 0 : groupData.opacity) !== null && _b !== void 0 ? _b : mesh_extension_1.FOREROUND_OPACITY) : 0.0;
const props = param_definition_1.ParamDefinition.getDefaultValues(mesh_1.Mesh.Params);
props.flatShaded = true; // `flatShaded: true` is to see the real mesh vertices and triangles (default: false)
props.alpha = params.opacity;
const repr = (0, representation_1.ShapeRepresentation)((ctx, meshlist) => mesh_extension_1.MeshlistData.getShape(meshlist, visualInfo.color), mesh_1.Mesh.Utils);
await repr.createOrUpdate(props, (_c = visualInfo.data) !== null && _c !== void 0 ? _c : mesh_extension_1.MeshlistData.empty()).runInContext(ctx);
return new objects_1.PluginStateObject.Shape.Representation3D({ repr, sourceData: visualInfo.data }, { label: 'Mesh Visual', description: params.tag });
});
},
update({ a, b, oldParams, newParams, spine }, plugin) {
return mol_task_1.Task.create('Update Mesh Visual', async (ctx) => {
var _a, _b, _c;
newParams.ref || (newParams.ref = oldParams.ref); // Protect against resetting params to invalid defaults
newParams.tag || (newParams.tag = oldParams.tag); // Protect against resetting params to invalid defaults
const visualInfo = a.data.visuals[newParams.tag];
if (!visualInfo)
throw new Error(`VisualInfo with tag '${newParams.tag}' is missing.`);
const oldData = b.data.sourceData;
if (((_a = visualInfo.data) === null || _a === void 0 ? void 0 : _a.detail) !== (oldData === null || oldData === void 0 ? void 0 : oldData.detail)) {
return mol_state_1.StateTransformer.UpdateResult.Recreate;
}
const groupData = (_b = spine.getAncestorOfType(objects_1.PluginStateObject.Group)) === null || _b === void 0 ? void 0 : _b.data;
const newOpacity = visualInfo.visible ? ((_c = groupData === null || groupData === void 0 ? void 0 : groupData.opacity) !== null && _c !== void 0 ? _c : mesh_extension_1.FOREROUND_OPACITY) : 0.0; // do not store to newParams directly, because oldParams and newParams might point to the same object!
if (newOpacity !== oldParams.opacity) {
newParams.opacity = newOpacity;
await b.data.repr.createOrUpdate({ alpha: newParams.opacity }).runInContext(ctx);
return mol_state_1.StateTransformer.UpdateResult.Updated;
}
else {
return mol_state_1.StateTransformer.UpdateResult.Unchanged;
}
});
},
canAutoUpdate(params, globalCtx) {
return true;
},
dispose({ b, params }, plugin) {
b === null || b === void 0 ? void 0 : b.data.repr.destroy(); // QUESTION is this correct?
},
});
// // // // // // // // // // // // // // // // // // // // // // // //
exports.InitMeshStreaming = mol_state_1.StateAction.build({
display: { name: 'Mesh Streaming' },
from: objects_1.PluginStateObject.Root,
params: server_info_1.MeshServerInfo.Params,
isApplicable: (a, _, plugin) => true
})(function (p, plugin) {
return mol_task_1.Task.create('Mesh Streaming', async (ctx) => {
var _a, _b, _c, _d;
const { params } = p;
// p.ref
const serverNode = await plugin.build().to(p.ref).apply(exports.MeshServerTransformer, params).commit();
// const serverNode = await plugin.build().toRoot().apply(MeshServerTransformer, params).commit();
const streamingNode = await plugin.build().to(serverNode).apply(exports.MeshStreamingTransformer, {}).commit();
const visuals = (_b = (_a = streamingNode.data) === null || _a === void 0 ? void 0 : _a.visuals) !== null && _b !== void 0 ? _b : {};
const bgSegments = (_d = (_c = streamingNode.data) === null || _c === void 0 ? void 0 : _c.backgroundSegments) !== null && _d !== void 0 ? _d : {};
const segmentGroups = {};
for (const tag in visuals) {
const segid = visuals[tag].segmentId;
if (!segmentGroups[segid]) {
let description = visuals[tag].segmentName;
if (bgSegments[segid])
description += ' (background)';
const group = await plugin.build().to(streamingNode).apply(exports.MeshVisualGroupTransformer, { label: `Segment ${segid}`, description: description, segmentId: segid }, { state: { isCollapsed: true } }).commit();
segmentGroups[segid] = group.ref;
}
}
const visualsUpdate = plugin.build();
for (const tag in visuals) {
const ref = `${streamingNode.ref}-${tag}`;
const segid = visuals[tag].segmentId;
visualsUpdate.to(segmentGroups[segid]).apply(exports.MeshVisualTransformer, { ref: ref, tag: tag }, { ref: ref }); // ref - hack to allow the node make itself invisible
}
await plugin.state.data.updateTree(visualsUpdate).runInContext(ctx); // QUESTION what is really the difference between this and `visualsUpdate.commit()`?
});
});
// TODO make available in GUI, in left panel or in right panel like Volume Streaming in src/mol-plugin-ui/structure/volume.tsx?