CustomSensorVolume

new CustomSensorVolume()

DOC_TBA

Members

id : Object

User-defined object returned when the sensors is picked.
Default Value: undefined
See:
  • Scene#pick

intersectionColor : Color

The color of the polyline where the sensor outline intersects the globe. The default is Color.WHITE.
Default Value: Color.WHITE
See:

intersectionWidth : Number

The approximate pixel width of the polyline where the sensor outline intersects the globe. The default is 5.0.
Default Value: 5.0
See:

lateralSurfaceMaterial : Material

The surface appearance of the sensor. This can be one of several built-in Material objects or a custom material, scripted with Fabric.

The default material is Material.ColorType.

Default Value: Material.fromType(Material.ColorType)
Example:
// 1. Change the color of the default material to yellow
sensor.lateralSurfaceMaterial.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);

// 2. Change material to horizontal stripes
sensor.lateralSurfaceMaterial = Cesium.Material.fromType(Material.StripeType);
See:

modelMatrix : Matrix4

The 4x4 transformation matrix that transforms this sensor from model to world coordinates. In it's model coordinates, the sensor's principal direction is along the positive z-axis. The clock angle, sometimes called azimuth, is the angle in the sensor's X-Y plane measured from the positive X-axis toward the positive Y-axis. The cone angle, sometimes called elevation, is the angle out of the X-Y plane along the positive Z-axis.


Model coordinate system for a custom sensor
Default Value: Matrix4.IDENTITY
Example:
// The sensor's vertex is located on the surface at -75.59777 degrees longitude and 40.03883 degrees latitude.
// The sensor's opens upward, along the surface normal.
var center = Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883);
sensor.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(center);

radius : Number

DOC_TBA
Default Value: Number.POSITIVE_INFINITY

show : Boolean

true if this sensor will be shown; otherwise, false
Default Value: true

showIntersection : Boolean

When true, a polyline is shown where the sensor outline intersections the globe.
Default Value: true
See:

showThroughEllipsoid : Boolean

Determines if a sensor intersecting the ellipsoid is drawn through the ellipsoid and potentially out to the other side, or if the part of the sensor intersecting the ellipsoid stops at the ellipsoid.

Default Value: false

Methods

destroy()

DOC_TBA

isDestroyed()

DOC_TBA

update()

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered:

Throws:
  • DeveloperError : this.radius must be greater than or equal to zero.
  • DeveloperError : this.lateralSurfaceMaterial must be defined.