@tiledb-inc/viz-core / Exports / TileDBPointCloudOptions
Interface: TileDBPointCloudOptions
Hierarchy
TileDBVisualizationBaseOptions↳
TileDBPointCloudOptions
Table of contents
Properties
- arrayName
- bbox
- bufferSize
- cameraFOV
- cameraFarPlane
- cameraLocation
- cameraNearPlane
- cameraUp
- cameraZoomOut
- classes
- colorScheme
- data
- debug
- edlNeighbours
- edlRadius
- edlStrength
- groupName
- height
- inspector
- mode
- moveSpeed
- namespace
- pointBudget
- pointShift
- pointSize
- pointType
- rgbMax
- rootElement
- source
- streaming
- tiledbEnv
- timeOffset
- token
- topoOffset
- useSPS
- useShader
- wheelPrecision
- width
- workerPoolSize
- zScale
Properties
arrayName
• Optional arrayName: string
Name of the array registered in TileDB Cloud (if mode === “cloud”)
Defined in
point-cloud/utils/tiledb-pc.ts:65
bbox
• Optional bbox: Object
The bouding box with minimum and maximum values of the X, Y and Z dimensions
Type declaration
| Name | Type |
|---|---|
X |
number[] |
Y |
number[] |
Z |
number[] |
Defined in
point-cloud/utils/tiledb-pc.ts:57
bufferSize
• Optional bufferSize: number
TileDB query buffer size
Defined in
point-cloud/utils/tiledb-pc.ts:81
cameraFOV
• Optional cameraFOV: number
The camera field of view in radians
Defined in
point-cloud/utils/tiledb-pc.ts:117
cameraFarPlane
• Optional cameraFarPlane: number
The far clipping plane
Defined in
point-cloud/utils/tiledb-pc.ts:113
cameraLocation
• Optional cameraLocation: number
Camera location, choose a camera viewpoint towards the centre of the point cloud between 1 and 9
Defined in
point-cloud/utils/tiledb-pc.ts:97
cameraNearPlane
• Optional cameraNearPlane: number
The near clipping plane
Defined in
point-cloud/utils/tiledb-pc.ts:109
cameraUp
• Optional cameraUp: number
Move the free camera position up or down
Defined in
point-cloud/utils/tiledb-pc.ts:105
cameraZoomOut
• Optional cameraZoomOut: number[]
Camera zoom, move the camera towards or away from the centre of the point cloud in the [x,y,z] directions
Defined in
point-cloud/utils/tiledb-pc.ts:101
classes
• Optional classes: Object
Lookup table with the index and names of all classes [mode=‘classes’]
Type declaration
| Name | Type |
|---|---|
names |
string[] |
numbers |
number[] |
Defined in
point-cloud/utils/tiledb-pc.ts:37
colorScheme
• Optional colorScheme: string
Background color scheme, choose from ‘dark’ (default), ‘light’ or ‘blue’ with
Defined in
point-cloud/utils/tiledb-pc.ts:21
data
• Optional data: SparseResult
Data to render from a json object
Defined in
point-cloud/utils/tiledb-pc.ts:25
debug
• Optional debug: boolean
debug, draw octant boxes that are being rendered
Defined in
point-cloud/utils/tiledb-pc.ts:145
edlNeighbours
• Optional edlNeighbours: number
Number of neightbours used in EDL shader
Defined in
point-cloud/utils/tiledb-pc.ts:129
edlRadius
• Optional edlRadius: number
EDL shader radius
Defined in
point-cloud/utils/tiledb-pc.ts:125
edlStrength
• Optional edlStrength: number
EDL shader strength
Defined in
point-cloud/utils/tiledb-pc.ts:121
groupName
• Optional groupName: string
Name of the group registered in TileDB Cloud (if mode === “cloud”)
Defined in
point-cloud/utils/tiledb-pc.ts:69
height
• Optional height: string
Height of widget canvas in pixels
Inherited from
Defined in
inspector
• Optional inspector: boolean
Show BabylonJS inspector
Inherited from
Defined in
mode
• Optional mode: "time" | "classes" | "topo"
Optional modes time: add an interactive time slider classes: add an interactive classes slider topo: add a mapbox base layer
Defined in
point-cloud/utils/tiledb-pc.ts:17
moveSpeed
• Optional moveSpeed: number
When camera view in first-person determines how fast to move
Inherited from
Defined in
namespace
• Optional namespace: string
Namespace of the array/group registered in TileDB Cloud (if mode === “cloud”)
Defined in
point-cloud/utils/tiledb-pc.ts:61
pointBudget
• Optional pointBudget: number
Point budget
Defined in
point-cloud/utils/tiledb-pc.ts:133
pointShift
• Optional pointShift: number[]
Shift all points by the vector [x,y,z]
Defined in
point-cloud/utils/tiledb-pc.ts:49
pointSize
• Optional pointSize: number
Point size (default is 0.05)
Defined in
point-cloud/utils/tiledb-pc.ts:93
pointType
• Optional pointType: string
Select point rendering type, choose from ‘fixed_screen_size’ (default), ‘fixed_world_size’ or ‘adaptive_world_size’
Defined in
point-cloud/utils/tiledb-pc.ts:89
rgbMax
• Optional rgbMax: number
The maximum RGB value (default is 1.0)
Defined in
point-cloud/utils/tiledb-pc.ts:53
rootElement
• rootElement: HTMLElement
The HTML element to render the canvas
Inherited from
Defined in
source
• Optional source: "dict" | "cloud"
Source of the data
Defined in
point-cloud/utils/tiledb-pc.ts:45
streaming
• Optional streaming: boolean
Stream from TileDB Cloud
Defined in
point-cloud/utils/tiledb-pc.ts:85
tiledbEnv
• Optional tiledbEnv: string
Path to TileDB config file
Defined in
point-cloud/utils/tiledb-pc.ts:77
timeOffset
• Optional timeOffset: number
Time offset
Defined in
point-cloud/utils/tiledb-pc.ts:41
token
• Optional token: string
TileDB Cloud api token (if mode === “cloud”)
Defined in
point-cloud/utils/tiledb-pc.ts:73
topoOffset
• Optional topoOffset: number
Move the mapbox layer along the z-axis to better align with the point cloud [mode=‘topo’]
Defined in
point-cloud/utils/tiledb-pc.ts:33
useSPS
• Optional useSPS: boolean
Use a Solid Particle System for the point cloud
Defined in
point-cloud/utils/tiledb-pc.ts:141
useShader
• Optional useShader: boolean
Use shaders, on low end system might not want to use shaders
Defined in
point-cloud/utils/tiledb-pc.ts:137
wheelPrecision
• Optional wheelPrecision: number
Gets or Set the mouse wheel precision or how fast is the camera zooming.
Inherited from
Defined in
width
• Optional width: string
Width of widget canvas in pixels
Inherited from
Defined in
workerPoolSize
• Optional workerPoolSize: number
Web worker request pool size
Defined in
point-cloud/utils/tiledb-pc.ts:149
zScale
• Optional zScale: number
Scale the height (z-coordinate values) of all points (default is 1.0)