Class SpatiallyIndexedAnnotationLayer<TBase>

Type Parameters

TBase extends AnyConstructor<AnnotationRenderLayer>

Hierarchy

C<AnyConstructor<VisibilityTrackedRenderLayer<LayerView, unknown>>, this> & VisibilityTrackedRenderLayer<LayerView, unknown, this>
- SpatiallyIndexedAnnotationLayer

Constructors

constructor

new SpatiallyIndexedAnnotationLayer(options: {
    annotationLayer: AnnotationLayer;
    renderScaleHistogram: RenderScaleHistogram;
    renderScaleTarget: WatchableValueInterface<number>;
}): SpatiallyIndexedAnnotationLayer<TBase>
Parameters
- options: {
      annotationLayer: AnnotationLayer;
      renderScaleHistogram: RenderScaleHistogram;
      renderScaleTarget: WatchableValueInterface<number>;
  }
  - annotationLayer: AnnotationLayer
  - renderScaleHistogram: RenderScaleHistogram
  - renderScaleTarget: WatchableValueInterface<number>
Returns SpatiallyIndexedAnnotationLayer<TBase>
Overrides (Base as AnyConstructor<AnnotationRenderLayer>).constructor
- Defined in src/neuroglancer/annotation/renderlayer.ts:653

Properties

backend

backend: SharedObject

base

base: AnnotationLayer

curRank

curRank: number = -1

disposedStacks

disposedStacks: any

isAnnotation

isAnnotation: boolean = true

layerChanged

layerChanged: NullarySignal = ...

layerChunkProgressInfo

layerChunkProgressInfo: LayerChunkProgressInfo = ...

messages

messages: MessageList = ...

redrawNeeded

redrawNeeded: NullarySignal = ...

refCount

refCount: number = 1

renderScaleHistogram

renderScaleHistogram: RenderScaleHistogram

renderScaleTarget

renderScaleTarget: WatchableValueInterface<number>

role

role: RenderLayerRole = RenderLayerRole.DATA

userLayer

userLayer: undefined | UserLayer

visibility

visibility: VisibilityPriorityAggregator = ...

wasDisposed

wasDisposed: undefined | boolean

wireFrameRenderHelper

wireFrameRenderHelper: {
    defineShader(builder: ShaderBuilder): void;
    draw(shader: ShaderProgram, tsource: TransformedSource<SliceViewRenderLayer, SliceViewChunkSource<SliceViewChunkSpecification<Uint32Array | Float32Array>>>, projectionParameters: SliceViewProjectionParameters): void;
    initialize(shader: ShaderProgram, projectionParameters: SliceViewProjectionParameters): void;
} = ...

Type declaration

defineShader:function
- defineShader(builder: ShaderBuilder): void
- Parameters
  - builder: ShaderBuilder
  Returns void
  - Defined in src/neuroglancer/sliceview/wire_frame.ts:108
draw:function
- draw(shader: ShaderProgram, tsource: TransformedSource<SliceViewRenderLayer, SliceViewChunkSource<SliceViewChunkSpecification<Uint32Array | Float32Array>>>, projectionParameters: SliceViewProjectionParameters): void
- Parameters
  - shader: ShaderProgram
  - tsource: TransformedSource<SliceViewRenderLayer, SliceViewChunkSource<SliceViewChunkSpecification<Uint32Array | Float32Array>>>
  - projectionParameters: SliceViewProjectionParameters
  Returns void
  - Defined in src/neuroglancer/sliceview/wire_frame.ts:127
initialize:function
- initialize(shader: ShaderProgram, projectionParameters: SliceViewProjectionParameters): void
- Parameters
  - shader: ShaderProgram
  - projectionParameters: SliceViewProjectionParameters
  Returns void
  - Defined in src/neuroglancer/sliceview/wire_frame.ts:123

wireFrameShaderGetter

wireFrameShaderGetter: ParameterizedContextDependentShaderGetter<ShaderModule, undefined, undefined> = ...

