Merge branch 'master' into 2-colors-cylinders

CHANGELOG.md

@@ -7,6 +7,7 @@ Note that since we don't clearly distinguish between a public and private interf
 ## [Unreleased]
 
 - Add color interpolation to impostor cylinders
+- MolViewSpec components are applicable only when the model has been loaded from MolViewSpec
 
 ## [v3.44.0] - 2023-01-06
 

src/extensions/mvs/behavior.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -22,6 +22,7 @@ import { MVSAnnotationTooltipsLabelProvider, MVSAnnotationTooltipsProvider } fro
 import { CustomLabelRepresentationProvider } from './components/custom-label/representation';
 import { CustomTooltipsLabelProvider, CustomTooltipsProvider } from './components/custom-tooltips-prop';
 import { LoadMvsData, MVSJFormatProvider } from './components/formats';
+import { IsMVSModelProvider } from './components/is-mvs-model-prop';
 import { makeMultilayerColorThemeProvider } from './components/multilayer-color-theme';
 import { loadMVS } from './load';
 import { MVSData } from './mvs-data';
@@ -51,6 +52,7 @@ export const MolViewSpec = PluginBehavior.create<{ autoAttach: boolean }>({
     ctor: class extends PluginBehavior.Handler<{ autoAttach: boolean }> {
         private readonly registrables: Registrables = {
             customModelProperties: [
+                IsMVSModelProvider,
                 MVSAnnotationsProvider,
             ],
             customStructureProperties: [

src/extensions/mvs/components/annotation-color-theme.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -12,6 +12,7 @@ import { ColorNames } from '../../../mol-util/color/names';
 import { ParamDefinition as PD } from '../../../mol-util/param-definition';
 import { decodeColor } from '../helpers/utils';
 import { getMVSAnnotationForStructure } from './annotation-prop';
+import { isMVSStructure } from './is-mvs-model-prop';
 
 
 /** Parameter definition for color theme "MVS Annotation" */
@@ -76,5 +77,5 @@ export const MVSAnnotationColorThemeProvider: ColorTheme.Provider<MVSAnnotationC
     factory: MVSAnnotationColorTheme,
     getParams: ctx => MVSAnnotationColorThemeParams,
     defaultValues: PD.getDefaultValues(MVSAnnotationColorThemeParams),
-    isApplicable: (ctx: ThemeDataContext) => true,
+    isApplicable: (ctx: ThemeDataContext) => !!ctx.structure && isMVSStructure(ctx.structure),
 };

src/extensions/mvs/components/annotation-label/representation.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -9,6 +9,7 @@ import { Representation, RepresentationContext, RepresentationParamsGetter } fro
 import { ComplexRepresentation, StructureRepresentation, StructureRepresentationProvider, StructureRepresentationStateBuilder } from '../../../../mol-repr/structure/representation';
 import { MarkerAction } from '../../../../mol-util/marker-action';
 import { ParamDefinition as PD } from '../../../../mol-util/param-definition';
+import { isMVSStructure } from '../is-mvs-model-prop';
 import { MVSAnnotationLabelTextParams, MVSAnnotationLabelTextVisual } from './visual';
 
 
@@ -45,5 +46,5 @@ export const MVSAnnotationLabelRepresentationProvider = StructureRepresentationP
     defaultValues: PD.getDefaultValues(MVSAnnotationLabelParams),
     defaultColorTheme: { name: 'uniform' }, // this ain't workin
     defaultSizeTheme: { name: 'physical' },
-    isApplicable: (structure: Structure) => structure.elementCount > 0,
+    isApplicable: (structure: Structure) => structure.elementCount > 0 && isMVSStructure(structure),
 });

src/extensions/mvs/components/annotation-prop.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -75,7 +75,7 @@ type MVSAnnotationData = { format: 'json', data: Jsonable } | { format: 'cif', d
 
 /** Provider for custom model property "Annotations" */
 export const MVSAnnotationsProvider: CustomModelProperty.Provider<MVSAnnotationsParams, MVSAnnotations> = CustomModelProperty.createProvider({
-    label: 'Annotations',
+    label: 'MVS Annotations',
     descriptor: CustomPropertyDescriptor({
         name: 'mvs-annotations',
     }),

src/extensions/mvs/components/custom-label/representation.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -9,6 +9,7 @@ import { Representation, RepresentationContext, RepresentationParamsGetter } fro
 import { ComplexRepresentation, StructureRepresentation, StructureRepresentationProvider, StructureRepresentationStateBuilder } from '../../../../mol-repr/structure/representation';
 import { MarkerAction } from '../../../../mol-util/marker-action';
 import { ParamDefinition as PD } from '../../../../mol-util/param-definition';
+import { isMVSStructure } from '../is-mvs-model-prop';
 import { CustomLabelTextParams, CustomLabelTextVisual } from './visual';
 
 
@@ -38,12 +39,12 @@ export function CustomLabelRepresentation(ctx: RepresentationContext, getParams:
 /** A thingy that is needed to register representation type "Custom Label", allowing user-defined labels at at user-defined positions */
 export const CustomLabelRepresentationProvider = StructureRepresentationProvider({
     name: 'mvs-custom-label',
-    label: 'Custom Label',
+    label: 'MVS Custom Label',
     description: 'Displays labels with custom text',
     factory: CustomLabelRepresentation,
     getParams: () => CustomLabelParams,
     defaultValues: PD.getDefaultValues(CustomLabelParams),
     defaultColorTheme: { name: 'uniform' },
     defaultSizeTheme: { name: 'physical' },
-    isApplicable: (structure: Structure) => structure.elementCount > 0
+    isApplicable: (structure: Structure) => structure.elementCount > 0 && isMVSStructure(structure),
 });

src/extensions/mvs/components/custom-tooltips-prop.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -36,7 +36,7 @@ export type CustomTooltipsData = { selector: Selector, text: string, elementSet?
 
 /** Provider for custom structure property "CustomTooltips" */
 export const CustomTooltipsProvider: CustomStructureProperty.Provider<CustomTooltipsParams, CustomTooltipsData> = CustomStructureProperty.createProvider({
-    label: 'Custom Tooltips',
+    label: 'MVS Custom Tooltips',
     descriptor: CustomPropertyDescriptor<any, any>({
         name: 'mvs-custom-tooltips',
     }),

src/extensions/mvs/components/is-mvs-model-prop.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright (c) 2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ *
+ * @author Adam Midlik <midlik@gmail.com>
+ */
+
+import { CustomModelProperty } from '../../../mol-model-props/common/custom-model-property';
+import { CustomProperty } from '../../../mol-model-props/common/custom-property';
+import { CustomPropertyDescriptor } from '../../../mol-model/custom-property';
+import { Model, Structure } from '../../../mol-model/structure';
+import { ParamDefinition as PD } from '../../../mol-util/param-definition';
+
+
+/** Parameter definition for custom model property "Is MVS" */
+export type IsMVSModelParams = typeof IsMVSModelParams
+export const IsMVSModelParams = {
+    isMvs: PD.Boolean(false, { description: 'Flag this model as managed by MolViewSpec and enable MolViewSpec features' }),
+};
+
+/** Parameter values for custom model property "Is MVS" */
+export type IsMVSModelProps = PD.Values<IsMVSModelParams>
+
+/** Provider for custom model property "Is MVS" */
+export const IsMVSModelProvider: CustomModelProperty.Provider<IsMVSModelParams, {}> = CustomModelProperty.createProvider({
+    label: 'MVS',
+    descriptor: CustomPropertyDescriptor({
+        name: 'mvs-is-mvs-model',
+    }),
+    type: 'static',
+    defaultParams: IsMVSModelParams,
+    getParams: (data: Model) => IsMVSModelParams,
+    isApplicable: (data: Model) => true,
+    obtain: async (ctx: CustomProperty.Context, data: Model, props: Partial<IsMVSModelProps>) => ({ value: {} }),
+});
+
+/** Decide if the model is flagged as managed by MolViewSpec */
+export function isMVSModel(model: Model): boolean {
+    return !!IsMVSModelProvider.props(model)?.isMvs;
+}
+/** Decide if the structure is flagged as managed by MolViewSpec */
+export function isMVSStructure(structure: Structure): boolean {
+    return structure.models.some(isMVSModel);
+}

src/extensions/mvs/components/multilayer-color-theme.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -12,6 +12,7 @@ import { Color } from '../../../mol-util/color';
 import { ColorNames } from '../../../mol-util/color/names';
 import { ParamDefinition as PD } from '../../../mol-util/param-definition';
 import { stringToWords } from '../../../mol-util/string';
+import { isMVSStructure } from './is-mvs-model-prop';
 import { ElementSet, SelectorParams, isSelectorAll } from './selector';
 
 
@@ -137,11 +138,11 @@ export const MultilayerColorThemeName = 'mvs-multilayer';
 export function makeMultilayerColorThemeProvider(colorThemeRegistry: ColorTheme.Registry): ColorTheme.Provider<MultilayerColorThemeParams, typeof MultilayerColorThemeName> {
     return {
         name: MultilayerColorThemeName,
-        label: 'Multi-layer',
+        label: 'MVS Multi-layer',
         category: ColorTheme.Category.Misc,
         factory: (ctx, props) => makeMultilayerColorTheme(ctx, props, colorThemeRegistry),
         getParams: (ctx: ThemeDataContext) => makeMultilayerColorThemeParams(colorThemeRegistry, ctx),
         defaultValues: DefaultMultilayerColorThemeProps,
-        isApplicable: (ctx: ThemeDataContext) => true,
+        isApplicable: (ctx: ThemeDataContext) => !!ctx.structure && isMVSStructure(ctx.structure),
     };
 }

src/extensions/mvs/load.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2023 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author Adam Midlik <midlik@gmail.com>
  */
@@ -16,6 +16,7 @@ import { MVSAnnotationStructureComponent } from './components/annotation-structu
 import { MVSAnnotationTooltipsProvider } from './components/annotation-tooltips-prop';
 import { CustomLabelProps, CustomLabelRepresentationProvider } from './components/custom-label/representation';
 import { CustomTooltipsProvider } from './components/custom-tooltips-prop';
+import { IsMVSModelProps, IsMVSModelProvider } from './components/is-mvs-model-prop';
 import { AnnotationFromSourceKind, AnnotationFromUriKind, LoadingActions, UpdateTarget, collectAnnotationReferences, collectAnnotationTooltips, collectInlineLabels, collectInlineTooltips, colorThemeForNode, componentFromXProps, componentPropsFromSelector, isPhantomComponent, labelFromXProps, loadTree, makeNearestReprMap, prettyNameFromSelector, representationProps, structureProps, transformProps } from './load-helpers';
 import { MVSData } from './mvs-data';
 import { ParamsOfKind, SubTreeOfKind, validateTree } from './tree/generic/tree-schema';
@@ -119,10 +120,12 @@ const MolstarLoadingActions: LoadingActions<MolstarTree, MolstarLoadingContext>
         });
         UpdateTarget.apply(model, CustomModelProperties, {
             properties: {
-                [MVSAnnotationsProvider.descriptor.name]: { annotations }
+                [IsMVSModelProvider.descriptor.name]: { isMvs: true } satisfies IsMVSModelProps,
+                [MVSAnnotationsProvider.descriptor.name]: { annotations },
             },
             autoAttach: [
-                MVSAnnotationsProvider.descriptor.name
+                IsMVSModelProvider.descriptor.name,
+                MVSAnnotationsProvider.descriptor.name,
             ],
         });
         return model;