RectangularPyramidSensorVolume

Members

id :Object

User-defined object returned when the sensors is picked.

Default Value: undefined

See:

• Scene#pick

Source: Scene/RectangularPyramidSensorVolume.js, line 170

intersectionColor :Color

The color of the polyline where the sensor outline intersects the globe. The default is Color.WHITE.

Default Value: Color.WHITE

See:

• RectangularPyramidSensorVolume#showIntersection

Source: Scene/RectangularPyramidSensorVolume.js, line 149

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:

• CustomSensorVolume#showIntersection

Source: Scene/RectangularPyramidSensorVolume.js, line 159

material :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.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);

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

See:

• Fabric

Source: Scene/RectangularPyramidSensorVolume.js, line 139

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. Half angles measured from the principal direction and in the direction of the x-axis and y-axis define the rectangle of the rectangular cross section.

Model coordinate system for a 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);

Source: Scene/RectangularPyramidSensorVolume.js, line 87

radius :Number

DOC_TBA

Default Value: Number.POSITIVE_INFINITY

Source: Scene/RectangularPyramidSensorVolume.js, line 95

show :Boolean

true if this sensor will be shown; otherwise, false

Default Value: true

Source: Scene/RectangularPyramidSensorVolume.js, line 43

showIntersection :Boolean

When true, a polyline is shown where the sensor outline intersections the globe.

Default Value: true

See:

• RectangularPyramidSensorVolume#intersectionColor

Source: Scene/RectangularPyramidSensorVolume.js, line 54

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

Source: Scene/RectangularPyramidSensorVolume.js, line 65

xHalfAngle :Number

DOC_TBA

Default Value: CesiumMath.PI_OVER_TWO

See:

• RectangularPyramidSensorVolume#yHalfAngle

Source: Scene/RectangularPyramidSensorVolume.js, line 106

yHalfAngle :Number

DOC_TBA

Default Value: CesiumMath.PI_OVER_TWO

See:

• RectangularPyramidSensorVolume#xHalfAngle

Source: Scene/RectangularPyramidSensorVolume.js, line 117

Methods

destroy()

DOC_TBA

Source: Scene/RectangularPyramidSensorVolume.js, line 246

isDestroyed()

DOC_TBA

Source: Scene/RectangularPyramidSensorVolume.js, line 239

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.xHalfAngle and this.yHalfAngle must each be less than 90 degrees.
• DeveloperError : this.radius must be greater than or equal to zero.

Source: Scene/RectangularPyramidSensorVolume.js, line 188