Class PlacePolygonTool

This class is used to draw polygon annotations.

Hierarchy

PlaceCollectionAnnotationTool
- PlacePolygonTool

Constructors

constructor

new PlacePolygonTool(layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer, options: any, mode?: PolygonToolMode): PlacePolygonTool
Parameters
- layer: __type<(new (...args: any[]) => UserLayer)> & UserLayer
- options: any
- mode: PolygonToolMode = PolygonToolMode.DRAW
Returns PlacePolygonTool
Overrides PlaceCollectionAnnotationTool.constructor
- Defined in src/neuroglancer/ui/annotations.ts:1486

Properties

active

active: boolean

annotationType

annotationType: POLYGON | VOLUME

bindingsRef

bindingsRef: undefined | RefCounted

changed

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

childTool

childTool: PlaceLineTool

disposedStacks

disposedStacks: any

inProgressAnnotation

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

layer

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

mode

mode: PolygonToolMode

refCount

refCount: number = 1

sourceMouseState

sourceMouseState: MouseSelectionState

sourcePosition

sourcePosition: undefined | Float32Array

wasDisposed

wasDisposed: undefined | boolean

zCoordinate

zCoordinate: undefined | number

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(): "annotate polygon (draw mode)" | "annotate polygon (edit mode)"
Get polygon description to be shown in top corner of annotation tab.

Returns "annotate polygon (draw mode)" | "annotate polygon (edit mode)"
Overrides PlaceCollectionAnnotationTool.description
- Defined in src/neuroglancer/ui/annotations.ts:1860

mouseState

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

Methods

addRef

addRef(): PlacePolygonTool
Returns PlacePolygonTool
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:1737

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:1621

`Private` completeLastLine

completeLastLine(): boolean
Completes the last line of the polygon.

Returns
true if last line was succesfully completed otherwise false.

Returns boolean
- Defined in src/neuroglancer/ui/annotations.ts:1708

deactivate

deactivate(): void
Deactivates the annotation tool.

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

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:1792

dispose

dispose(): void
Disposes the annotation tool.

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

`Private` disposeAnnotation

disposeAnnotation(): void
Dispose current active annotation.

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

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:1585

toJSON

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

trigger

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

Returns
void
Parameters
- mouseState: MouseSelectionState
- Optional parentRef: AnnotationReference
  
  optional parent reference passed from parent tool.
Returns void
Overrides PlaceCollectionAnnotationTool.trigger
- Defined in src/neuroglancer/ui/annotations.ts:1506

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:1653

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

Class PlacePolygonTool

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

options: any

mode: PolygonToolMode = PolygonToolMode.DRAW

Returns PlacePolygonTool

Properties

active

annotationType

bindingsRef

changed

childTool

disposedStacks

inProgressAnnotation

layer

mode

refCount

sourceMouseState

sourcePosition

wasDisposed

zCoordinate

Accessors

annotationColorPicker

Returns undefined | AnnotationColorWidget

annotationLayer

Returns undefined | AnnotationLayerState

description

Returns "annotate polygon (draw mode)" | "annotate polygon (edit mode)"

mouseState

Returns MouseSelectionState

Methods

addRef

Returns PlacePolygonTool

addVertexPolygon

Returns

Parameters

mouseState: MouseSelectionState

Returns void

complete

Returns

Returns boolean

Private completeLastLine

Returns

Returns boolean

deactivate

Returns void

deleteVertexPolygon

Returns

Parameters

mouseState: MouseSelectionState

Returns void

dispose

Returns void

Private disposeAnnotation

Returns void

disposed

Returns void

getInitialAnnotation

Returns

Parameters

mouseState: MouseSelectionState

annotationLayer: AnnotationLayerState

Returns Annotation

getUpdatedAnnotation

Returns

Parameters

oldAnnotation: Annotation

mouseState: MouseSelectionState

annotationLayer: AnnotationLayerState

Returns Annotation

Protected refCountReachedZero

Returns void

`Private` completeLastLine

`Private` disposeAnnotation

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Optional` parentRef: AnnotationReference