Last updated

API / geotoolkit3d / scene / pointset / PointSet / PointSet

Namespace: PointSet

pointset.PointSet.PointSet

Table of contents

Type Aliases

Contents

Type Aliases

MemoryCapabilitiesInfo

Ƭ MemoryCapabilitiesInfo: Object

Type declaration

NameTypeDescription
limitationLimitationDescribe the current bottleneck for the provided estimation.
Please note that if the VRAM argument is not provided, it is not possible to tell if the GPU memory is the current limitation.
maxpointsnumberThe maximum number of points that can be loaded safely, with the given memory information.
Please keep in mind this is only an estimation, even if the VRAM option is provided, browsers and OSes handle RAM and VRAM memory very differently.

MemoryEstimationOptions

Ƭ MemoryEstimationOptions: Object

Type declaration

NameTypeDescription
ramnumberThe amount of estimated available RAM in bytes, that the PointSet visual can allocate.
On average, PointSet will use 48 bytes of RAM per point.
Additional features such as transparency can create additional memory spikes.
vram?number(Optional) The amount of estimated available VRAM (Video Memory) in bytes, that the PointSet visual can allocate.
PointSet will use 40 bytes of VRAM per cell.

Options

Ƭ Options: Options & { colorprovider?: ColorProvider | string | Color ; data?: { sizemax?: number ; sizemin?: number ; sizes?: Float32Array | number[] | number ; values?: Float32Array | number[] | number ; visible?: boolean[] ; x?: Float32Array | number[] ; y?: Float32Array | number[] ; z?: Float32Array | number[] } ; highlightmode?: HighlightMode ; inverseplot?: boolean ; opacity?: number ; precision?: number ; symbol?: SymbolFunction | ThreeTexture ; symbolmaxsize?: number ; symbolminsize?: number ; symbolsizeisindevice?: boolean }

The options


OptionsBaseOut

Ƭ OptionsBaseOut: Required<Options> & { colorprovider: string | ColorProvider | RgbaColor | Color ; opacity: number ; symbolmaxsize: number ; symbolminsize: number }


PerPointOptions

Ƭ PerPointOptions: Object

Per point options

Type declaration

NameTypeDescription
size?numberThe size of the point
value?numberThe value of the point (used for color)
visible?booleanThe visibility of the point

PerPointOptionsOut

Ƭ PerPointOptionsOut: Required<PerPointOptions> & { position: number[] }


SymbolFunction

Ƭ SymbolFunction: (precision: number) => BufferGeometry

Type declaration

▸ (precision): BufferGeometry

Parameters
Name Type
precisionnumber
Returns

BufferGeometry