Skip to main content

AtomRenderer

megane-viewer

megane-viewer / AtomRenderer

Interface: AtomRenderer

Defined in: types.ts:128

Interface for atom rendering backends.

Properties​

mesh​

readonly mesh: Object3D

Defined in: types.ts:129

Methods​

clearOverrides()?​

optional clearOverrides(): void

Defined in: types.ts:141

Returns​

void

dispose()​

dispose(): void

Defined in: types.ts:156

Returns​

void

loadSnapshot()​

loadSnapshot(snapshot, colorCtx?): void

Defined in: types.ts:130

Parameters​

snapshot​

Snapshot

colorCtx?​

ColorContext

Returns​

void

setHiddenMask()?​

optional setHiddenMask(mask): void

Defined in: types.ts:147

Hide a subset of atoms (e.g. those rendered as lines by a separate renderer). mask[i] === 1 hides atom i; null shows all. Composes with scale overrides without clobbering them.

Parameters​

mask​

Uint8Array<ArrayBufferLike> | null

Returns​

void

setIllustrative()?​

optional setIllustrative(enabled): void

Defined in: types.ts:137

Toggle flat, unlit shading with a silhouette outline (illustrative mode).

Parameters​

enabled​

boolean

Returns​

void

setOpacity()?​

optional setOpacity(opacity): void

Defined in: types.ts:138

Parameters​

opacity​

number

Returns​

void

setOpacityOverrides()?​

optional setOpacityOverrides(overrides): void

Defined in: types.ts:140

Parameters​

overrides​

Float32Array

Returns​

void

setRadiusScale()?​

optional setRadiusScale(scale, snapshot): void

Defined in: types.ts:135

Fraction of the vdW radius atoms are drawn at (ball-and-stick vs spacefill).

Parameters​

scale​

number

snapshot​

Snapshot

Returns​

void

setRadiusSink()?​

optional setRadiusSink(sink): void

Defined in: types.ts:155

Subscribe to ball-size changes: the per-atom radii (base radius × per-atom override, 0 for atoms that draw nothing) and the global multiplier on top. radii is null when only the multiplier moved, so O(1) scale / opacity updates stay O(1). The bond renderer uses both to trim each stick at the ball's surface. Fires immediately on subscribe; null unsubscribes.

Parameters​

sink​

((radii, scale) => void) | null

Returns​

void

setScale()?​

optional setScale(scale, snapshot): void

Defined in: types.ts:132

Parameters​

scale​

number

snapshot​

Snapshot

Returns​

void

setScaleOverrides()?​

optional setScaleOverrides(overrides): void

Defined in: types.ts:139

Parameters​

overrides​

Float32Array

Returns​

void

setUniformRadius()?​

optional setUniformRadius(radius, snapshot): void

Defined in: types.ts:133

Parameters​

radius​

number | null

snapshot​

Snapshot

Returns​

void

updatePositions()​

updatePositions(positions): void

Defined in: types.ts:131

Parameters​

positions​

Float32Array

Returns​

void