Describes a rectangular sensor. The center position and orientation are determined by the containing
Entity.
| Name | Type | Description |
|---|---|---|
options |
RectangularSensorGraphics.ConstructorOptions | optional Object describing initialization options |
Members
readonly definitionChanged : Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
distanceDisplayCondition : Property|undefined
Gets or sets the
DistanceDisplayCondition Property specifying at what distance from the camera that this sensor will be displayed.
fill : Property|undefined
Gets or sets the boolean Property specifying whether the sensor is filled with the provided material.
-
Default Value:
true
material : MaterialProperty|undefined
Gets or sets the material used to fill the sensor.
-
Default Value:
Color.WHITE
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
xHalfAngle : Property|undefined
Gets or sets the numeric Property specifying the half-angle of the sensor's field of view in the x-direction (degrees).
yHalfAngle : Property|undefined
Gets or sets the numeric Property specifying the half-angle of the sensor's field of view in the y-direction (degrees).
Methods
clone(result) → RectangularSensorGraphics
Duplicates this instance.
| Name | Type | Description |
|---|---|---|
result |
RectangularSensorGraphics | 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 |
RectangularSensorGraphics | The object to be merged into this object. |
Type Definitions
Initialization options for the RectangularSensorGraphics 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 | SensorMaterialProperty | Color |
<optional> |
Color.WHITE | A Property specifying the material used to fill the sensor. |
distanceDisplayCondition |
Property | DistanceDisplayCondition |
<optional> |
A Property specifying at what distance from the camera that this sensor will be displayed. | |
xHalfAngle |
Property | number |
<optional> |
A Property specifying the half-angle of the sensor's field of view in the x-direction (degrees). | |
yHalfAngle |
Property | number |
<optional> |
A Property specifying the half-angle of the sensor's field of view in the y-direction (degrees). | |
radius |
Property | number |
<optional> |
A Property specifying the radius of the sensor. |