API / geotoolkit3d / scene / surface / Surface / Surface
Type Aliases
Type Aliases
Ƭ CanvasServer: Object
| Name | Type | Description |
|---|---|---|
formatterfunction | FormatterFunction | formatter function for loading tiles |
server | string | server for loading tiles |
Ƭ CommonOptions: Object
| Name | Type | Description |
|---|---|---|
extent | Box2 | visible model limits of elevation (WGS84 full limits by default) |
geometry | CanvasServer | object for loading geometry tiles |
highlightmode? | HighlightMode | Define how the Surface will be highlighted when selected. Default is HighlightMode.ContourHighlight for regular Surfaces, or HighlightMode.HaloHighlight for HeightMap surfaces. |
maplimits | Box2 | model limits of elevation (WGS84 full limits by default) |
material | CanvasServer | object for loading texture tiles |
maximumrequests | number | maximum requests at the same time (for network optimization) |
maxlod | number | the highest level of tile layer |
minlod | number | the lowest level of tile layer |
tileheight | number | tile height |
tilewidth | number | tile width |
Ƭ CommonOptionsBase: Options & TextureOptionsIn & Partial<CommonOptions> & { colorprovider?: ColorProvider | string | Color ; data?: { valuemode?: HeightMapElevationValueMode } }
Ƭ CommonOptionsBaseOut: Required<Options> & TextureOptionsOut & CommonOptions & { nullvalue: number ; zmax: number ; zmin: number }
Ƭ FormatterFunction: (z: number, y: number, x: number) => string
▸ (z, y, x): string
| Name | Type |
|---|---|
z | number |
y | number |
x | number |
string
Ƭ MemoryCapabilitiesInfo: Object
| Name | Type | Description |
|---|---|---|
limitation | Limitation | Describe 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. |
maxvertices | number | The maximum number of vertices that can be loaded safely, with the given memory information. For example, if the result is 1000,000 vertices, one can imagine loading a Surface of dimensions of 1000 * 1000 (or any combinations that leads to one million). 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: Object
| Name | Type | Description |
|---|---|---|
ram | number | The amount of estimated available RAM in bytes, that the Surface visual can allocate. On average, Surface will use 40 bytes of RAM per cell. Additional features such as intersections and transparency can create additional memory spikes. |
useintersection? | boolean | (Optional) Use an extra amount of RAM per cell if intersections are used. Default is false. |
vram? | number | (Optional) The amount of estimated available VRAM (Video Memory) in bytes, that the Surface visual can allocate. Surface will use 28 bytes of VRAM per cell. |
Ƭ Options: Options & Options & CommonOptionsBase
The options to use to create the surface
Ƭ OptionsBase: OptionsBase & CommonOptionsBase
Ƭ OptionsBaseOut: OptionsBaseOut & CommonOptionsBaseOut