Accessors

chunkTransform

get chunkTransform(): ValueOrError<ChunkTransformParameters>
Returns ValueOrError<ChunkTransformParameters>
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).chunkTransform
- Defined in src/neuroglancer/annotation/renderlayer.ts:392

gl

get gl(): GL
Returns GL
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).gl
- Defined in src/neuroglancer/annotation/renderlayer.ts:407

Methods

addRef

addRef(): SpatiallyIndexedAnnotationLayer<TBase>
Returns SpatiallyIndexedAnnotationLayer<TBase>
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).addRef
- Defined in src/neuroglancer/util/disposable.ts:48

attach

attach(attachment: VisibleLayerInfo<LayerView, SpatiallyIndexedValidAttachmentState>): void
Parameters
- attachment: VisibleLayerInfo<LayerView, SpatiallyIndexedValidAttachmentState>
Returns void
Overrides (Base as AnyConstructor<AnnotationRenderLayer>).attach
- Defined in src/neuroglancer/annotation/renderlayer.ts:679

dispose

dispose(): void
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).dispose
- Defined in src/neuroglancer/util/disposable.ts:53

disposed

disposed(): void
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).disposed
- Defined in src/neuroglancer/util/disposable.ts:75

draw

draw(renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext, attachment: VisibleLayerInfo<PerspectivePanel, SpatiallyIndexedValidAttachmentState>): void
Parameters
- renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext
- attachment: VisibleLayerInfo<PerspectivePanel, SpatiallyIndexedValidAttachmentState>
Returns void
- Defined in src/neuroglancer/annotation/renderlayer.ts:724

drawGeometry

drawGeometry(chunk: AnnotationGeometryDataInterface, renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext, state: AnnotationChunkRenderParameters, drawFraction?: number): void
Parameters
- chunk: AnnotationGeometryDataInterface
- renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext
- state: AnnotationChunkRenderParameters
- drawFraction: number = 1
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).drawGeometry
- Defined in src/neuroglancer/annotation/renderlayer.ts:429

drawGeometryChunkData

drawGeometryChunkData(chunk: AnnotationGeometryData, renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext, state: AnnotationChunkRenderParameters, drawFraction?: number): void
Parameters
- chunk: AnnotationGeometryData
- renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext
- state: AnnotationChunkRenderParameters
- drawFraction: number = 1
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).drawGeometryChunkData
- Defined in src/neuroglancer/annotation/renderlayer.ts:411

getValueAt

getValueAt(_x: Float32Array): any
Parameters
- _x: Float32Array
Returns any
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).getValueAt
- Defined in src/neuroglancer/renderlayer.ts:58

handleAction

handleAction(_action: string): void
Parameters
- _action: string
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).handleAction
- Defined in src/neuroglancer/renderlayer.ts:54

handleRankChanged

handleRankChanged(): void
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).handleRankChanged
- Defined in src/neuroglancer/annotation/renderlayer.ts:322

isReady

isReady(): boolean
Returns boolean
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).isReady
- Defined in src/neuroglancer/annotation/renderlayer.ts:561

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).refCountReachedZero
- Defined in src/neuroglancer/util/disposable.ts:66

registerCancellable

registerCancellable<T>(cancellable: T): T
Type Parameters
- T extends {
  cancel: (() => void);
  }
Parameters
- cancellable: T
Returns T
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).registerDisposer
- Defined in src/neuroglancer/util/disposable.ts:76

registerEventListener

registerEventListener(target: EventTarget, type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- target: EventTarget
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

transformPickedValue

transformPickedValue(pickState: PickState): undefined | string
Transform the stored pickedValue and offset associated with the retrieved pick ID into the actual value.
Parameters
- pickState: PickState
Returns undefined | string
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).transformPickedValue
- Defined in src/neuroglancer/annotation/renderlayer.ts:544
transformPickedValue(pickState: PickState): any
Transform the stored pickedValue and offset associated with the retrieved pick ID into the actual value.
Parameters
- pickState: PickState
Returns any
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).transformPickedValue
- Defined in src/neuroglancer/renderlayer.ts:66

