/** * Copyright (c) 2018-2021 mol* contributors, licensed under MIT, See LICENSE file for more info. * * @author Alexander Rose */ import { RuntimeContext } from '../mol-task'; import { GraphicsRenderObject } from '../mol-gl/render-object'; import { PickingId } from '../mol-geo/geometry/picking'; import { Loci, isEmptyLoci, isEveryLoci, EveryLoci } from '../mol-model/loci'; import { MarkerAction, applyMarkerAction, getMarkerInfo, setMarkerValue, getPartialMarkerAverage, MarkerActions, MarkerInfo } from '../mol-util/marker-action'; import { ParamDefinition as PD } from '../mol-util/param-definition'; import { WebGLContext } from '../mol-gl/webgl/context'; import { Theme } from '../mol-theme/theme'; import { Mat4 } from '../mol-math/linear-algebra'; import { updateTransformData, fillIdentityTransform } from '../mol-geo/geometry/transform-data'; import { calculateTransformBoundingSphere } from '../mol-gl/renderable/util'; import { ValueCell } from '../mol-util'; import { Overpaint } from '../mol-theme/overpaint'; import { createOverpaint, clearOverpaint, applyOverpaintColor } from '../mol-geo/geometry/overpaint-data'; import { Interval } from '../mol-data/int'; import { Transparency } from '../mol-theme/transparency'; import { createTransparency, clearTransparency, applyTransparencyValue, getTransparencyAverage } from '../mol-geo/geometry/transparency-data'; import { Clipping } from '../mol-theme/clipping'; import { createClipping, applyClippingGroups, clearClipping } from '../mol-geo/geometry/clipping-data'; import { getMarkersAverage } from '../mol-geo/geometry/marker-data'; export interface VisualContext { readonly runtime: RuntimeContext readonly webgl?: WebGLContext } export { Visual }; interface Visual { /** Number of addressable groups in all instances of the visual */ readonly groupCount: number readonly renderObject: GraphicsRenderObject | undefined createOrUpdate: (ctx: VisualContext, theme: Theme, props: PD.Values

, data?: D) => Promise | void getLoci: (pickingId: PickingId) => Loci mark: (loci: Loci, action: MarkerAction) => boolean setVisibility: (visible: boolean) => void setAlphaFactor: (alphaFactor: number) => void setPickable: (pickable: boolean) => void setColorOnly: (colorOnly: boolean) => void setTransform: (matrix?: Mat4, instanceMatrices?: Float32Array | null) => void setOverpaint: (overpaint: Overpaint) => void setTransparency: (transparency: Transparency) => void setClipping: (clipping: Clipping) => void destroy: () => void mustRecreate?: (data: D, props: PD.Values

, webgl?: WebGLContext) => boolean } namespace Visual { export type LociApply = (loci: Loci, apply: (interval: Interval) => boolean, isMarking: boolean) => boolean export function setVisibility(renderObject: GraphicsRenderObject | undefined, visible: boolean) { if (renderObject) renderObject.state.visible = visible; } export function setAlphaFactor(renderObject: GraphicsRenderObject | undefined, alphaFactor: number) { if (renderObject) renderObject.state.alphaFactor = alphaFactor; } export function setPickable(renderObject: GraphicsRenderObject | undefined, pickable: boolean) { if (renderObject) renderObject.state.pickable = pickable; } export function setColorOnly(renderObject: GraphicsRenderObject | undefined, colorOnly: boolean) { if (renderObject) renderObject.state.colorOnly = colorOnly; } export type PreviousMark = { loci: Loci, action: MarkerAction, status: MarkerInfo['status'] } export function mark(renderObject: GraphicsRenderObject | undefined, loci: Loci, action: MarkerAction, lociApply: LociApply, previous?: PreviousMark) { if (!renderObject || isEmptyLoci(loci)) return false; const { tMarker, dMarkerType, uMarker, markerAverage, markerStatus, uGroupCount, instanceCount } = renderObject.values; const count = uGroupCount.ref.value * instanceCount.ref.value; const { array } = tMarker.ref.value; const currentStatus = markerStatus.ref.value as MarkerInfo['status']; if (!isEveryLoci(loci)) { let intervalSize = 0; lociApply(loci, interval => { intervalSize += Interval.size(interval); return true; }, true); if (intervalSize === 0) return false; if (intervalSize === count) loci = EveryLoci; } let changed = false; let average = -1; let status: MarkerInfo['status'] = -1; if (isEveryLoci(loci)) { const info = getMarkerInfo(action, currentStatus); if (info.status !== -1) { changed = currentStatus !== info.status; if (changed) setMarkerValue(array, info.status, count); } else { changed = applyMarkerAction(array, Interval.ofLength(count), action); } average = info.average; status = info.status; } else { changed = lociApply(loci, interval => applyMarkerAction(array, interval, action), true); if (changed) { average = getPartialMarkerAverage(action, currentStatus); if (previous && previous.status !== -1 && average === -1 && MarkerActions.isReverse(previous.action, action) && Loci.areEqual(loci, previous.loci) ) { status = previous.status; average = status === 0 ? 0 : 0.5; } } } if (changed) { if (average === -1) { average = getMarkersAverage(array, count); if (average === 0) status = 0; } if (previous) { previous.action = action; previous.loci = loci; previous.status = currentStatus; } ValueCell.updateIfChanged(uMarker, status); if (status === -1) ValueCell.update(tMarker, tMarker.ref.value); ValueCell.updateIfChanged(dMarkerType, status === -1 ? 'groupInstance' : 'uniform'); ValueCell.updateIfChanged(markerAverage, average); ValueCell.updateIfChanged(markerStatus, status); } return changed; } export function setOverpaint(renderObject: GraphicsRenderObject | undefined, overpaint: Overpaint, lociApply: LociApply, clear: boolean) { if (!renderObject) return; const { tOverpaint, uGroupCount, instanceCount } = renderObject.values; const count = uGroupCount.ref.value * instanceCount.ref.value; // ensure texture has right size createOverpaint(overpaint.layers.length ? count : 0, renderObject.values); const { array } = tOverpaint.ref.value; // clear all if requested if (clear) clearOverpaint(array, 0, count); for (let i = 0, il = overpaint.layers.length; i < il; ++i) { const { loci, color, clear } = overpaint.layers[i]; const apply = (interval: Interval) => { const start = Interval.start(interval); const end = Interval.end(interval); return clear ? clearOverpaint(array, start, end) : applyOverpaintColor(array, start, end, color); }; lociApply(loci, apply, false); } ValueCell.update(tOverpaint, tOverpaint.ref.value); } export function setTransparency(renderObject: GraphicsRenderObject | undefined, transparency: Transparency, lociApply: LociApply, clear: boolean) { if (!renderObject) return; const { tTransparency, transparencyAverage, uGroupCount, instanceCount } = renderObject.values; const count = uGroupCount.ref.value * instanceCount.ref.value; // ensure texture has right size and variant createTransparency(transparency.layers.length ? count : 0, renderObject.values); const { array } = tTransparency.ref.value; // clear if requested if (clear) clearTransparency(array, 0, count); for (let i = 0, il = transparency.layers.length; i < il; ++i) { const { loci, value } = transparency.layers[i]; const apply = (interval: Interval) => { const start = Interval.start(interval); const end = Interval.end(interval); return applyTransparencyValue(array, start, end, value); }; lociApply(loci, apply, false); } ValueCell.update(tTransparency, tTransparency.ref.value); ValueCell.updateIfChanged(transparencyAverage, getTransparencyAverage(array, count)); } export function setClipping(renderObject: GraphicsRenderObject | undefined, clipping: Clipping, lociApply: LociApply, clear: boolean) { if (!renderObject) return; const { tClipping, uGroupCount, instanceCount } = renderObject.values; const count = uGroupCount.ref.value * instanceCount.ref.value; // ensure texture has right size createClipping(clipping.layers.length ? count : 0, renderObject.values); const { array } = tClipping.ref.value; // clear if requested if (clear) clearClipping(array, 0, count); for (let i = 0, il = clipping.layers.length; i < il; ++i) { const { loci, groups } = clipping.layers[i]; const apply = (interval: Interval) => { const start = Interval.start(interval); const end = Interval.end(interval); return applyClippingGroups(array, start, end, groups); }; lociApply(loci, apply, false); } ValueCell.update(tClipping, tClipping.ref.value); } export function setTransform(renderObject: GraphicsRenderObject | undefined, transform?: Mat4, instanceTransforms?: Float32Array | null) { if (!renderObject || (!transform && !instanceTransforms)) return; const { values } = renderObject; if (transform) { Mat4.copy(values.matrix.ref.value, transform); ValueCell.update(values.matrix, values.matrix.ref.value); } if (instanceTransforms) { values.extraTransform.ref.value.set(instanceTransforms); ValueCell.update(values.extraTransform, values.extraTransform.ref.value); } else if (instanceTransforms === null) { fillIdentityTransform(values.extraTransform.ref.value, values.instanceCount.ref.value); ValueCell.update(values.extraTransform, values.extraTransform.ref.value); } updateTransformData(values); const boundingSphere = calculateTransformBoundingSphere(values.invariantBoundingSphere.ref.value, values.aTransform.ref.value, values.instanceCount.ref.value); ValueCell.update(values.boundingSphere, boundingSphere); } }