Class PlaceVolumeTool

This class is used to create the Volume annotation tool.

Hierarchy

PlaceCollectionAnnotationTool
- PlaceVolumeTool

Constructors

constructor

new PlaceVolumeTool(layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer, options: any, session?: undefined | VolumeSession, mode?: VolumeToolMode, sessionDiv?: undefined | HTMLElement, iconDiv?: undefined | HTMLElement): PlaceVolumeTool
Parameters
- layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer
- options: any
- session: undefined | VolumeSession = undefined
- mode: VolumeToolMode = VolumeToolMode.NOOP
- sessionDiv: undefined | HTMLElement = undefined
- iconDiv: undefined | HTMLElement = undefined
Returns PlaceVolumeTool
Overrides PlaceCollectionAnnotationTool.constructor
- Defined in src/neuroglancer/ui/annotations.ts:1929

Properties

active

active: boolean

annotationType

annotationType: POLYGON | VOLUME

changed

changed: Signal<(() => void)> = ...

childTool

childTool: undefined | PlacePolygonTool

Volume tool utilises the polygon tool to draw annotations.

disposedStacks

disposedStacks: any

icon

icon: WatchableValue<undefined | HTMLElement> = ...

inProgressAnnotation

inProgressAnnotation: undefined | {
    annotationLayer: AnnotationLayerState;
    disposer: (() => void);
    reference: AnnotationReference;
}

layer

layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer

mode

mode: VolumeToolMode

refCount

refCount: number = 1

session

session: WatchableValue<undefined | VolumeSession> = ...

sessionWidget

sessionWidget: undefined | RefCounted

sessionWidgetDiv

sessionWidgetDiv: undefined | HTMLElement

sourceMouseState

sourceMouseState: MouseSelectionState

sourcePosition

sourcePosition: any

wasDisposed

wasDisposed: undefined | boolean

Accessors

annotationColorPicker

get annotationColorPicker(): undefined | AnnotationColorWidget
Returns undefined | AnnotationColorWidget
Inherited from PlaceCollectionAnnotationTool.annotationColorPicker
- Defined in src/neuroglancer/ui/annotations.ts:1257

annotationLayer

get annotationLayer(): undefined | AnnotationLayerState
Returns undefined | AnnotationLayerState
Inherited from PlaceCollectionAnnotationTool.annotationLayer
- Defined in src/neuroglancer/ui/annotations.ts:1250

description

get description(): "volume session (draw mode)" | "volume session (edit mode)" | "volume session (view mode)"
Returns "volume session (draw mode)" | "volume session (edit mode)" | "volume session (view mode)"
Overrides PlaceCollectionAnnotationTool.description
- Defined in src/neuroglancer/ui/annotations.ts:2258

mouseState

get mouseState(): MouseSelectionState
Returns MouseSelectionState
Inherited from PlaceCollectionAnnotationTool.mouseState
- Defined in src/neuroglancer/ui/tool.ts:81

Methods

addRef

addRef(): PlaceVolumeTool
Returns PlaceVolumeTool
Inherited from PlaceCollectionAnnotationTool.addRef
- Defined in src/neuroglancer/util/disposable.ts:48

addVertexPolygon

addVertexPolygon(mouseState: MouseSelectionState): void
Adds a new vertex to the polygon in edit mode.

Returns
Parameters
- mouseState: MouseSelectionState
Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2093

complete

complete(): boolean
Completes the last edge of polygon to be drawn.

Returns
true if the operation suceeded otherwise false.

Returns boolean
Overrides PlaceCollectionAnnotationTool.complete
- Defined in src/neuroglancer/ui/annotations.ts:2053

createNewVolumeAnn

createNewVolumeAnn(description: undefined | string, color: undefined | string): undefined | AnnotationReference
Takes description and color and creates a new volume annotation.

Returns
Parameters
- description: undefined | string
- color: undefined | string
Returns undefined | AnnotationReference
- Defined in src/neuroglancer/ui/annotations.ts:1997

deactivate

deactivate(): void
Deactivates the annotation tool.

Returns void
Overrides PlaceCollectionAnnotationTool.deactivate
- Defined in src/neuroglancer/ui/annotations.ts:2044

deleteVertexPolygon

deleteVertexPolygon(mouseState: MouseSelectionState): void
Deletes a vertex of the polygon in edit mode.

Returns
Parameters
- mouseState: MouseSelectionState
Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2104

displayVolumeSession

displayVolumeSession(): void
This function is used to display the Volume session data in the annotation tabs while the user is annotating.

Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2130

dispose

dispose(): void
Disposes the annotation tool.

Returns void
Overrides PlaceCollectionAnnotationTool.dispose
- Defined in src/neuroglancer/ui/annotations.ts:2020

`Private` disposeSession

disposeSession(): void
Deletes the current active session

