Newer
Older
import * as IDs from './idents';
import * as RefCfmr from './reference-conformers';
import { ReDNATCOMsp, Display, VisualRepresentations } from './index';
import { NtCColors } from './colors';
import { ReferenceConformersPdbs } from './reference-conformers-pdbs';
import { Step } from './step';
import { Superpose } from './superpose';
import { Traverse } from './traverse';
import { DnatcoConfalPyramids } from '../../extensions/dnatco';
import { ConfalPyramidsParams } from '../../extensions/dnatco/confal-pyramids/representation';
import { OrderedSet } from '../../mol-data/int/ordered-set';
import { BoundaryHelper } from '../../mol-math/geometry/boundary-helper';
import { Vec3 } from '../../mol-math/linear-algebra/3d';
import { EmptyLoci, Loci } from '../../mol-model/loci';
import { ElementIndex, Model, StructureElement, StructureProperties, StructureSelection, Trajectory } from '../../mol-model/structure';
import { structureUnion, structureSubtract } from '../../mol-model/structure/query/utils/structure-set';
import { Location } from '../../mol-model/structure/structure/element/location';
import { MmcifFormat } from '../../mol-model-formats/structure/mmcif';
import { PluginBehavior, PluginBehaviors } from '../../mol-plugin/behavior';
import { PluginCommands } from '../../mol-plugin/commands';
import { PluginConfig } from '../../mol-plugin/config';
import { PluginContext } from '../../mol-plugin/context';
import { PluginSpec } from '../../mol-plugin/spec';
import { LociLabel } from '../../mol-plugin-state/manager/loci-label';
import { StateTransforms } from '../../mol-plugin-state/transforms';
import { RawData } from '../../mol-plugin-state/transforms/data';
import { createPluginUI } from '../../mol-plugin-ui';
import { PluginUIContext } from '../../mol-plugin-ui/context';
import { DefaultPluginUISpec, PluginUISpec } from '../../mol-plugin-ui/spec';
import { Representation } from '../../mol-repr/representation';
import { StateObjectCell, StateObject, StateTransformer } from '../../mol-state';
import { StateBuilder } from '../../mol-state/state/builder';
import { lociLabel } from '../../mol-theme/label';
import { arrayMax } from '../../mol-util/array';
import { Binding } from '../../mol-util/binding';
import { Color } from '../../mol-util/color';
import { ButtonsType, ModifiersKeys } from '../../mol-util/input/input-observer';
import { ParamDefinition as PD } from '../../mol-util/param-definition';
import { ObjectKeys } from '../../mol-util/type-helpers';
import './molstar.css';
import './rednatco-molstar.css';
const Extensions = {
'ntc-balls-pyramids-prop': PluginSpec.Behavior(DnatcoConfalPyramids),
};
const AnimationDurationMsec = 150;
const BaseRef = 'rdo';
const RCRef = 'rc';
const NtCSupPrev = 'ntc-sup-prev';
const NtCSupSel = 'ntc-sup-sel';
const NtCSupNext = 'ntc-sup-next';
const SphereBoundaryHelper = new BoundaryHelper('98');
function superpositionAtomsIndices(loci: StructureElement.Loci) {
const es = loci.elements[0];
const loc = Location.create(loci.structure, es.unit, es.unit.elements[OrderedSet.getAt(es.indices, 0)]);
const len = OrderedSet.size(es.indices);
const indices = new Array<ElementIndex>();
const gather = (atoms: string[], start: number, end: number) => {
for (const atom of atoms) {
let idx = start;
for (; idx < end; idx++) {
loc.element = es.unit.elements[OrderedSet.getAt(es.indices, idx)];
const _atom = StructureProperties.atom.label_atom_id(loc);
if (atom === _atom) {
indices.push(loc.element);
break;
}
}
if (idx === end) {
console.error(`Cannot find backbone atom ${atom} in first residue of a step`);
return false;
}
}
return true;
};
// Find split between first and second residue
const resNo1 = StructureProperties.residue.label_seq_id(loc);
let secondIdx = -1;
for (let idx = 0; idx < len; idx++) {
loc.element = es.unit.elements[OrderedSet.getAt(es.indices, idx)];
const resNo = StructureProperties.residue.label_seq_id(loc);
if (resNo !== resNo1) {
secondIdx = idx;
break;
}
}
if (secondIdx === -1) {
console.log('No first/second residue split');
loc.element = es.unit.elements[OrderedSet.getAt(es.indices, 0)];
const compId1 = StructureProperties.atom.label_comp_id(loc);
const atoms1 = RefCfmr.referenceAtoms(compId1.toUpperCase(), 'first');
if (!gather(atoms1, 0, secondIdx)) {
console.log('No ref atoms for first');
loc.element = es.unit.elements[OrderedSet.getAt(es.indices, secondIdx)];
const compId2 = StructureProperties.atom.label_comp_id(loc);
const atoms2 = RefCfmr.referenceAtoms(compId2.toUpperCase(), 'second');
if (!gather(atoms2, secondIdx, len)) {
console.log('No ref atoms for second');
return indices;
}
function rcref(c: string, where: 'sel'|'prev'|'next'|'' = '') {
return `${RCRef}-${c}-${where}`;
}
const ReDNATCOLociLabelProvider = PluginBehavior.create({
name: 'watlas-loci-label-provider',
category: 'interaction',
ctor: class implements PluginBehavior<undefined> {
private f = {
label: (loci: Loci) => {
switch (loci.kind) {
case 'structure-loci':
case 'element-loci':
case 'data-loci':
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
return lociLabel(loci);
default:
return '';
}
},
group: (label: LociLabel) => label.toString().replace(/Model [0-9]+/g, 'Models'),
priority: 100
};
register() { this.ctx.managers.lociLabels.addProvider(this.f); }
unregister() { this.ctx.managers.lociLabels.removeProvider(this.f); }
constructor(protected ctx: PluginContext) { }
},
display: { name: 'ReDNATCO labeling' }
});
const ReDNATCOLociSelectionBindings = {
clickFocus: Binding([Binding.Trigger(ButtonsType.Flag.Secondary)], 'Focus camera on selected loci using ${triggers}'),
clickSelectOnly: Binding([Binding.Trigger(ButtonsType.Flag.Primary)], 'Select the clicked element using ${triggers}.'),
clickDeselectAllOnEmpty: Binding([Binding.Trigger(ButtonsType.Flag.Primary)], 'Deselect all when clicking on nothing using ${triggers}.'),
};
const ReDNATCOLociSelectionParams = {
bindings: PD.Value(ReDNATCOLociSelectionBindings, { isHidden: true }),
onDeselected: PD.Value(() => {}, { isHidden: true }),
onSelected: PD.Value((loci: Representation.Loci) => {}, { isHidden: true }),
};
type ReDNATCOLociSelectionProps = PD.Values<typeof ReDNATCOLociSelectionParams>;
const ReDNATCOLociSelectionProvider = PluginBehavior.create({
name: 'rednatco-loci-selection-provider',
category: 'interaction',
display: { name: 'Interactive step selection' },
params: () => ReDNATCOLociSelectionParams,
ctor: class extends PluginBehavior.Handler<ReDNATCOLociSelectionProps> {
private focusOnLoci(loci: Representation.Loci) {
if (!this.ctx.canvas3d)
return;
const sphere = Loci.getBoundingSphere(loci.loci);
if (!sphere)
return;
const snapshot = this.ctx.canvas3d.camera.getSnapshot();
snapshot.target = sphere.center;
PluginCommands.Camera.SetSnapshot(this.ctx, { snapshot, durationMs: AnimationDurationMsec });
}
register() {
const lociIsEmpty = (current: Representation.Loci) => Loci.isEmpty(current.loci);
const lociIsNotEmpty = (current: Representation.Loci) => !Loci.isEmpty(current.loci);
const actions: [keyof typeof ReDNATCOLociSelectionBindings, (current: Representation.Loci) => void, ((current: Representation.Loci) => boolean) | undefined][] = [
['clickFocus', current => this.focusOnLoci(current), lociIsNotEmpty],
[
'clickDeselectAllOnEmpty',
() => {
this.ctx.managers.interactivity.lociSelects.deselectAll();
this.params.onDeselected();
},
lociIsEmpty
],
[
'clickSelectOnly',
current => {
this.ctx.managers.interactivity.lociSelects.deselectAll();
if (current.loci.kind === 'element-loci') {
this.params.onSelected(current);
}
},
lociIsNotEmpty
],
];
// sort the action so that the ones with more modifiers trigger sooner.
actions.sort((a, b) => {
const x = this.params.bindings[a[0]], y = this.params.bindings[b[0]];
const k = x.triggers.length === 0 ? 0 : arrayMax(x.triggers.map(t => ModifiersKeys.size(t.modifiers)));
const l = y.triggers.length === 0 ? 0 : arrayMax(y.triggers.map(t => ModifiersKeys.size(t.modifiers)));
return l - k;
});
this.subscribeObservable(this.ctx.behaviors.interaction.click, ({ current, button, modifiers }) => {
if (!this.ctx.canvas3d) return;
// only trigger the 1st action that matches
for (const [binding, action, condition] of actions) {
if (Binding.match(this.params.bindings[binding], button, modifiers) && (!condition || condition(current))) {
action(current);
break;
}
}
});
}
unregister() {
}
constructor(ctx: PluginContext, params: ReDNATCOLociSelectionProps) {
super(ctx, params);
}
},
});
export class ReDNATCOMspViewer {
private haveMultipleModels = false;
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
private stepNames: Map<string, number> = new Map();
private app: ReDNATCOMsp;
constructor(public plugin: PluginUIContext, interactionContext: { self?: ReDNATCOMspViewer }, app: ReDNATCOMsp) {
interactionContext.self = this;
this.app = app;
}
private focusOnLoci(loci: StructureElement.Loci) {
if (!this.plugin.canvas3d)
return;
const sphere = Loci.getBoundingSphere(loci);
if (!sphere)
return;
const snapshot = this.plugin.canvas3d.camera.getSnapshot();
const v = Vec3();
const u = Vec3();
Vec3.set(v, sphere.center[0], sphere.center[1], sphere.center[2]);
Vec3.set(u, snapshot.position[0], snapshot.position[1], snapshot.position[2]);
Vec3.sub(u, u, v);
Vec3.normalize(u, u);
Vec3.scale(u, u, sphere.radius * 8);
Vec3.add(v, u, v);
snapshot.target = sphere.center;
snapshot.position = v;
PluginCommands.Camera.SetSnapshot(this.plugin, { snapshot, durationMs: AnimationDurationMsec });
}
private getBuilder(id: IDs.ID, sub: IDs.Substructure|'' = '', ref = BaseRef) {
return this.plugin.state.data.build().to(IDs.ID(id, sub, ref));
}
private getStructureParent(cell: StateObjectCell) {
if (!cell.sourceRef)
return undefined;
const parent = this.plugin.state.data.cells.get(cell.sourceRef);
if (!parent)
return undefined;
return parent.obj?.type.name === 'Structure' ? parent.obj : undefined;
}
private ntcRef(ntc: string, where: 'sel'|'prev'|'next') {
return rcref(ntc, where);
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
}
private pyramidsParams(colors: NtCColors.Conformers, visible: Map<string, boolean>, transparent: boolean) {
const typeParams = {} as PD.Values<ConfalPyramidsParams>;
for (const k of Reflect.ownKeys(ConfalPyramidsParams) as (keyof ConfalPyramidsParams)[]) {
if (ConfalPyramidsParams[k].type === 'boolean')
(typeParams[k] as any) = visible.get(k) ?? ConfalPyramidsParams[k]['defaultValue'];
}
return {
type: { name: 'confal-pyramids', params: { ...typeParams, alpha: transparent ? 0.5 : 1.0 } },
colorTheme: {
name: 'confal-pyramids',
params: {
colors: {
name: 'custom',
params: colors,
},
},
},
};
}
private resetCameraRadius() {
if (!this.plugin.canvas3d)
return;
const spheres = [];
for (const [ref, cell] of Array.from(this.plugin.state.data.cells)) {
if (!IDs.isVisual(ref))
continue;
const parent = this.getStructureParent(cell);
if (parent) {
const loci = StructureSelection.toLociWithSourceUnits(StructureSelection.Singletons(parent.data, parent.data));
const s = Loci.getBoundingSphere(loci);
if (s)
spheres.push(s);
}
}
if (spheres.length === 0)
return;
SphereBoundaryHelper.reset();
for (const s of spheres)
SphereBoundaryHelper.includePositionRadius(s.center, s.radius);
SphereBoundaryHelper.finishedIncludeStep();
for (const s of spheres)
SphereBoundaryHelper.radiusPositionRadius(s.center, s.radius);
const bs = SphereBoundaryHelper.getSphere();
const snapshot = this.plugin.canvas3d.camera.getSnapshot();
snapshot.radius = bs.radius;
snapshot.target = bs.center;
PluginCommands.Camera.SetSnapshot(this.plugin, { snapshot, durationMs: AnimationDurationMsec });
}
private stepFromName(name: string) {
const idx = this.stepNames.get(name);
if (idx === undefined)
return undefined;
return this.steps[idx];
}
private substructureVisuals(representation: 'ball-and-stick'|'cartoon', color: Color) {
switch (representation) {
case 'cartoon':
return {
type: {
name: 'cartoon',
params: { sizeFactor: 0.2, sizeAspectRatio: 0.35, aromaticBonds: false },
},
colorTheme: { name: 'uniform', params: { value: color } }
};
case 'ball-and-stick':
return {
type: {
name: 'ball-and-stick',
params: {
sizeFactor: 0.2,
sizeAspectRatio: 0.35,
excludeTypes: ['hydrogen-bond', 'aromatic'],
aromaticBonds: false,
},
colorTheme: { name: 'element-symbol', params: { carbonColor: { name: 'custom', params: color } } },
private superpose(reference: StructureElement.Loci, stru: StructureElement.Loci) {
const refElems = superpositionAtomsIndices(reference);
const struElems = superpositionAtomsIndices(stru);
return Superpose.superposition(
{ elements: refElems, conformation: reference.elements[0].unit.conformation },
{ elements: struElems, conformation: stru.elements[0].unit.conformation }
);
}
private async toggleNucleicSubstructure(show: boolean, repr: VisualRepresentations, color: Color) {
if (this.has('structure', 'remainder-slice', BaseRef)) {
const b = this.getBuilder('structure', 'remainder-slice');
if (show) {
b.apply(
StateTransforms.Representation.StructureRepresentation3D,
{ ref: IDs.ID('visual', 'remainder-slice', BaseRef) }
);
} else
b.delete(IDs.ID('visual', 'remainder-slice', BaseRef));
await b.commit();
} else {
const b = this.getBuilder('structure', 'nucleic');
if (show) {
b.apply(
StateTransforms.Representation.StructureRepresentation3D,
{ ref: IDs.ID('visual', 'nucleic', BaseRef) }
);
} else
b.delete(IDs.ID('visual', 'nucleic', BaseRef));
await b.commit();
}
}
private toStepLoci(name: string, struLoci: StructureElement.Loci) {
const step = this.stepFromName(name);
if (!step)
step.resNo1, step.altId1, step.insCode1,
step.resNo2, step.altId2, step.insCode2,
private waterVisuals(color: Color) {
return {
type: {
name: 'ball-and-stick',
params: { sizeFactor: 0.2, sizeAspectRatio: 0.35, aromaticBonds: false },
},
colorTheme: { name: 'uniform', params: { value: color } },
};
}
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
static async create(target: HTMLElement, app: ReDNATCOMsp) {
const interactCtx: { self?: ReDNATCOMspViewer } = { self: undefined };
const defaultSpec = DefaultPluginUISpec();
const spec: PluginUISpec = {
...defaultSpec,
behaviors: [
PluginSpec.Behavior(ReDNATCOLociLabelProvider),
PluginSpec.Behavior(PluginBehaviors.Representation.HighlightLoci),
PluginSpec.Behavior(
ReDNATCOLociSelectionProvider,
{
bindings: ReDNATCOLociSelectionBindings,
onDeselected: () => interactCtx.self!.onDeselected(),
onSelected: (loci) => interactCtx.self!.onLociSelected(loci),
}
),
...ObjectKeys(Extensions).map(k => Extensions[k]),
],
components: {
...defaultSpec.components,
controls: {
...defaultSpec.components?.controls,
top: 'none',
right: 'none',
bottom: 'none',
left: 'none'
},
},
layout: {
initial: {
isExpanded: false,
showControls: false,
config: [
[PluginConfig.Viewport.ShowExpand, false],
[PluginConfig.Viewport.ShowControls, false],
[PluginConfig.Viewport.ShowSettings, false],
[PluginConfig.Viewport.ShowTrajectoryControls, false],
[PluginConfig.Viewport.ShowAnimation, false],
[PluginConfig.Viewport.ShowSelectionMode, false],
]
};
const plugin = await createPluginUI(target, spec);
plugin.managers.interactivity.setProps({ granularity: 'two-residues' });
plugin.selectionMode = true;
return new ReDNATCOMspViewer(plugin, interactCtx, app);
}
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
async changeChainColor(display: Display) {
const color = Color(display.chainColor);
const b = this.plugin.state.data.build();
for (const sub of ['nucleic', 'protein'] as IDs.Substructure[]) {
if (this.has('visual', sub)) {
b.to(IDs.ID('visual', sub, BaseRef))
.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
...this.substructureVisuals(display.representation, color),
})
);
}
}
if (this.has('visual', 'selected-slice', BaseRef)) {
b.to(IDs.ID('visual', 'selected-slice', BaseRef))
.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
...this.substructureVisuals('ball-and-stick', color),
})
);
}
if (this.has('visual', 'remainder-slice', BaseRef)) {
b.to(IDs.ID('visual', 'remainder-slice', BaseRef))
.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
...this.substructureVisuals(display.representation, color),
})
);
}
await b.commit();
}
async changeNtCColors(display: Display) {
if (!this.has('pyramids', 'nucleic'))
return;
const b = this.plugin.state.data.build().to(IDs.ID('pyramids', 'nucleic', BaseRef));
b.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
colorTheme: {
name: 'confal-pyramids',
params: {
colors: {
name: 'custom',
params: display.conformerColors ?? NtCColors.Conformers,
},
},
},
})
);
await b.commit();
}
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
if (display.showPyramids) {
if (!this.has('pyramids', 'nucleic')) {
const b = this.getBuilder('structure', 'nucleic');
if (b) {
b.apply(
StateTransforms.Representation.StructureRepresentation3D,
this.pyramidsParams(display.conformerColors ?? NtCColors.Conformers, new Map(), display.pyramidsTransparent ?? false),
{ ref: IDs.ID('pyramids', 'nucleic', BaseRef) }
);
await b.commit();
}
} else {
const b = this.getBuilder('pyramids', 'nucleic');
b.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
...this.pyramidsParams(display.conformerColors ?? NtCColors.Conformers, new Map(), display.pyramidsTransparent ?? false),
})
);
await b.commit();
}
} else
await PluginCommands.State.RemoveObject(this.plugin, { state: this.plugin.state.data, ref: IDs.ID('pyramids', 'nucleic', BaseRef) });
}
async changeWaterColor(display: Display) {
const color = Color(display.waterColor);
if (this.has('visual', 'water', BaseRef)) {
b.to(IDs.ID('visual', 'water', BaseRef))
.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
...this.waterVisuals(color),
})
);
await b.commit();
}
}
async changeRepresentation(display: Display) {
const b = this.plugin.state.data.build();
const repr = display.representation;
const color = Color(display.chainColor);
for (const sub of ['nucleic', 'protein'] as IDs.Substructure[]) {
if (this.has('visual', sub)) {
b.to(IDs.ID('visual', sub, BaseRef))
.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
if (this.has('visual', 'remainder-slice', BaseRef)) {
b.to(IDs.ID('visual', 'remainder-slice', BaseRef))
.update(
StateTransforms.Representation.StructureRepresentation3D,
old => ({
...old,
...this.substructureVisuals(repr, color),
})
);
}
currentModelNumber() {
const model = this.plugin.state.data.cells.get(IDs.ID('model', '', BaseRef))?.obj;
if (!model)
return -1;
return (model as StateObject<Model>).data.modelNum;
}
focusOnSelectedStep() {
const sel = this.plugin.state.data.cells.get(IDs.ID('superposition', '', NtCSupSel));
const prev = this.plugin.state.data.cells.get(IDs.ID('superposition', '', NtCSupPrev));
const next = this.plugin.state.data.cells.get(IDs.ID('superposition', '', NtCSupNext));
const prevLoci = prev?.obj ? StructureSelection.toLociWithSourceUnits(StructureSelection.Singletons(prev.obj!.data, prev.obj!.data)) : EmptyLoci;
const nextLoci = next?.obj ? StructureSelection.toLociWithSourceUnits(StructureSelection.Singletons(next.obj!.data, next.obj!.data)) : EmptyLoci;
let focusOn = sel?.obj ? StructureSelection.toLociWithSourceUnits(StructureSelection.Singletons(sel!.obj!.data, sel!.obj!.data)) : EmptyLoci;
if (focusOn.kind === 'empty-loci')
return;
if (prevLoci.kind === 'element-loci')
focusOn = StructureElement.Loci.union(focusOn, prevLoci);
if (nextLoci.kind === 'element-loci')
focusOn = StructureElement.Loci.union(focusOn, nextLoci);
this.focusOnLoci(focusOn);
}
gatherStepInfo(): { steps: Step.ExtendedDescription[], stepNames: Map<string, number> }|undefined {
const obj = this.plugin.state.data.cells.get(IDs.ID('model', '', BaseRef))?.obj;
if (!obj)
return void 0;
const struModel = (obj as StateObject<Model>);
const sourceData = struModel.data.sourceData;
if (!MmcifFormat.is(sourceData))
return void 0;
const tableSum = sourceData.data.frame.categories['ndb_struct_ntc_step_summary'];
const tableStep = sourceData.data.frame.categories['ndb_struct_ntc_step'];
if (!tableSum || !tableStep) {
console.warn('NtC information not present');
return void 0;
}
const _ids = tableStep.getField('id')?.toIntArray();
const _names = tableStep.getField('name')?.toStringArray();
const _chains = tableStep.getField('auth_asym_id_1')?.toStringArray();
const _authSeqId1 = tableStep.getField('auth_seq_id_1')?.toIntArray();
const _authSeqId2 = tableStep.getField('auth_seq_id_2')?.toIntArray();
const _compId1 = tableStep.getField('label_comp_id_1')?.toStringArray();
const _compId2 = tableStep.getField('label_comp_id_2')?.toStringArray();
const _labelAltId1 = tableStep.getField('label_alt_id_1')?.toStringArray();
const _labelAltId2 = tableStep.getField('label_alt_id_2')?.toStringArray();
const _PDBinsCode1 = tableStep.getField('PDB_ins_code_1')?.toStringArray();
const _PDBinsCode2 = tableStep.getField('PDB_ins_code_2')?.toStringArray();
const _stepIds = tableSum.getField('step_id')?.toIntArray();
const _assignedNtCs = tableSum.getField('assigned_NtC')?.toStringArray();
const _closestNtCs = tableSum.getField('closest_NtC')?.toStringArray();
const _models = tableStep.getField('PDB_model_number')?.toIntArray();
if (!_ids || !_names || !_chains || !_stepIds || !_assignedNtCs || !_closestNtCs || !_labelAltId1 || !_labelAltId2 || !_authSeqId1 || !_authSeqId2 || !_compId1 || !_compId2 || !_PDBinsCode1 || !_PDBinsCode2 || !_models) {
console.warn('Expected fields are not present in NtC categories');
return void 0;
}
const steps = new Array<Step.ExtendedDescription>(len);
const id = _ids[idx];
const name = _names[idx];
if (_stepIds[jdx] === id) {
const assignedNtC = _assignedNtCs[jdx];
const closestNtC = _closestNtCs[jdx];
const chain = _chains[jdx];
const resNo1 = _authSeqId1[jdx];
const resNo2 = _authSeqId2[jdx];
const compId1 = _compId1[jdx];
const compId2 = _compId2[jdx];
const altId1 = _labelAltId1[jdx] === '' ? void 0 : _labelAltId1[jdx];
const altId2 = _labelAltId2[jdx] === '' ? void 0 : _labelAltId2[jdx];
const insCode1 = _PDBinsCode1[jdx];
const insCode2 = _PDBinsCode2[jdx];
const model = _models[jdx];
// We're assuming that steps are ID'd with a contigious, monotonic sequence starting from 1
steps[id - 1] = {
name,
assignedNtC,
closestNtC,
chain,
resNo1,
resNo2,
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
};
stepNames.set(name, id - 1);
break;
}
}
}
return { steps, stepNames };
}
getModelCount() {
const obj = this.plugin.state.data.cells.get(IDs.ID('trajectory', '', BaseRef))?.obj;
if (!obj)
return 0;
return (obj as StateObject<Trajectory>).data.frameCount;
}
getPresentConformers() {
const obj = this.plugin.state.data.cells.get(IDs.ID('model', '', BaseRef))?.obj;
if (!obj)
return [];
const model = (obj as StateObject<Model>);
const modelNum = model.data.modelNum;
const sourceData = model.data.sourceData;
if (MmcifFormat.is(sourceData)) {
const tableSum = sourceData.data.frame.categories['ndb_struct_ntc_step_summary'];
const tableStep = sourceData.data.frame.categories['ndb_struct_ntc_step'];
if (!tableSum || !tableStep) {
console.warn('NtC information not present');
return [];
}
const _stepIds = tableSum.getField('step_id');
const _assignedNtCs = tableSum.getField('assigned_NtC');
const _ids = tableStep.getField('id');
const _modelNos = tableStep.getField('PDB_model_number');
if (!_stepIds || !_assignedNtCs || !_ids || !_modelNos) {
console.warn('Expected fields are not present in NtC categories');
return [];
}
const stepIds = _stepIds.toIntArray();
const assignedNtCs = _assignedNtCs.toStringArray();
const ids = _ids.toIntArray();
const modelNos = _modelNos.toIntArray();
const present = new Array<string>();
for (let row = 0; row < stepIds.length; row++) {
const idx = ids.indexOf(stepIds[row]);
if (modelNos[idx] === modelNum) {
const ntc = assignedNtCs[row];
if (!present.includes(ntc))
present.push(ntc);
}
}
present.sort();
return present;
}
return [];
}
has(id: IDs.ID, sub: IDs.Substructure|'' = '', ref = BaseRef) {
return !!this.plugin.state.data.cells.get(IDs.ID(id, sub, ref))?.obj?.data;
}
isReady() {
return this.has('structure', '', BaseRef);
}
async loadStructure(data: string, type: 'pdb'|'cif', display: Display) {
// TODO: Remove the currently loaded structure
const chainColor = Color(display.chainColor);
const waterColor = Color(display.waterColor);
const b = (t => type === 'pdb'
? t.apply(StateTransforms.Model.TrajectoryFromPDB, {}, { ref: IDs.ID('trajectory', '', BaseRef) })
: t.apply(StateTransforms.Data.ParseCif).apply(StateTransforms.Model.TrajectoryFromMmCif, {}, { ref: IDs.ID('trajectory', '', BaseRef) })
)(this.plugin.state.data.build().toRoot().apply(RawData, { data }, { ref: IDs.ID('data', '', BaseRef) }))
.apply(StateTransforms.Model.ModelFromTrajectory, { modelIndex: display.modelNumber ? display.modelNumber - 1 : 0 }, { ref: IDs.ID('model', '', BaseRef) })
.apply(StateTransforms.Model.StructureFromModel, {}, { ref: IDs.ID('entire-structure', '', BaseRef) })
.apply(StateTransforms.Model.StructureComplexElement, { type: 'nucleic' }, { ref: IDs.ID('entire-structure', 'nucleic', BaseRef) })
.to(IDs.ID('entire-structure', '', BaseRef))
.apply(StateTransforms.Model.StructureComplexElement, { type: 'protein' }, { ref: IDs.ID('entire-structure', 'protein', BaseRef) })
.to(IDs.ID('entire-structure', '', BaseRef))
.apply(StateTransforms.Model.StructureComplexElement, { type: 'water' }, { ref: IDs.ID('entire-structure', 'water', BaseRef) });
// Commit now so that we can check whether individual substructures are available and apply filters
// Create the "possibly filtered" structure PSOs
const b2 = this.plugin.state.data.build();
if (this.has('entire-structure', 'nucleic')) {
b2.to(IDs.ID('entire-structure', 'nucleic', BaseRef))
.apply(
StateTransforms.Model.StructureSelectionFromExpression,
{ expression: Filtering.toExpression(Filters.Empty()) },
{ ref: IDs.ID('structure', 'nucleic', BaseRef) }
);
}
if (this.has('entire-structure', 'protein')) {
b2.to(IDs.ID('entire-structure', 'protein', BaseRef))
.apply(
StateTransforms.Model.StructureSelectionFromExpression,
{ expression: Filtering.toExpression(Filters.Empty()) },
{ ref: IDs.ID('structure', 'protein', BaseRef) }
);
}
if (this.has('entire-structure', 'water')) {
b2.to(IDs.ID('entire-structure', 'water', BaseRef))
.apply(
StateTransforms.Model.StructureSelectionFromExpression,
{ expression: Filtering.toExpression(Filters.Empty()) },
{ ref: IDs.ID('structure', 'water', BaseRef) }
);
}
await b2.commit();
if (display.showNucleic && this.has('structure', 'nucleic')) {
.apply(
StateTransforms.Representation.StructureRepresentation3D,
{ ref: IDs.ID('visual', 'nucleic', BaseRef) }
);
if (display.showPyramids) {
.apply(
StateTransforms.Representation.StructureRepresentation3D,
this.pyramidsParams(display.conformerColors ?? NtCColors.Conformers, new Map(), false),
{ ref: IDs.ID('pyramids', 'nucleic', BaseRef) }
);
}
}
if (display.showProtein && this.has('structure', 'protein')) {
.apply(
StateTransforms.Representation.StructureRepresentation3D,
{ ref: IDs.ID('visual', 'protein', BaseRef) }
);
}
if (display.showWater && this.has('structure', 'water')) {
.apply(
StateTransforms.Representation.StructureRepresentation3D,
{ ref: IDs.ID('visual', 'water', BaseRef) }
);
}
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
this.haveMultipleModels = this.getModelCount() > 1;
const ntcInfo = this.gatherStepInfo();
if (!ntcInfo) {
this.steps.length = 0;
this.stepNames.clear();
} else {
this.steps = ntcInfo.steps;
this.stepNames = ntcInfo.stepNames;
}
}
async loadReferenceConformers() {
const b = this.plugin.state.data.build().toRoot();
for (const c in ReferenceConformersPdbs) {
const cfmr = ReferenceConformersPdbs[c as keyof typeof ReferenceConformersPdbs];
const bRef = rcref(c);
const mRef = IDs.ID('model', '', bRef);
b.toRoot();
b.apply(RawData, { data: cfmr, label: `Reference ${c}` }, { ref: IDs.ID('data', '', bRef) })
.apply(StateTransforms.Model.TrajectoryFromPDB, {}, { ref: IDs.ID('trajectory', '', bRef) })
.apply(StateTransforms.Model.ModelFromTrajectory, {}, { ref: mRef })
.apply(StateTransforms.Model.StructureFromModel, {}, { ref: IDs.ID('structure', '', rcref(c, 'sel')) })
.to(mRef)
.apply(StateTransforms.Model.StructureFromModel, {}, { ref: IDs.ID('structure', '', rcref(c, 'prev')) })
.to(mRef)
.apply(StateTransforms.Model.StructureFromModel, {}, { ref: IDs.ID('structure', '', rcref(c, 'next')) });
}
await b.commit();
}
async onDeselected() {
this.app.viewerStepDeselected();
}
async onLociSelected(selected: Representation.Loci) {
const loci = Loci.normalize(selected.loci, 'two-residues');
if (loci.kind === 'element-loci') {
const stepDesc = Step.describe(loci, this.haveMultipleModels);
if (stepDesc && this.stepNames.has(stepDesc.name))
this.app.viewerStepSelected(stepDesc.name);
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
const b = this.plugin.state.data.build();
if (this.has('structure', 'nucleic', BaseRef)) {
b.to(IDs.ID('structure', 'nucleic', BaseRef))
.update(
StateTransforms.Model.StructureSelectionFromExpression,
old => ({
...old,
expression: Filtering.toExpression(filter)
})
);
}
if (this.has('structure', 'protein', BaseRef)) {
b.to(IDs.ID('structure', 'protein', BaseRef))
.update(
StateTransforms.Model.StructureSelectionFromExpression,
old => ({
...old,
expression: Filtering.toExpression(filter)
})
);
}
if (this.has('structure', 'water', BaseRef)) {
b.to(IDs.ID('structure', 'water', BaseRef))
.update(
StateTransforms.Model.StructureSelectionFromExpression,
old => ({
...old,
expression: Filtering.toExpression(filter)
})
);
}
await b.commit();
await this.plugin.state.data.build()
.delete(IDs.ID('superposition', '', NtCSupSel))
.delete(IDs.ID('superposition', '', NtCSupPrev))
.delete(IDs.ID('superposition', '', NtCSupNext))
.delete(IDs.ID('structure', 'selected-slice', BaseRef))
.delete(IDs.ID('structure', 'remainder-slice', BaseRef))
.commit();
await this.toggleSubstructure('nucleic', display);
async actionSelectStep(stepSel: Api.Payloads.StepSelection, prevSel: Api.Payloads.StepSelection|undefined, nextSel: Api.Payloads.StepSelection|undefined, display: Display) {
const step = this.stepFromName(stepSel.name);
if (!step)
// Switch to a different model if the selected step is from a different model
// This is the first thing we need to do
if (step.model !== this.currentModelNumber())
await this.switchModel({ modelNumber: step.model });
const entireStruCell = this.plugin.state.data.cells.get(IDs.ID('structure', 'nucleic', BaseRef));
if (!entireStruCell)