Class SingleMeshSource

Hierarchy

__type<SingleMeshSourceParametersWithInfo, {
prototype: __type<any, any>;
new (...args: any[]): __type<any, typeof ChunkSource>;
} & typeof ChunkSource, this> & __type<any, typeof ChunkSource, this> & ChunkSource<this>
- SingleMeshSource

Constructors

constructor

new SingleMeshSource(rpc: RPC, options: any): SingleMeshSource
Parameters
- rpc: RPC
- options: any
Returns SingleMeshSource
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).constructor
- Defined in src/neuroglancer/chunk_manager/backend.ts:380

Properties

RPC_TYPE_ID

RPC_TYPE_ID: string

Should be set to a constant specifying the SharedObject type identifier on the prototype of final derived owner classes. It is not used on counterpart (non-owner) classes.

chunkManager

chunkManager: ChunkManager

chunks

chunks: Map<string, Chunk> = ...

credentialsProvider

credentialsProvider: undefined | CredentialsProvider<any>

disposedStacks

disposedStacks: any

freeChunks

freeChunks: Chunk[] = ...

isOwner

isOwner: undefined | boolean

parameters

parameters: SingleMeshSourceParametersWithInfo

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

sourceQueueLevel

sourceQueueLevel: number = 0

sourceQueueLevel must be greater than the sourceQueueLevel of any ChunkSource whose download method depends on chunks from this source. A normal ChunkSource with no other dependencies should have a level of 0.

statistics

statistics: Float64Array = ...

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

Methods

addChunk

addChunk(chunk: Chunk): void
Adds the specified chunk to the chunk cache.

If the chunk cache was previously empty, also call this.addRef() to increment the reference count.
Parameters
- chunk: Chunk
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).addChunk
- Defined in src/neuroglancer/chunk_manager/backend.ts:288

addCounterpartRef

addCounterpartRef(): {
gen: number;
id: null | number;
}
Precondition: this.isOwner === true.

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): SingleMeshSource
Returns SingleMeshSource
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).addRef
- Defined in src/neuroglancer/util/disposable.ts:48

chunkStateChanged

chunkStateChanged(chunk: Chunk, oldState: ChunkState): void
Parameters
- chunk: Chunk
- oldState: ChunkState
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).chunkStateChanged
- Defined in src/neuroglancer/chunk_manager/backend.ts:337

counterpartRefCountReachedZero

counterpartRefCountReachedZero(generation: number): void
Precondition: this.isOwner === true.

This should be called when the counterpart's refCount is decremented and reaches zero.
Parameters
- generation: number
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

dispose

dispose(): void
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).disposed
- Defined in src/neuroglancer/util/disposable.ts:75

download

download(chunk: SingleMeshChunk, cancellationToken: CancellationToken): Promise<void>
Parameters
- chunk: SingleMeshChunk
- cancellationToken: CancellationToken
Returns Promise<void>
Overrides (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).download
- Defined in src/neuroglancer/single_mesh/backend.ts:147

getChunk

getChunk(): SingleMeshChunk
Returns SingleMeshChunk
- Defined in src/neuroglancer/single_mesh/backend.ts:136

getNewChunk_

getNewChunk_<T>(chunkType: ChunkConstructor<T>): T
Type Parameters
- T extends Chunk<T>
Parameters
- chunkType: ChunkConstructor<T>
Returns T
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).getNewChunk_
- Defined in src/neuroglancer/chunk_manager/backend.ts:268

initializeCounterpart

initializeCounterpart(rpc: RPC, options?: any): void
Parameters
- rpc: RPC
- options: any = {}
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).initializeCounterpart
- Defined in src/neuroglancer/worker_rpc.ts:182

initializeSharedObject

initializeSharedObject(rpc: RPC, rpcId?: number): void
Parameters
- rpc: RPC
- rpcId: number = ...
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

`Protected` ownerDispose

ownerDispose(): void
Precondition: this.isOwner === true.

Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).refCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:203

registerCancellable

registerCancellable<T>(cancellable: T): T
Type Parameters
- T extends {
  cancel: (() => void);
  }
Parameters
- cancellable: T
Returns T
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerChunkListener

registerChunkListener(key: string, listener: ChunkStateListener): boolean
Parameters
- key: string
- listener: ChunkStateListener
Returns boolean
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).registerChunkListener
- Defined in src/neuroglancer/chunk_manager/backend.ts:312

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).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 (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

removeChunk

removeChunk(chunk: Chunk): void
Remove the specified chunk from the chunk cache.

If the chunk cache becomes empty, also call this.dispose() to decrement the reference count.
Parameters
- chunk: Chunk
Returns void
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).removeChunk
- Defined in src/neuroglancer/chunk_manager/backend.ts:302

unregisterChunkListener

unregisterChunkListener(key: string, listener: ChunkStateListener): boolean
Parameters
- key: string
- listener: ChunkStateListener
Returns boolean
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).unregisterChunkListener
- Defined in src/neuroglancer/chunk_manager/backend.ts:321

unregisterDisposer

unregisterDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (WithParameters(WithSharedCredentialsProviderCounterpart<SpecialProtocolCredentials>()(ChunkSource), SingleMeshSourceParametersWithInfo)).unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

Class SingleMeshSource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPC

options: any

Returns SingleMeshSource

Properties

RPC_TYPE_ID

chunkManager

chunks

credentialsProvider

disposedStacks

freeChunks

isOwner

parameters

refCount

referencedGeneration

rpc

rpcId

sourceQueueLevel

statistics

unreferencedGeneration

wasDisposed

Methods

addChunk

Parameters

chunk: Chunk

Returns void

addCounterpartRef

Returns { gen: number; id: null | number; }

gen: number

id: null | number

addRef

Returns SingleMeshSource

chunkStateChanged

Parameters

chunk: Chunk

oldState: ChunkState

Returns void

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

dispose

Returns void

disposed

Returns void

download

Parameters

chunk: SingleMeshChunk

cancellationToken: CancellationToken

Returns Promise<void>

getChunk

Returns SingleMeshChunk

getNewChunk_

Type Parameters

T extends Chunk<T>

Parameters

chunkType: ChunkConstructor<T>

Returns T

initializeCounterpart

Parameters

rpc: RPC

options: any = {}

Returns void

initializeSharedObject

Parameters

rpc: RPC

rpcId: number = ...

Returns void

Protected ownerDispose

Returns void

Protected refCountReachedZero

Returns void

Returns {
gen: number;
id: null | number;
}

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions