Interface VolumeVisualBuilder<P, G>

Type Parameters

P extends <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-repr/volume/representation".VolumeParams
G extends Geometry

Hierarchy

VolumeVisualBuilder
- VolumeVisualGeometryBuilder

Index

Properties

defaultProps dispose? mustRecreate?

Methods

createGeometry createLocationIterator eachLocation getLoci setUpdateState

Properties

defaultProps

defaultProps: <internal>.Values

`Optional` dispose

dispose?: ((geometry: G) => void)

Type declaration

- (geometry: G): void
- Parameters
  - geometry: G
  Returns void

`Optional` mustRecreate

mustRecreate?: ((volume: Volume, props: <internal>.Values) => boolean)

Type declaration

- (volume: Volume, props: <internal>.Values): boolean
- Parameters
 - volume: Volume
 - props: <internal>.Values
 Returns boolean

Methods

createGeometry

createGeometry(ctx: VisualContext, volume: Volume, theme: <internal>.Theme, props: <internal>.Values, geometry?: G): G | Promise<G>
Parameters
- ctx: VisualContext
- volume: Volume
- theme: <internal>.Theme
- props: <internal>.Values
- Optional geometry: G
Returns G | Promise<G>
- Defined in node_modules/molstar/lib/mol-repr/volume/representation.d.ts:22

createLocationIterator

createLocationIterator(volume: Volume): <internal>.LocationIterator
Parameters
- volume: Volume
Returns <internal>.LocationIterator
- Defined in node_modules/molstar/lib/mol-repr/volume/representation.d.ts:23

eachLocation

eachLocation(loci: <internal>.Loci, volume: Volume, props: <internal>.Values, apply: ((interval: <internal>.Interval<number>) => boolean)): boolean
Parameters
- loci: <internal>.Loci
- volume: Volume
- props: <internal>.Values
- apply: ((interval: <internal>.Interval<number>) => boolean)
 - - (interval: <internal>.Interval<number>): boolean
 - Parameters
 
 interval: <internal>.Interval<number>
 
 Returns boolean
Returns boolean
- Defined in node_modules/molstar/lib/mol-repr/volume/representation.d.ts:25

getLoci

getLoci(pickingId: PickingId, volume: Volume, props: <internal>.Values, id: number): <internal>.Loci
Parameters
- pickingId: PickingId
- volume: Volume
- props: <internal>.Values
- id: number
Returns <internal>.Loci
- Defined in node_modules/molstar/lib/mol-repr/volume/representation.d.ts:24

setUpdateState

setUpdateState(state: VisualUpdateState, volume: Volume, newProps: <internal>.Values, currentProps: <internal>.Values, newTheme: <internal>.Theme, currentTheme: <internal>.Theme): void
Parameters
- state: VisualUpdateState
- volume: Volume
- newProps: <internal>.Values
- currentProps: <internal>.Values
- newTheme: <internal>.Theme
- currentTheme: <internal>.Theme
Returns void
- Defined in node_modules/molstar/lib/mol-repr/volume/representation.d.ts:26

Interface VolumeVisualBuilder<P, G>

Type Parameters

P extends <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-repr/volume/representation".VolumeParams

G extends Geometry

Hierarchy

Index

Properties

Methods

Properties

defaultProps

Optional dispose

Type declaration

Parameters

geometry: G

Returns void

Optional mustRecreate

Type declaration

Parameters

volume: Volume

props: <internal>.Values<P>

Returns boolean

Methods

createGeometry

Parameters

ctx: VisualContext

volume: Volume

theme: <internal>.Theme

props: <internal>.Values<P>

Optional geometry: G

Returns G | Promise<G>

createLocationIterator

Parameters

volume: Volume

Returns <internal>.LocationIterator

eachLocation

Parameters

loci: <internal>.Loci

volume: Volume

props: <internal>.Values<P>

apply: ((interval: <internal>.Interval<number>) => boolean)

Parameters

interval: <internal>.Interval<number>

Returns boolean

Returns boolean

getLoci

Parameters

pickingId: PickingId

volume: Volume

props: <internal>.Values<P>

id: number

Returns <internal>.Loci

setUpdateState

Parameters

state: VisualUpdateState

volume: Volume

newProps: <internal>.Values<P>

currentProps: <internal>.Values<P>

newTheme: <internal>.Theme

currentTheme: <internal>.Theme

Returns void

Settings

Member Visibility

Theme

`Optional` dispose

`Optional` mustRecreate

`Optional` geometry: G