Members
Coverage-quality heat map from range and boresight alignment.
Nothing is drawn. The resolution target whenever a selection cannot be
honored, and directly assignable to hide an overlay without disturbing
the configured selection.
Terrain-solved RF link-margin raster, projected from the solver's own
`linkMarginDb` grid. Reads no depth buffer, which is why it stays correct
at cone half-angles where the shadow map is useless.
Analytic per-fragment RF path loss with an occlusion penalty.
Terrain-solved positive-link footprint, projected from a precomputed mask.
Binary visible/occluded shadow-map viewshed — the direct viewshed shader.
Methods
The registered mode that drives a given
ViewshedVisualizationMode.
Lets legacy numeric assignments (including the ones made by footprint
helpers) round-trip into the named selection.
| Name | Type | Description |
|---|---|---|
visualizationMode |
number | The numeric mode. |
Returns:
The mode name, or undefined when unmapped.
static Cesium.SensorShaderMode.get(name) → SensorShaderMode.Descriptor
Look up a registered mode.
| Name | Type | Description |
|---|---|---|
name |
string | The mode name. |
Returns:
The descriptor.
Throws:
-
DeveloperError : name is not a registered shader mode.
Whether a mode name is registered.
| Name | Type | Description |
|---|---|---|
name |
string | The mode name. |
Returns:
True when registered.
Every registered mode name, in registration order.
Returns:
The names.
static Cesium.SensorShaderMode.register(descriptor) → SensorShaderMode.Descriptor
Add a shader mode to the registry, or replace one of the same name.
| Name | Type | Description |
|---|---|---|
descriptor |
SensorShaderMode.Descriptor | The mode. |
Returns:
The frozen, stored descriptor.
Example:
SensorShaderMode.register({
name: "rf-multipath",
visualizationMode: ViewshedVisualizationMode.RF_LINK_MARGIN,
requires: "viewshedRfLinkMarginFootprint",
readsShadowMap: false,
description: "Building-obstruction multipath raster",
});
Resolve the shader that will actually render.
This is the whole policy, kept pure so it can be reasoned about (and tested) without a scene. Two things demote a selection, and neither of them substitutes a different shader:
- the mode is in
disabled— an explicit refusal, e.g. an RF sensor that must never paint a plain viewshed; - the mode declares
requiresand that data is absent — the solve has not landed yet, or was cleared.
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
Options.
|
Returns:
The mode that renders, possibly
SensorShaderMode.NONE.
Type Definitions
A shader-mode descriptor.
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name |
string | Stable identifier, also the value assigned to
Sensor#shaderMode. |
||
visualizationMode |
number |
<optional> |
The ViewshedVisualizationMode
this mode drives. Omitted for SensorShaderMode.NONE. |
|
requires |
string |
<optional> |
Name of the Sensor property holding the
projected data this shader cannot render without. When that property
is undefined the mode resolves to SensorShaderMode.NONE rather
than falling back to another shader. |
|
readsShadowMap |
boolean |
<optional> |
true | Whether the shader consumes the viewshed depth comparison. Projected-raster modes do not, which is why they stay correct at cone half-angles where the shadow map is useless. |
description |
string | Human-readable summary, surfaced in errors. |