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
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.
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
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. |
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. |