ThematicDisplay Class
The thematic display setup of a DisplayStyle3d. Thematic display allows a user to colorize a scene using a color gradient in a way that provides a visual cue about certain attributes of the rendered geometry. This scene colorization will be done based on certain geometric attributes like height, surface slope, position of surfaces relative to a sun position, or geometric position relative to a list of sensors. The documentation for ThematicDisplayMode describes how each mode colorizes the scene.
@note Applying thematic display to geometry prevents shadows from applying to the same geometry.
Methods
| Name | Description | |
|---|---|---|
| equals(other: ThematicDisplay): boolean | ||
| toJSON(): ThematicDisplayProps | ||
| fromJSON(json?: ThematicDisplayProps): ThematicDisplay Static |
Properties
| Name | Type | Description | |
|---|---|---|---|
| axis Readonly | Vector3d | For ThematicDisplayMode.Height, this is the axis along which to apply the thematic gradient in the scene. | |
| displayMode Readonly | ThematicDisplayMode | The thematic display mode. | |
| gradientSettings Readonly | ThematicGradientSettings | The settings used to create a color gradient applied to the geometry. | |
| range Readonly | Range1d | The range to use when applying the thematic gradient for height and slope mode. | |
| sensorSettings Readonly | ThematicDisplaySensorSettings | For InverseDistanceWeightedSensors, these are the settings that control the sensors. | |
| sunDirection Readonly | Vector3d | For HillShade, this is the direction of the sun in world space. |
Defined in
- core/common/src/ThematicDisplay.ts Line 457
Last Updated: 28 October, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.