unregisterDisposer

unregisterDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

updateAttachmentState

updateAttachmentState(attachment: VisibleLayerInfo<LayerView, AttachmentState>): undefined | AnnotationChunkRenderParameters
Parameters
- attachment: VisibleLayerInfo<LayerView, AttachmentState>
Returns undefined | AnnotationChunkRenderParameters
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).updateAttachmentState
- Defined in src/neuroglancer/annotation/renderlayer.ts:375

updateModelClipBounds

updateModelClipBounds(renderContext: ThreeDimensionalRenderContext, state: AnnotationChunkRenderParameters): void
Parameters
- renderContext: ThreeDimensionalRenderContext
- state: AnnotationChunkRenderParameters
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).updateModelClipBounds
- Defined in src/neuroglancer/annotation/renderlayer.ts:396

updateMouseState

updateMouseState(mouseState: MouseSelectionState, _pickedValue: Uint64, pickedOffset: number, data: any): void
Optionally updates the mouse state based on the retrived pick information. This might snap the 3-d position to the center of the picked point.
Parameters
- mouseState: MouseSelectionState
- _pickedValue: Uint64
- pickedOffset: number
- data: any
Returns void
Inherited from (Base as AnyConstructor<AnnotationRenderLayer>).updateMouseState
- Defined in src/neuroglancer/annotation/renderlayer.ts:484

Class SpatiallyIndexedAnnotationLayer<TBase>

Type Parameters

TBase extends AnyConstructor<AnnotationRenderLayer>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { annotationLayer: AnnotationLayer; renderScaleHistogram: RenderScaleHistogram; renderScaleTarget: WatchableValueInterface<number>; }

annotationLayer: AnnotationLayer

renderScaleHistogram: RenderScaleHistogram

renderScaleTarget: WatchableValueInterface<number>

Returns SpatiallyIndexedAnnotationLayer<TBase>

Properties

backend

base

curRank

disposedStacks

isAnnotation

layerChanged

layerChunkProgressInfo

messages

redrawNeeded

refCount

renderScaleHistogram

renderScaleTarget

role

userLayer

visibility

wasDisposed

wireFrameRenderHelper

Type declaration

defineShader:function

Parameters

builder: ShaderBuilder

Returns void

draw:function

Parameters

shader: ShaderProgram

tsource: TransformedSource<SliceViewRenderLayer, SliceViewChunkSource<SliceViewChunkSpecification<Uint32Array | Float32Array>>>

projectionParameters: SliceViewProjectionParameters

Returns void

initialize:function

Parameters

shader: ShaderProgram

projectionParameters: SliceViewProjectionParameters

Returns void

wireFrameShaderGetter

Accessors

chunkTransform

Returns ValueOrError<ChunkTransformParameters>

gl

Returns GL

Methods

addRef

Returns SpatiallyIndexedAnnotationLayer<TBase>

attach

Parameters

attachment: VisibleLayerInfo<LayerView, SpatiallyIndexedValidAttachmentState>

Returns void

dispose

Returns void

disposed

Returns void

draw

Parameters

renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext

attachment: VisibleLayerInfo<PerspectivePanel, SpatiallyIndexedValidAttachmentState>

Returns void

drawGeometry

Parameters

chunk: AnnotationGeometryDataInterface

renderContext: PerspectiveViewRenderContext | SliceViewPanelRenderContext

state: AnnotationChunkRenderParameters

drawFraction: number = 1

Returns void

options: {
annotationLayer: AnnotationLayer;
renderScaleHistogram: RenderScaleHistogram;
renderScaleTarget: WatchableValueInterface<number>;
}

`Protected` refCountReachedZero

T extends {
cancel: (() => void);
}

`Optional` options: boolean | AddEventListenerOptions