Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.37 KB

README.md

File metadata and controls

50 lines (33 loc) · 2.37 KB

cesium-sensor-volumes

Build Status  npm version Dependency Status License

A Cesium plugin for visualizing sensor volumes. Based on cesium-sensors and evolved to support more recent Cesium versions.

Install

$ npm install --save cesium-sensor-volumes

Usage

Prebuilt minified and unminified versions of the plugin are in the dist directory. Include the cesium-sensor-volumes.js file using a script tag after the Cesium.js script tag.

The plugin automatically adds support for the CZML properties agi_conicSensor, agi_customPatternSensor, and agi_rectangularSensor. The corresponding Entity properties are conicSensor, customPatternSensor, and rectangularSensor.

In order to load data directly into Entity objects that you create directly, you must call entity.addProperty to create each of the sensor properties you wish to use. The CZML processing does this automatically.

<script src="path/to/Cesium.js"></script>
<script src="path/to/cesium-sensor-volumes.js"></script>
<script>
// To create an entity directly
var entityCollection = new Cesium.EntityCollection();

var entity = entityCollection.getOrCreateEntity('test');
entity.addProperty('conicSensor');

// configure other entity properties, e.g. position and orientation...

entity.conicSensor = new CesiumSensorVolumes.ConicSensorGraphics();
entity.conicSensor.intersectionColor = new Cesium.ConstantProperty(new Cesium.Color(0.1, 0.2, 0.3, 0.4));
</script>

Examples

Simple examples are included in the examples folder. To run locally, run npm start and navigate to http://localhost:3000 and select the example application to run.

Build

To build, run npm install, then run npm run build.

License

Apache 2.0. Free for commercial and non-commercial use. See LICENSE.md.