Describes a custom sensor. The center position and orientation are determined by the containing
Entity.
| Name | Type | Description |
|---|---|---|
options |
CustomSensorGraphics.ConstructorOptions | optional Object describing initialization options |
Members
classificationType : Property|undefined
Gets or sets the Property specifying the classification type.
-
Default Value:
ClassificationType.BOTH
readonly definitionChanged : Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
directions : Property|undefined
Gets or sets the array of
Direction objects specifying the direction vectors defining the sensor's shape.
distanceDisplayCondition : Property|undefined
Gets or sets the
DistanceDisplayCondition Property specifying at what distance from the camera that this sensor will be displayed.
domeSurfaceMaterial : MaterialProperty|undefined
Gets or sets the material used for dome surfaces.
ellipsoidHorizonSurfaceMaterial : MaterialProperty|undefined
Gets or sets the material used for ellipsoid horizon surfaces.
ellipsoidSurfaceMaterial : MaterialProperty|undefined
Gets or sets the material used for ellipsoid surfaces.
enableDetection : Property|undefined
Gets or sets the boolean Property specifying whether WASM-accelerated detection is enabled.
When true, the sensor will use WebAssembly for fast point-in-volume tests.
-
Default Value:
false
environmentConstraint : Property|undefined
Gets or sets the boolean Property specifying whether environment constraints are enabled.
When true, the sensor will interact with terrain and other environment features.
-
Default Value:
false
environmentIntersectionColor : Property|undefined
Gets or sets the Property specifying the color of environment intersection lines.
environmentIntersectionWidth : Property|undefined
Gets or sets the numeric Property specifying the width of environment intersection lines in pixels.
-
Default Value:
5.0
environmentOcclusionMaterial : MaterialProperty|undefined
Gets or sets the material used for environment occlusion.
fill : Property|undefined
Gets or sets the boolean Property specifying whether the sensor is filled with the provided material.
-
Default Value:
true
intersectionColor : Property|undefined
Gets or sets the Property specifying the color of intersections.
-
Default Value:
Color.WHITE
intersectionWidth : Property|undefined
Gets or sets the numeric Property specifying the width of intersection lines in pixels.
-
Default Value:
1.0
lateralSurfaceMaterial : MaterialProperty|undefined
Gets or sets the material used for lateral surfaces.
material : MaterialProperty|undefined
Gets or sets the material used to fill the sensor.
This is an alias for lateralSurfaceMaterial for backward compatibility.
-
Default Value:
Color.WHITE
portionToDisplay : Property|undefined
Gets or sets the Property specifying what part of the sensor to display.
-
Default Value:
SensorVolumePortionToDisplay.COMPLETE
radius : Property|undefined
Gets or sets the numeric Property specifying the radius of the sensor.
show : Property|undefined
Gets or sets the boolean Property specifying the visibility of the sensor.
-
Default Value:
true
showDomeSurfaces : Property|undefined
Gets or sets the boolean Property specifying whether dome surfaces are shown.
-
Default Value:
true
showEllipsoidHorizonSurfaces : Property|undefined
Gets or sets the boolean Property specifying whether ellipsoid horizon surfaces are shown.
-
Default Value:
true
showEllipsoidSurfaces : Property|undefined
Gets or sets the boolean Property specifying whether ellipsoid surfaces are shown.
-
Default Value:
true
showEnvironmentIntersection : Property|undefined
Gets or sets the boolean Property specifying whether environment intersection is shown.
-
Default Value:
false
showEnvironmentOcclusion : Property|undefined
Gets or sets the boolean Property specifying whether environment occlusion is shown.
-
Default Value:
false
showIntersection : Property|undefined
Gets or sets the boolean Property specifying whether intersections are shown.
-
Default Value:
true
showLateralSurfaces : Property|undefined
Gets or sets the boolean Property specifying whether lateral surfaces are shown.
-
Default Value:
true
showThroughEllipsoid : Property|undefined
Gets or sets the boolean Property specifying whether the sensor is shown through the ellipsoid.
-
Default Value:
false
showViewshed : Property|undefined
Gets or sets the boolean Property specifying whether viewshed analysis is shown.
When true, terrain visibility from the sensor's perspective is visualized.
-
Default Value:
false
viewshedOccludedColor : Property|undefined
Gets or sets the Property specifying the color for occluded areas in viewshed analysis.
-
Default Value:
Color.RED.withAlpha(0.5)
viewshedResolution : Property|undefined
Gets or sets the numeric Property specifying the resolution of the viewshed shadow map.
Higher values provide more detailed viewshed analysis but require more GPU memory.
-
Default Value:
2048
viewshedVisibleColor : Property|undefined
Gets or sets the Property specifying the color for visible areas in viewshed analysis.
-
Default Value:
Color.LIME.withAlpha(0.5)
Methods
Duplicates this instance.
| Name | Type | Description |
|---|---|---|
result |
CustomSensorGraphics | optional The object onto which to store the result. |
Returns:
The modified result parameter or a new instance if one was not provided.
Assigns each unassigned property on this object to the value
of the same property on the provided source object.
| Name | Type | Description |
|---|---|---|
source |
CustomSensorGraphics | The object to be merged into this object. |
Type Definitions
Initialization options for the CustomSensorGraphics constructor
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
show |
Property | boolean |
<optional> |
true | A boolean Property specifying the visibility of the sensor. |
fill |
Property | boolean |
<optional> |
true | A boolean Property specifying whether the sensor is filled with the provided material. |
material |
MaterialProperty | Color |
<optional> |
Color.WHITE | A Property specifying the material used to fill the sensor (alias for lateralSurfaceMaterial). |
distanceDisplayCondition |
Property | DistanceDisplayCondition |
<optional> |
A Property specifying at what distance from the camera that this sensor will be displayed. | |
directions |
Property | Array.<Direction> |
<optional> |
A Property specifying the direction vectors defining the sensor's shape. | |
radius |
Property | number |
<optional> |
A Property specifying the radius of the sensor. | |
portionToDisplay |
Property | SensorVolumePortionToDisplay |
<optional> |
SensorVolumePortionToDisplay.COMPLETE | A Property specifying what part of the sensor to display. |
showLateralSurfaces |
Property | boolean |
<optional> |
true | A boolean Property specifying whether lateral surfaces are shown. |
lateralSurfaceMaterial |
MaterialProperty | Color |
<optional> |
A Property specifying the material used for lateral surfaces. | |
showDomeSurfaces |
Property | boolean |
<optional> |
true | A boolean Property specifying whether dome surfaces are shown. |
domeSurfaceMaterial |
MaterialProperty | Color |
<optional> |
A Property specifying the material used for dome surfaces. | |
showEllipsoidSurfaces |
Property | boolean |
<optional> |
true | A boolean Property specifying whether ellipsoid surfaces are shown. |
ellipsoidSurfaceMaterial |
MaterialProperty | Color |
<optional> |
A Property specifying the material used for ellipsoid surfaces. | |
showEllipsoidHorizonSurfaces |
Property | boolean |
<optional> |
true | A boolean Property specifying whether ellipsoid horizon surfaces are shown. |
ellipsoidHorizonSurfaceMaterial |
MaterialProperty | Color |
<optional> |
A Property specifying the material used for ellipsoid horizon surfaces. | |
showIntersection |
Property | boolean |
<optional> |
true | A boolean Property specifying whether intersections are shown. |
intersectionColor |
Property | Color |
<optional> |
Color.WHITE | A Property specifying the color of intersections. |
intersectionWidth |
Property | number |
<optional> |
1.0 | A Property specifying the width of intersection lines in pixels. |
showThroughEllipsoid |
Property | boolean |
<optional> |
false | A boolean Property specifying whether the sensor is shown through the ellipsoid. |
environmentConstraint |
Property | boolean |
<optional> |
false | A boolean Property specifying whether environment constraints are enabled. |
showEnvironmentOcclusion |
Property | boolean |
<optional> |
false | A boolean Property specifying whether environment occlusion is shown. |
environmentOcclusionMaterial |
MaterialProperty | Color |
<optional> |
A Property specifying the material used for environment occlusion. | |
showEnvironmentIntersection |
Property | boolean |
<optional> |
false | A boolean Property specifying whether environment intersection is shown. |
environmentIntersectionColor |
Property | Color |
<optional> |
A Property specifying the color of environment intersection lines. | |
environmentIntersectionWidth |
Property | number |
<optional> |
5.0 | A Property specifying the width of environment intersection lines in pixels. |
showViewshed |
Property | boolean |
<optional> |
false | A boolean Property specifying whether viewshed analysis is shown. |
viewshedVisibleColor |
Property | Color |
<optional> |
A Property specifying the color for visible areas in viewshed analysis. | |
viewshedOccludedColor |
Property | Color |
<optional> |
A Property specifying the color for occluded areas in viewshed analysis. | |
viewshedResolution |
Property | number |
<optional> |
2048 | A Property specifying the resolution of the viewshed shadow map. |
classificationType |
Property | ClassificationType |
<optional> |
ClassificationType.BOTH | A Property specifying the classification type. |
enableDetection |
Property | boolean |
<optional> |
false | A boolean Property specifying whether WASM-accelerated detection is enabled. |