Clipping | @rcsb/rcsb-saguaro-3d

Index

Namespaces

Groups

Type aliases

Variables

Functions

Type aliases

BundleLayer

BundleLayer: { bundle: <internal>.Bundle; groups: Groups }

Type declaration

bundle: <internal>.Bundle
groups: Groups

Groups

Groups: BitFlags<<internal>.Clipping.Groups.Flag>

Layer

Layer: { groups: Groups; loci: <internal>.Loci }

Type declaration

Readonly groups: Groups
Readonly loci: <internal>.Loci

ScriptLayer

ScriptLayer: { groups: Groups; script: <internal>.Script }

Type declaration

groups: Groups
script: <internal>.Script

Variant

Variant: "instance" | "pixel"

Variables

Empty

Empty: <internal>.Clipping

Type

Type: { cube: number; cylinder: number; infiniteCone: number; none: number; plane: number; sphere: number }

Clip object types

Type declaration

cube: number
cylinder: number
infiniteCone: number
none: number
plane: number
sphere: number

Functions

areEqual

areEqual(cA: <internal>.Clipping, cB: <internal>.Clipping): boolean

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:57
Parameters
- cA: <internal>.Clipping
- cB: <internal>.Clipping
Returns boolean

filter

filter(clipping: <internal>.Clipping, filter: <internal>.Structure): <internal>.Clipping

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:63
Parameters
- clipping: <internal>.Clipping
- filter: <internal>.Structure
Returns <internal>.Clipping

isEmpty

isEmpty(clipping: <internal>.Clipping): boolean

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:58
Parameters
- clipping: <internal>.Clipping
Returns boolean

merge

merge(clipping: <internal>.Clipping): <internal>.Clipping

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:62
Parameters
- clipping: <internal>.Clipping
Returns <internal>.Clipping

ofBundle

ofBundle(bundleLayers: <internal>.Clipping.BundleLayer[], structure: <internal>.Structure): <internal>.Clipping

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:73
Parameters
- bundleLayers: <internal>.Clipping.BundleLayer[]
- structure: <internal>.Structure
Returns <internal>.Clipping

ofScript

ofScript(scriptLayers: <internal>.Clipping.ScriptLayer[], structure: <internal>.Structure): <internal>.Clipping

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:68
Parameters
- scriptLayers: <internal>.Clipping.ScriptLayer[]
- structure: <internal>.Structure
Returns <internal>.Clipping

remap

remap(clipping: <internal>.Clipping, structure: <internal>.Structure): { layers: <internal>.Clipping.Layer[] }

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:59
Parameters
- clipping: <internal>.Clipping
- structure: <internal>.Structure
Returns { layers: <internal>.Clipping.Layer[] }
- layers: <internal>.Clipping.Layer[]

toBundle

toBundle(clipping: <internal>.Clipping): { layers: <internal>.Clipping.BundleLayer[] }

- Defined in node_modules/molstar/lib/mol-theme/clipping.d.ts:74
Parameters
- clipping: <internal>.Clipping
Returns { layers: <internal>.Clipping.BundleLayer[] }
- layers: <internal>.Clipping.BundleLayer[]

Index

Namespaces

Type aliases

Variables

Functions

Type aliases

BundleLayer

Type declaration

bundle: <internal>.Bundle

groups: Groups

Groups

Layer

Type declaration

Readonly groups: Groups

Readonly loci: <internal>.Loci

ScriptLayer

Type declaration

groups: Groups

script: <internal>.Script

Variant

Variables

Empty

Type

Type declaration

cube: number

cylinder: number

infiniteCone: number

none: number

plane: number

sphere: number

Functions

areEqual

Parameters

cA: <internal>.Clipping

cB: <internal>.Clipping

Returns boolean

filter

Parameters

clipping: <internal>.Clipping

filter: <internal>.Structure

Returns <internal>.Clipping

isEmpty

Parameters

clipping: <internal>.Clipping

Returns boolean

merge

Parameters

clipping: <internal>.Clipping

Returns <internal>.Clipping

ofBundle

Parameters

bundleLayers: <internal>.Clipping.BundleLayer[]

structure: <internal>.Structure

Returns <internal>.Clipping

ofScript

Parameters

scriptLayers: <internal>.Clipping.ScriptLayer[]

structure: <internal>.Structure

Returns <internal>.Clipping

remap

Parameters

clipping: <internal>.Clipping

structure: <internal>.Structure

Returns { layers: <internal>.Clipping.Layer[] }

layers: <internal>.Clipping.Layer[]

toBundle

Parameters

clipping: <internal>.Clipping

Returns { layers: <internal>.Clipping.BundleLayer[] }

layers: <internal>.Clipping.BundleLayer[]