RectangularPyramidSensorVolume

new RectangularPyramidSensorVolume()

DOC_TBA
See:
Source: Scene/RectangularPyramidSensorVolume.js, line 34

Members

id :Object

User-defined object returned when the sensors is picked.
Default Value: undefined
See:
Source: Scene/RectangularPyramidSensorVolume.js, line 173

intersectionColor :Color

The color of the polyline where the sensor outline intersects the globe. The default is Color.WHITE.
Default Value: Color.WHITE
See:
Source: Scene/RectangularPyramidSensorVolume.js, line 152

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:
Source: Scene/RectangularPyramidSensorVolume.js, line 162

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:
Source: Scene/RectangularPyramidSensorVolume.js, line 142

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. This matrix is available to GLSL vertex and fragment shaders via czm_model and derived uniforms.


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);
See:
Source: Scene/RectangularPyramidSensorVolume.js, line 90

radius :Number

DOC_TBA
Default Value: Number.POSITIVE_INFINITY
Source: Scene/RectangularPyramidSensorVolume.js, line 98

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:
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:
Source: Scene/RectangularPyramidSensorVolume.js, line 109

yHalfAngle :Number

DOC_TBA
Default Value: CesiumMath.PI_OVER_TWO
See:
Source: Scene/RectangularPyramidSensorVolume.js, line 120

Methods

destroy()

DOC_TBA
Source: Scene/RectangularPyramidSensorVolume.js, line 248

isDestroyed()

DOC_TBA
Source: Scene/RectangularPyramidSensorVolume.js, line 240

update()

DOC_TBA
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