API / geotoolkit3d / scene / surface / contour / Contour / Contour
Type Aliases
Type Aliases
Ƭ CommonOptions: Object
| Name | Type | Description |
|---|---|---|
highlightmode? | HighlightMode | Define how the Surface will be highlighted when selected. Default is HighlightMode.HaloHighlight. |
isoline? | { count?: number ; major?: IsolineOptions ; majorminorstrategy?: MajorMinorStrategy | null ; minor?: IsolineOptions ; useglline?: boolean ; zmax?: number ; zmin?: number } | The options to create isolines |
isoline.count? | number | The total number of isolines to generate between zmin and zmax. Important note: This option is ignored unless option.isoline.majorminorstrategy is set to null. Default value is 10. |
isoline.major? | IsolineOptions | The options to configure major isolines |
isoline.majorminorstrategy? | MajorMinorStrategy | null | The stepping strategy to determine the number and positions of major / minor isolines between zmin/zmax. If this option is set to null, the option.isoline.count will be used instead. |
isoline.minor? | IsolineOptions | The options to configure minor isolines |
isoline.useglline? | boolean | Whether to use gl_line or not. If false (default) isolines will be rendered using 3D line segments, which supports anti-aliasing and customizable line width. If true, isolines will be rendered using GL lines, the OpenGL line primitive. GL lines are much faster to render but are of lower quality (no anti-aliasing), and line width behaviour is up to browsers, it might not be supported and all lines will default to a width of 1. |
isoline.zmax? | number | The max elevation level for isolines |
isoline.zmin? | number | The min elevation level for isolines |
label? | { density?: number ; labelformatter?: LabelFormatter ; labelmaxglobalvisibleangle?: number ; labelmaxverticalrotationangle?: number ; labelmaxverticalvisibleangle?: number ; major?: LabelOptions ; minor?: LabelOptions ; opacity?: number } | The options to create labels |
label.density? | number | the density of labels scattered on surface. Clamp to range [1, 5]. |
label.labelformatter? | LabelFormatter | The function that takes the elevation value and format it into the label text. |
label.labelmaxglobalvisibleangle? | number | the max angle (radian) between the label facing direction (normal) and the camera direction, above which the label stop being visible. |
label.labelmaxverticalrotationangle? | number | the max angle (radian) the label is allowed to rotate vertically both ways. |
label.labelmaxverticalvisibleangle? | number | the max angle (radian) between the label vertical direction and the projected vertical camera direction, above which the label stop being visible. |
label.major? | LabelOptions | The options to configure major label |
label.minor? | LabelOptions | The options to configure minor label |
label.opacity? | number | the opacity of label Deprecated since 4.2, please use label.major.style.color or label.minor.style.color to change opacity. |
opacity? | number | The opacity for the surface contour, default is 1. |
surface? | { enabled?: boolean } | The options related to the surface |
surface.enabled? | boolean | Whether to show surface or not. Does not affect isoline or label. |
Ƭ DataOptions: Object
| Name | Type | Description |
|---|---|---|
data | { surface: AbstractSurfaceData ; values?: Float32Array | number[] } | The data to use to create the contour |
data.surface | AbstractSurfaceData | The surface data object to generate contours from. |
data.values? | Float32Array | number[] | The attribute values used to colorize the contour surface |
Ƭ IsolineOptions: Object
| Name | Type | Description |
|---|---|---|
color? | string | Color | The color of major isolines. When returned from Contour.getOptions(), color is converted to THREE.Color for consistency. |
visible? | boolean | The visibility of major isolines |
width? | number | The width of major isolines |
Ƭ LabelFormatter: (value: number) => string
▸ (value): string
Label Formatter function, where value is the label elevation value.
| Name | Type |
|---|---|
value | number |
string
Ƭ LabelOptions: Object
| Name | Type | Description |
|---|---|---|
outline? | OutlineOptions | outline options |
style? | Type | the style of label |
visible? | boolean | The visibility of major label |
Ƭ Options: OptionsBase & DataOptions & Options
Ƭ OptionsBase: TextureOptionsIn & Merge<OptionsBase & Options, CommonOptions>
Ƭ OptionsBaseOut: TextureOptionsOut & Merge<OptionsBaseOut & Required<Options>, Required<CommonOptions>>