molstar
Version:
A comprehensive macromolecular library.
371 lines (370 loc) • 23.5 kB
TypeScript
/**
* Copyright (c) 2018-2025 mol* contributors, licensed under MIT, See LICENSE file for more info.
*
* @author Alexander Rose <alexander.rose@weirdbyte.de>
*/
import { RepresentationRegistry, Representation, RepresentationProvider } from '../representation';
import { Volume } from '../../mol-model/volume';
export declare class VolumeRepresentationRegistry extends RepresentationRegistry<Volume, Representation.State> {
constructor();
}
export declare namespace VolumeRepresentationRegistry {
export const BuiltIn: {
'direct-volume': import("./representation").VolumeRepresentationProvider<{
quality: {
isEssential: boolean;
type: "select";
options: readonly (readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string] | readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string, string | undefined])[];
cycle?: boolean;
isOptional?: boolean;
defaultValue: "auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest";
label?: string;
description?: string;
legend?: import("../../mol-util/legend").Legend;
fieldLabels?: {
[name: string]: string;
};
isHidden?: boolean;
shortLabel?: boolean;
twoColumns?: boolean;
category?: string;
hideIf?: (currentGroup: any) => boolean;
help?: (value: any) => {
description?: string;
legend?: import("../../mol-util/legend").Legend;
};
};
dataType: import("../../mol-util/param-definition").ParamDefinition.Select<"float" | "byte" | "halfFloat">;
ignoreLight: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
celShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
xrayShaded: import("../../mol-util/param-definition").ParamDefinition.Select<boolean | "inverted">;
controlPoints: import("../../mol-util/param-definition").ParamDefinition.LineGraph;
stepsPerCell: import("../../mol-util/param-definition").ParamDefinition.Numeric;
jumpLength: import("../../mol-util/param-definition").ParamDefinition.Numeric;
alpha: import("../../mol-util/param-definition").ParamDefinition.Numeric;
material: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
metalness: number;
roughness: number;
bumpiness: number;
}>>;
clip: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
variant: import("../../mol-util/clip").Clip.Variant;
objects: import("../../mol-util/param-definition").ParamDefinition.Normalize<{
type: /*elided*/ any;
invert: /*elided*/ any;
position: /*elided*/ any;
rotation: /*elided*/ any;
scale: /*elided*/ any;
transform: /*elided*/ any;
}>[];
}>>;
emissive: import("../../mol-util/param-definition").ParamDefinition.Numeric;
density: import("../../mol-util/param-definition").ParamDefinition.Numeric;
instanceGranularity: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
lod: import("../../mol-util/param-definition").ParamDefinition.Vec3;
cellSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
batchSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
}, "direct-volume">;
dot: import("./representation").VolumeRepresentationProvider<{
visuals: import("../../mol-util/param-definition").ParamDefinition.MultiSelect<"sphere" | "point">;
bumpFrequency: import("../../mol-util/param-definition").ParamDefinition.Numeric;
isoValue: import("../../mol-util/param-definition").ParamDefinition.Conditioned<Readonly<{
kind: "absolute";
absoluteValue: number;
}> | Readonly<{
kind: "relative";
relativeValue: number;
}>, import("../../mol-util/param-definition").ParamDefinition.Base<Readonly<{
kind: "absolute";
absoluteValue: number;
}> | Readonly<{
kind: "relative";
relativeValue: number;
}>>, {
absolute: import("../../mol-util/param-definition").ParamDefinition.Converted<Readonly<{
kind: "absolute";
absoluteValue: number;
}>, number>;
relative: import("../../mol-util/param-definition").ParamDefinition.Converted<Readonly<{
kind: "relative";
relativeValue: number;
}>, number>;
}>;
sizeFactor: import("../../mol-util/param-definition").ParamDefinition.Numeric;
pointSizeAttenuation: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
pointStyle: import("../../mol-util/param-definition").ParamDefinition.Select<"circle" | "square" | "fuzzy">;
alpha: import("../../mol-util/param-definition").ParamDefinition.Numeric;
quality: import("../../mol-util/param-definition").ParamDefinition.Select<"auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest">;
material: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
metalness: number;
roughness: number;
bumpiness: number;
}>>;
clip: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
variant: import("../../mol-util/clip").Clip.Variant;
objects: import("../../mol-util/param-definition").ParamDefinition.Normalize<{
type: /*elided*/ any;
invert: /*elided*/ any;
position: /*elided*/ any;
rotation: /*elided*/ any;
scale: /*elided*/ any;
transform: /*elided*/ any;
}>[];
}>>;
emissive: import("../../mol-util/param-definition").ParamDefinition.Numeric;
density: import("../../mol-util/param-definition").ParamDefinition.Numeric;
instanceGranularity: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
lod: import("../../mol-util/param-definition").ParamDefinition.Vec3;
cellSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
batchSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
tryUseImpostor: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
detail: import("../../mol-util/param-definition").ParamDefinition.Numeric;
doubleSided: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
flipSided: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
flatShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
ignoreLight: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
celShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
xrayShaded: import("../../mol-util/param-definition").ParamDefinition.Select<boolean | "inverted">;
transparentBackfaces: import("../../mol-util/param-definition").ParamDefinition.Select<"off" | "on" | "opaque">;
bumpAmplitude: import("../../mol-util/param-definition").ParamDefinition.Numeric;
solidInterior: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
clipPrimitive: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
approximate: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
alphaThickness: import("../../mol-util/param-definition").ParamDefinition.Numeric;
lodLevels: import("../../mol-util/param-definition").ParamDefinition.ObjectList<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
minDistance: number;
maxDistance: number;
overlap: number;
stride: number;
scaleBias: number;
}>>;
}, "dot">;
isosurface: import("./representation").VolumeRepresentationProvider<{
visuals: import("../../mol-util/param-definition").ParamDefinition.MultiSelect<"solid" | "wireframe">;
bumpFrequency: import("../../mol-util/param-definition").ParamDefinition.Numeric;
quality: {
isEssential: boolean;
type: "select";
options: readonly (readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string] | readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string, string | undefined])[];
cycle?: boolean;
isOptional?: boolean;
defaultValue: "auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest";
label?: string;
description?: string;
legend?: import("../../mol-util/legend").Legend;
fieldLabels?: {
[name: string]: string;
};
isHidden?: boolean;
shortLabel?: boolean;
twoColumns?: boolean;
category?: string;
hideIf?: (currentGroup: any) => boolean;
help?: (value: any) => {
description?: string;
legend?: import("../../mol-util/legend").Legend;
};
};
sizeFactor: import("../../mol-util/param-definition").ParamDefinition.Numeric;
isoValue: import("../../mol-util/param-definition").ParamDefinition.Conditioned<Readonly<{
kind: "absolute";
absoluteValue: number;
}> | Readonly<{
kind: "relative";
relativeValue: number;
}>, import("../../mol-util/param-definition").ParamDefinition.Base<Readonly<{
kind: "absolute";
absoluteValue: number;
}> | Readonly<{
kind: "relative";
relativeValue: number;
}>>, {
absolute: import("../../mol-util/param-definition").ParamDefinition.Converted<Readonly<{
kind: "absolute";
absoluteValue: number;
}>, number>;
relative: import("../../mol-util/param-definition").ParamDefinition.Converted<Readonly<{
kind: "relative";
relativeValue: number;
}>, number>;
}>;
lineSizeAttenuation: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
alpha: import("../../mol-util/param-definition").ParamDefinition.Numeric;
material: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
metalness: number;
roughness: number;
bumpiness: number;
}>>;
clip: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
variant: import("../../mol-util/clip").Clip.Variant;
objects: import("../../mol-util/param-definition").ParamDefinition.Normalize<{
type: /*elided*/ any;
invert: /*elided*/ any;
position: /*elided*/ any;
rotation: /*elided*/ any;
scale: /*elided*/ any;
transform: /*elided*/ any;
}>[];
}>>;
emissive: import("../../mol-util/param-definition").ParamDefinition.Numeric;
density: import("../../mol-util/param-definition").ParamDefinition.Numeric;
instanceGranularity: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
lod: import("../../mol-util/param-definition").ParamDefinition.Vec3;
cellSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
batchSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
tryUseGpu: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
gpuDataType: import("../../mol-util/param-definition").ParamDefinition.Select<"float" | "byte" | "halfFloat">;
doubleSided: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
flipSided: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
flatShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
ignoreLight: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
celShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
xrayShaded: import("../../mol-util/param-definition").ParamDefinition.Select<boolean | "inverted">;
transparentBackfaces: import("../../mol-util/param-definition").ParamDefinition.Select<"off" | "on" | "opaque">;
bumpAmplitude: import("../../mol-util/param-definition").ParamDefinition.Numeric;
}, "isosurface">;
segment: import("./representation").VolumeRepresentationProvider<{
visuals: import("../../mol-util/param-definition").ParamDefinition.MultiSelect<"segment">;
bumpFrequency: import("../../mol-util/param-definition").ParamDefinition.Numeric;
quality: {
isEssential: boolean;
type: "select";
options: readonly (readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string] | readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string, string | undefined])[];
cycle?: boolean;
isOptional?: boolean;
defaultValue: "auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest";
label?: string;
description?: string;
legend?: import("../../mol-util/legend").Legend;
fieldLabels?: {
[name: string]: string;
};
isHidden?: boolean;
shortLabel?: boolean;
twoColumns?: boolean;
category?: string;
hideIf?: (currentGroup: any) => boolean;
help?: (value: any) => {
description?: string;
legend?: import("../../mol-util/legend").Legend;
};
};
tryUseGpu: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
segments: import("../../mol-util/param-definition").ParamDefinition.Converted<number[], string[]>;
doubleSided: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
flipSided: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
flatShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
ignoreLight: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
celShaded: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
xrayShaded: import("../../mol-util/param-definition").ParamDefinition.Select<boolean | "inverted">;
transparentBackfaces: import("../../mol-util/param-definition").ParamDefinition.Select<"off" | "on" | "opaque">;
bumpAmplitude: import("../../mol-util/param-definition").ParamDefinition.Numeric;
alpha: import("../../mol-util/param-definition").ParamDefinition.Numeric;
material: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
metalness: number;
roughness: number;
bumpiness: number;
}>>;
clip: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
variant: import("../../mol-util/clip").Clip.Variant;
objects: import("../../mol-util/param-definition").ParamDefinition.Normalize<{
type: /*elided*/ any;
invert: /*elided*/ any;
position: /*elided*/ any;
rotation: /*elided*/ any;
scale: /*elided*/ any;
transform: /*elided*/ any;
}>[];
}>>;
emissive: import("../../mol-util/param-definition").ParamDefinition.Numeric;
density: import("../../mol-util/param-definition").ParamDefinition.Numeric;
instanceGranularity: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
lod: import("../../mol-util/param-definition").ParamDefinition.Vec3;
cellSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
batchSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
}, "segment">;
slice: import("./representation").VolumeRepresentationProvider<{
quality: {
isEssential: boolean;
type: "select";
options: readonly (readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string] | readonly ["auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest", string, string | undefined])[];
cycle?: boolean;
isOptional?: boolean;
defaultValue: "auto" | "medium" | "high" | "low" | "custom" | "highest" | "higher" | "lower" | "lowest";
label?: string;
description?: string;
legend?: import("../../mol-util/legend").Legend;
fieldLabels?: {
[name: string]: string;
};
isHidden?: boolean;
shortLabel?: boolean;
twoColumns?: boolean;
category?: string;
hideIf?: (currentGroup: any) => boolean;
help?: (value: any) => {
description?: string;
legend?: import("../../mol-util/legend").Legend;
};
};
dimension: import("../../mol-util/param-definition").ParamDefinition.Mapped<import("../../mol-util/param-definition").ParamDefinition.NamedParams<number, "x"> | import("../../mol-util/param-definition").ParamDefinition.NamedParams<number, "y"> | import("../../mol-util/param-definition").ParamDefinition.NamedParams<number, "z">>;
isoValue: import("../../mol-util/param-definition").ParamDefinition.Conditioned<Readonly<{
kind: "absolute";
absoluteValue: number;
}> | Readonly<{
kind: "relative";
relativeValue: number;
}>, import("../../mol-util/param-definition").ParamDefinition.Base<Readonly<{
kind: "absolute";
absoluteValue: number;
}> | Readonly<{
kind: "relative";
relativeValue: number;
}>>, {
absolute: import("../../mol-util/param-definition").ParamDefinition.Converted<Readonly<{
kind: "absolute";
absoluteValue: number;
}>, number>;
relative: import("../../mol-util/param-definition").ParamDefinition.Converted<Readonly<{
kind: "relative";
relativeValue: number;
}>, number>;
}>;
mode: import("../../mol-util/param-definition").ParamDefinition.Select<"grid" | "frame">;
offset: import("../../mol-util/param-definition").ParamDefinition.Numeric;
axis: import("../../mol-util/param-definition").ParamDefinition.Select<"a" | "b" | "c">;
rotation: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
axis: import("../../mol-math/linear-algebra").Vec3;
angle: number;
}>>;
interpolation: import("../../mol-util/param-definition").ParamDefinition.Select<"nearest" | "catmulrom" | "mitchell" | "bspline">;
alpha: import("../../mol-util/param-definition").ParamDefinition.Numeric;
material: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
metalness: number;
roughness: number;
bumpiness: number;
}>>;
clip: import("../../mol-util/param-definition").ParamDefinition.Group<import("../../mol-util/param-definition").ParamDefinition.Normalize<{
variant: import("../../mol-util/clip").Clip.Variant;
objects: import("../../mol-util/param-definition").ParamDefinition.Normalize<{
type: /*elided*/ any;
invert: /*elided*/ any;
position: /*elided*/ any;
rotation: /*elided*/ any;
scale: /*elided*/ any;
transform: /*elided*/ any;
}>[];
}>>;
emissive: import("../../mol-util/param-definition").ParamDefinition.Numeric;
density: import("../../mol-util/param-definition").ParamDefinition.Numeric;
instanceGranularity: import("../../mol-util/param-definition").ParamDefinition.BooleanParam;
lod: import("../../mol-util/param-definition").ParamDefinition.Vec3;
cellSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
batchSize: import("../../mol-util/param-definition").ParamDefinition.Numeric;
}, "slice">;
};
type _BuiltIn = typeof BuiltIn;
export type BuiltIn = keyof _BuiltIn;
export type BuiltInParams<T extends BuiltIn> = Partial<RepresentationProvider.ParamValues<_BuiltIn[T]>>;
export {};
}