Returns void
- Defined in src/neuroglancer/ui/annotations.ts:2072

disposed

disposed(): void
Returns void
Inherited from PlaceCollectionAnnotationTool.disposed
- Defined in src/neuroglancer/ui/annotations.ts:1411

getInitialAnnotation

getInitialAnnotation(mouseState: MouseSelectionState, annotationLayer: AnnotationLayerState): Annotation
Returns the initial collection annotation based on the mouse location.

Returns
newly created annotation.
Parameters
- mouseState: MouseSelectionState
- annotationLayer: AnnotationLayerState
Returns Annotation
Inherited from PlaceCollectionAnnotationTool.getInitialAnnotation
- Defined in src/neuroglancer/ui/annotations.ts:1435

getUpdatedAnnotation

getUpdatedAnnotation(oldAnnotation: Annotation, mouseState: MouseSelectionState, annotationLayer: AnnotationLayerState): Annotation
Get updated annotation based on the source position of the mouse.

Returns
updated annotation.
Parameters
- oldAnnotation: Annotation
- mouseState: MouseSelectionState
- annotationLayer: AnnotationLayerState
Returns Annotation
Inherited from PlaceCollectionAnnotationTool.getUpdatedAnnotation
- Defined in src/neuroglancer/ui/annotations.ts:1460

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from PlaceCollectionAnnotationTool.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 PlaceCollectionAnnotationTool.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 PlaceCollectionAnnotationTool.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 PlaceCollectionAnnotationTool.registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

setActive

setActive(_value: boolean): void
Activates the annotation tool if value is true.
Parameters
- _value: boolean
Returns void
Overrides PlaceCollectionAnnotationTool.setActive
- Defined in src/neuroglancer/ui/annotations.ts:2032

setIconColor

setIconColor(): void
Sets the icon color of the volume tool based on the type of mode

Returns void
- Defined in src/neuroglancer/ui/annotations.ts:1956

toJSON

toJSON(): string
Returns string
Overrides PlaceCollectionAnnotationTool.toJSON
- Defined in src/neuroglancer/ui/annotations.ts:2269

trigger

trigger(mouseState: MouseSelectionState): void
This function is called when the user tries to draw annotation

Returns
void
Parameters
- mouseState: MouseSelectionState
Returns void
Overrides PlaceCollectionAnnotationTool.trigger
- Defined in src/neuroglancer/ui/annotations.ts:1978

unbind

unbind(): void
Returns void
Inherited from PlaceCollectionAnnotationTool.unbind
- Defined in src/neuroglancer/ui/tool.ts:89

undo

undo(mouseState: MouseSelectionState): boolean
Undo the last drawn polygon line segment.
Parameters
- mouseState: MouseSelectionState
Returns boolean
Overrides PlaceCollectionAnnotationTool.undo
- Defined in src/neuroglancer/ui/annotations.ts:2082

unregisterDisposer

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

validateSession

validateSession(annotationId: undefined | string, annotationLayer: undefined | AnnotationLayerState): boolean
Valides the session, that is if the volume id edited is the current active session or not.

Returns
Parameters
- annotationId: undefined | string
- annotationLayer: undefined | AnnotationLayerState
Returns boolean
- Defined in src/neuroglancer/ui/annotations.ts:2116

Class PlaceVolumeTool

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer

options: any

session: undefined | VolumeSession = undefined

mode: VolumeToolMode = VolumeToolMode.NOOP

sessionDiv: undefined | HTMLElement = undefined

iconDiv: undefined | HTMLElement = undefined

Returns PlaceVolumeTool

Properties

active

annotationType

changed

childTool

disposedStacks

icon

inProgressAnnotation

layer

mode

refCount

session

sessionWidget

sessionWidgetDiv

sourceMouseState

sourcePosition

wasDisposed

Accessors

annotationColorPicker

Returns undefined | AnnotationColorWidget

annotationLayer

Returns undefined | AnnotationLayerState

description

Returns "volume session (draw mode)" | "volume session (edit mode)" | "volume session (view mode)"

mouseState

Returns MouseSelectionState

Methods

addRef

Returns PlaceVolumeTool

addVertexPolygon

Returns

Parameters

mouseState: MouseSelectionState

Returns void

complete

Returns

Returns boolean

createNewVolumeAnn

Returns

Parameters

description: undefined | string

color: undefined | string

Returns undefined | AnnotationReference

deactivate

Returns void

deleteVertexPolygon

Returns

Parameters

mouseState: MouseSelectionState

Returns void

displayVolumeSession

Returns void

dispose

Returns void

Private disposeSession

Returns void

disposed

Returns void

getInitialAnnotation

Returns

Parameters

mouseState: MouseSelectionState

annotationLayer: AnnotationLayerState

`Private` disposeSession

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions