Class Viewmap

Hierarchy

Viewmap

Index

Constructors

Properties

camera chains meshes options polygons renderSize viewEdges viewVertexMap

Methods

build buildAsync clear hiddenChains setupActions visibleChains

Constructors

constructor

new Viewmap(options?: ViewmapOptions): Viewmap
Parameters
- Optional options: ViewmapOptions
Returns Viewmap
- Defined in core/viewmap/Viewmap.ts:122

Properties

`Readonly` camera

camera: PerspectiveCamera = ...

`Readonly` chains

chains: Chain[] = ...

`Readonly` meshes

meshes: SVGMesh[] = ...

`Readonly` options

options: Required<ViewmapOptions> = ...

`Readonly` polygons

polygons: Polygon[] = ...

`Readonly` renderSize

renderSize: {
h: number;
w: number;
} = ...

Type declaration

h: number
w: number

`Readonly` viewEdges

viewEdges: ViewEdge[] = ...

`Readonly` viewVertexMap

viewVertexMap: Map<string, ViewVertex> = ...

Methods

build

build(meshes: SVGMesh[], camera: PerspectiveCamera, renderSize: SizeLike, info?: ViewmapBuildInfo, progressCallback?: ((progress: ProgressInfo) => void)): Promise<void>
Parameters
- meshes: SVGMesh[]
- camera: PerspectiveCamera
- renderSize: SizeLike
- info: ViewmapBuildInfo = ...
- Optional progressCallback: ((progress: ProgressInfo) => void)
  - - (progress: ProgressInfo): void
    - Parameters
      
      progress: ProgressInfo
      
      Returns void
Returns Promise<void>
- Defined in core/viewmap/Viewmap.ts:135

`Private` buildAsync

buildAsync(idx: number, actions: ViewmapAction[], info: ViewmapBuildInfo, progressCallback?: ((progress: ProgressInfo) => void)): Promise<void>
Parameters
- idx: number
- actions: ViewmapAction[]
- info: ViewmapBuildInfo
- Optional progressCallback: ((progress: ProgressInfo) => void)
  - - (progress: ProgressInfo): void
    - Parameters
      
      progress: ProgressInfo
      
      Returns void
Returns Promise<void>
- Defined in core/viewmap/Viewmap.ts:161

clear

clear(): void
Returns void
- Defined in core/viewmap/Viewmap.ts:126

hiddenChains

hiddenChains(): Chain[]
Returns Chain[]
- Defined in core/viewmap/Viewmap.ts:377

`Private` setupActions

setupActions(info?: ViewmapBuildInfo): ViewmapAction[]
Parameters
- info: ViewmapBuildInfo = ...
Returns ViewmapAction[]
- Defined in core/viewmap/Viewmap.ts:191

visibleChains

visibleChains(): Chain[]
Returns Chain[]
- Defined in core/viewmap/Viewmap.ts:373

Generated using TypeDoc