Rename OmnidirectionalSensor to OmnidirectionalSightline (#155)

- This is a continuation of 157eceb
- Update the comments and classes of Examples and Tutorials

Author: zglueck

worldwind-examples/src/main/AndroidManifest.xml

@@ -49,17 +49,17 @@
             android:theme="@style/AppTheme.NoActionBar">
         </activity>
         <activity
-            android:name=".MultiGlobeActivity"
+            android:name=".OmnidirectionalSightlineActivity"
             android:configChanges="orientation|screenSize"
-            android:label="@string/title_multi_globe"
+            android:label="@string/title_movable_omni_sightline"
             android:launchMode="singleInstance"
             android:noHistory="true"
             android:theme="@style/AppTheme.NoActionBar">
         </activity>
         <activity
-            android:name=".OmnidirectionalSensorActivity"
+            android:name=".MultiGlobeActivity"
             android:configChanges="orientation|screenSize"
-            android:label="@string/title_omni_sensor"
+            android:label="@string/title_multi_globe"
             android:launchMode="singleInstance"
             android:noHistory="true"
             android:theme="@style/AppTheme.NoActionBar">

worldwind-examples/src/main/java/gov/nasa/worldwindx/AbstractMainActivity.java

@@ -318,8 +318,8 @@ public boolean onNavigationItemSelected(MenuItem item) {
             case R.id.nav_multi_globe_activity:
                 startActivity(new Intent(getApplicationContext(), MultiGlobeActivity.class));
                 break;
-            case R.id.nav_omnidirectional_sensor_activity:
-                startActivity(new Intent(getApplicationContext(), OmnidirectionalSensorActivity.class));
+            case R.id.nav_omnidirectional_sightline_activity:
+                startActivity(new Intent(getApplicationContext(), OmnidirectionalSightlineActivity.class));
                 break;
             case R.id.nav_paths_example:
                 startActivity(new Intent(getApplicationContext(), PathsExampleActivity.class));

worldwind-examples/src/main/java/gov/nasa/worldwindx/OmnidirectionalSensorActivity.java renamed to worldwind-examples/src/main/java/gov/nasa/worldwindx/OmnidirectionalSightlineActivity.java

@@ -27,19 +27,20 @@
 import gov.nasa.worldwind.shape.ShapeAttributes;
 
 /**
- * This Activity demonstrates the OmnidirectionalSightline object and allows the sensor to be dragged.
+ * This Activity demonstrates the OmnidirectionalSightline object and allows the position of the sightline to be moved
+ * via a drag action.
  */
-public class OmnidirectionalSensorActivity extends BasicGlobeActivity {
+public class OmnidirectionalSightlineActivity extends BasicGlobeActivity {
 
     /**
-     * The sensor which evaluates line of sight
+     * The OmnidirectionalSightline displaying visibility on the terrain
      */
-    protected OmnidirectionalSightline sensor;
+    protected OmnidirectionalSightline sightline;
 
     /**
-     * A Placemark representing the position of the sensor
+     * A Placemark representing the position of the sightline
      */
-    protected Placemark sensorPlacemark;
+    protected Placemark sightlinePlacemark;
 
     /**
      * A custom WorldWindowController object that handles the select, drag and navigation gestures.
@@ -49,9 +50,9 @@ public class OmnidirectionalSensorActivity extends BasicGlobeActivity {
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-        setAboutBoxTitle("About the " + this.getResources().getText(R.string.title_omni_sensor));
-        setAboutBoxText("Demonstrates a draggable WorldWind Omnidirectional sensor. Drag the placemark icon around the " +
-            "screen to move the omnidirectional sensor.");
+        setAboutBoxTitle("About the " + this.getResources().getText(R.string.title_movable_omni_sightline));
+        setAboutBoxText("Demonstrates a draggable WorldWind Omnidirectional sightline. Drag the placemark icon around the " +
+            "screen to move the sightline position.");
 
         // Initialize attributes for the OmnidirectionalSightline
         ShapeAttributes viewableRegions = new ShapeAttributes();
@@ -62,27 +63,27 @@ protected void onCreate(Bundle savedInstanceState) {
 
         // Initialize the OmnidirectionalSightline and Corresponding Placemark
         Position pos = new Position(46.202, -122.190, 500.0);
-        this.sensor = new OmnidirectionalSightline(pos, 10000.0);
-        this.sensor.setAttributes(viewableRegions);
-        this.sensor.setOccludeAttributes(blockedRegions);
-        this.sensor.setAltitudeMode(WorldWind.RELATIVE_TO_GROUND);
-        this.sensorPlacemark = new Placemark(pos);
-        this.sensorPlacemark.setAltitudeMode(WorldWind.RELATIVE_TO_GROUND);
-        this.sensorPlacemark.getAttributes().setImageSource(ImageSource.fromResource(R.drawable.aircraft_fixwing));
-        this.sensorPlacemark.getAttributes().setImageScale(2);
-        this.sensorPlacemark.getAttributes().setDrawLeader(true);
-
-        // Establish a layer to hold the sensor and placemark
-        RenderableLayer sensorLayer = new RenderableLayer();
-        sensorLayer.addRenderable(this.sensor);
-        sensorLayer.addRenderable(this.sensorPlacemark);
-        this.wwd.getLayers().addLayer(sensorLayer);
+        this.sightline = new OmnidirectionalSightline(pos, 10000.0);
+        this.sightline.setAttributes(viewableRegions);
+        this.sightline.setOccludeAttributes(blockedRegions);
+        this.sightline.setAltitudeMode(WorldWind.RELATIVE_TO_GROUND);
+        this.sightlinePlacemark = new Placemark(pos);
+        this.sightlinePlacemark.setAltitudeMode(WorldWind.RELATIVE_TO_GROUND);
+        this.sightlinePlacemark.getAttributes().setImageSource(ImageSource.fromResource(R.drawable.aircraft_fixwing));
+        this.sightlinePlacemark.getAttributes().setImageScale(2);
+        this.sightlinePlacemark.getAttributes().setDrawLeader(true);
+
+        // Establish a layer to hold the sightline and placemark
+        RenderableLayer sightlineLayer = new RenderableLayer();
+        sightlineLayer.addRenderable(this.sightline);
+        sightlineLayer.addRenderable(this.sightlinePlacemark);
+        this.wwd.getLayers().addLayer(sightlineLayer);
 
         // Override the WorldWindow's built-in navigation behavior with conditional dragging support.
         this.controller = new SimpleSelectDragNavigateController();
         this.wwd.setWorldWindowController(this.controller);
 
-        // And finally, for this demo, position the viewer to look at the sensor position
+        // And finally, for this demo, position the viewer to look at the sightline position
         LookAt lookAt = new LookAt().set(pos.latitude, pos.longitude, pos.altitude, WorldWind.ABSOLUTE, 2e4 /*range*/, 0 /*heading*/, 45 /*tilt*/, 0 /*roll*/);
         this.getWorldWindow().getNavigator().setAsLookAt(this.getWorldWindow().getGlobe(), lookAt);
     }
@@ -166,15 +167,15 @@ public boolean drag(MotionEvent downEvent, MotionEvent moveEvent, float distance
                 // First we compute the screen coordinates of the position's "ground" point.  We'll apply the
                 // screen X and Y drag distances to this point, from which we'll compute a new position,
                 // wherein we restore the original position's altitude.
-                Position position = sensorPlacemark.getReferencePosition();
+                Position position = sightlinePlacemark.getReferencePosition();
                 double altitude = position.altitude;
                 if (getWorldWindow().geographicToScreenPoint(position.latitude, position.longitude, 0, this.dragRefPt)) {
                     // Update the placemark's ground position
                     if (screenPointToGroundPosition(this.dragRefPt.x - distanceX, this.dragRefPt.y - distanceY, position)) {
                         // Restore the placemark's original altitude
                         position.altitude = altitude;
-                        // Move the sensor
-                        sensor.setPosition(position);
+                        // Move the sightline
+                        sightline.setPosition(position);
                         // Reflect the change in position on the globe.
                         getWorldWindow().requestRedraw();
                         return true;

worldwind-examples/src/main/res/menu/activity_drawer.xml

@@ -32,9 +32,9 @@
             android:icon="@android:drawable/ic_menu_myplaces"
             android:title="@string/title_placemarks_milstd2525_demo"/>
         <item
-            android:id="@+id/nav_omnidirectional_sensor_activity"
+            android:id="@+id/nav_omnidirectional_sightline_activity"
             android:icon="@android:drawable/ic_menu_myplaces"
-            android:title="@string/title_omni_sensor"/>
+            android:title="@string/title_movable_omni_sightline"/>
         <item
             android:id="@+id/nav_paths_example"
             android:icon="@android:drawable/ic_menu_directions"

worldwind-examples/src/main/res/values/strings.xml

@@ -13,7 +13,7 @@
     <string name="title_day_night_cycle">Day and Night Cycle</string>
     <string name="title_general_globe">General Purpose Globe</string>
     <string name="title_multi_globe">Multi-Globe Demonstration</string>
-    <string name="title_omni_sensor">Omnidirectional Sensor</string>
+    <string name="title_movable_omni_sightline">Movable OmnidirectionalSightline</string>
     <string name="title_paths_example">Paths Example</string>
     <string name="title_paths_and_polygons">Paths, Polygons &amp; Labels Demonstration</string>
     <string name="title_placemarks_demo">Placemarks Demonstration</string>

worldwind-tutorials/src/main/assets/omnidirectional_sensor_tutorial.html renamed to worldwind-tutorials/src/main/assets/omnidirectional_sightline_tutorial.html

@@ -14,23 +14,26 @@
     <link rel="stylesheet" type="text/css" href="file:///android_asset/override.css"/>
 </head>
 <body>
-<h1>OmnidirectionalSensor Tutorial</h1>
+<h1>OmnidirectionalSightline Tutorial</h1>
 <p>
-    Demonstrates how to create a OmnidirectionalSensor and add it to the globe
+    Demonstrates how to create an OmnidirectionalSightline and add it to the globe. An OmnidirectionalSightline provides
+    a visual area representation of line of sight from a provided position. Areas occluded by terrain will appear in a
+    different color than areas visible to the provided point.
 </p>
 <p>
-    This tutorial demonstrates the creation of an OmnidirectionSensor to the globe. In addition to the sensor, a
-    placemark indicating the position of the sensor is added to provide visual context.
+    This tutorial demonstrates the creation of an OmnidirectionSightline. In addition to the OmnidirectionalSightline, a
+    Placemark indicating the position of the sightline origin is added to provide visual context.
 </p>
 <p>
-    The regions colored green indicate they are visible from the position provided to the OmnidirectionSensor. Regions
-    colored gray are occluded by terrain from the provided position. This tutorial uses a sensor range of 10,000 meters.
+    The regions colored green indicate they are visible from the position provided to the OmnidirectionSightline.
+    Regions colored gray are occluded by terrain from the provided position. This tutorial uses a sightline range of
+    10,000 meters.
 </p>
 <h2>Example</h2>
-<h3>OmnidirectionalSensorFragment.java</h3>
+<h3>OmnidirectionalSightlineFragment.java</h3>
 <p>
-    The OmnidirectionSensorFragment class extends the BasicGlobeFragment and overrides the createWorldWindow method. An
-    OmnidirectionalSensor object with specified position and range is then created and added to the globe.
+    The OmnidirectionSightlineFragment class extends the BasicGlobeFragment and overrides the createWorldWindow method.
+    An OmnidirectionalSightline object with specified position and range is then created and added to the globe.
 </p>
 <div style="border-top: 1px solid black; border-bottom: 1px solid black;">
     <textarea id="java-code">
@@ -41,9 +44,9 @@ <h3>OmnidirectionalSensorFragment.java</h3>
         // Let the super class (BasicGlobeFragment) do the creation
         WorldWindow wwd = super.createWorldWindow();
 
-        // Specify the sensors position
+        // Specify the sightline origin position
         Position position = new Position(46.230, -122.190, 2500.0);
-        // Specify the range of the sensor (meters)
+        // Specify the range of the sightline (meters)
         double range = 10000.0;
         // Create attributes for the visible terrain
         ShapeAttributes visibleAttributes = new ShapeAttributes();
@@ -52,21 +55,21 @@ <h3>OmnidirectionalSensorFragment.java</h3>
         ShapeAttributes occludedAttributes = new ShapeAttributes();
         occludedAttributes.setInteriorColor(new Color(0.1f, 0.1f, 0.1f, 0.5f));
 
-        // Create the sensor
-        OmnidirectionalSensor sensor = new OmnidirectionalSensor(position, range);
+        // Create the sightline
+        OmnidirectionalSightline sightline = new OmnidirectionalSightline(position, range);
         // Add the attributes
-        sensor.setAttributes(visibleAttributes);
-        sensor.setOccludeAttributes(occludedAttributes);
+        sightline.setAttributes(visibleAttributes);
+        sightline.setOccludeAttributes(occludedAttributes);
 
-        // Create a layer for the sensor
-        RenderableLayer sensorLayer = new RenderableLayer();
-        sensorLayer.addRenderable(sensor);
-        wwd.getLayers().addLayer(sensorLayer);
+        // Create a layer for the sightline
+        RenderableLayer sightlineLayer = new RenderableLayer();
+        sightlineLayer.addRenderable(sightline);
+        wwd.getLayers().addLayer(sightlineLayer);
 
-        // Create a Placemark to visualize the position of the sensor
-        this.createPlacemark(position, sensorLayer);
+        // Create a Placemark to help visualize the position of the sightline
+        this.createPlacemark(position, sightlineLayer);
 
-        // Position the camera to look at the sensor coverage
+        // Position the camera to look at the line of site terrain coverage
         this.positionView(wwd);
 
         return wwd;
@@ -82,10 +85,6 @@ <h3>OmnidirectionalSensorFragment.java</h3>
         mode: "text/x-java",
         readOnly: true
       });
-
-
-
-
 </script>
 </body>
 </html>

worldwind-tutorials/src/main/java/gov/nasa/worldwindx/MainActivity.java

@@ -281,8 +281,8 @@ public boolean onNavigationItemSelected(MenuItem item) {
             case R.id.nav_navigator_event_activity:
                 loadTutorial(NavigatorEventFragment.class, "file:///android_asset/navigator_events_tutorial.html",  R.string.title_navigator_event);
                 break;
-            case R.id.nav_omnidirectional_sensor_activity:
-                loadTutorial(OmnidirectionalSensorFragment.class, "file:///android_asset/omnidirectional_sensor_tutorial.html", R.string.title_omni_sensor);
+            case R.id.nav_omnidirectional_sightline_activity:
+                loadTutorial(OmnidirectionalSightlineFragment.class, "file:///android_asset/omnidirectional_sightline_tutorial.html", R.string.title_omni_sightline);
                 break;
             case R.id.nav_paths_activity:
                 loadTutorial(PathsFragment.class, "file:///android_asset/paths_tutorial.html", R.string.title_paths);

worldwind-tutorials/src/main/java/gov/nasa/worldwindx/OmnidirectionalSensorFragment.java renamed to worldwind-tutorials/src/main/java/gov/nasa/worldwindx/OmnidirectionalSightlineFragment.java

@@ -16,7 +16,7 @@
 import gov.nasa.worldwind.shape.Placemark;
 import gov.nasa.worldwind.shape.ShapeAttributes;
 
-public class OmnidirectionalSensorFragment extends BasicGlobeFragment {
+public class OmnidirectionalSightlineFragment extends BasicGlobeFragment {
 
     /**
      * Creates a new WorldWindow (GLSurfaceView) object with an OmnidirectionalSightline
@@ -28,9 +28,9 @@ public WorldWindow createWorldWindow() {
         // Let the super class (BasicGlobeFragment) do the creation
         WorldWindow wwd = super.createWorldWindow();
 
-        // Specify the sensors position
+        // Specify the sightline position
         Position position = new Position(46.230, -122.190, 2500.0);
-        // Specify the range of the sensor (meters)
+        // Specify the range of the sightline (meters)
         double range = 10000.0;
         // Create attributes for the visible terrain
         ShapeAttributes visibleAttributes = new ShapeAttributes();
@@ -39,21 +39,21 @@ public WorldWindow createWorldWindow() {
         ShapeAttributes occludedAttributes = new ShapeAttributes();
         occludedAttributes.setInteriorColor(new Color(0.1f, 0.1f, 0.1f, 0.5f));
 
-        // Create the sensor
-        OmnidirectionalSightline sensor = new OmnidirectionalSightline(position, range);
+        // Create the sightline
+        OmnidirectionalSightline sightline = new OmnidirectionalSightline(position, range);
         // Add the attributes
-        sensor.setAttributes(visibleAttributes);
-        sensor.setOccludeAttributes(occludedAttributes);
+        sightline.setAttributes(visibleAttributes);
+        sightline.setOccludeAttributes(occludedAttributes);
 
-        // Create a layer for the sensor
-        RenderableLayer sensorLayer = new RenderableLayer();
-        sensorLayer.addRenderable(sensor);
-        wwd.getLayers().addLayer(sensorLayer);
+        // Create a layer for the sightline
+        RenderableLayer sightlineLayer = new RenderableLayer();
+        sightlineLayer.addRenderable(sightline);
+        wwd.getLayers().addLayer(sightlineLayer);
 
-        // Create a Placemark to visualize the position of the sensor
-        this.createPlacemark(position, sensorLayer);
+        // Create a Placemark to visualize the position of the sightline
+        this.createPlacemark(position, sightlineLayer);
 
-        // Position the camera to look at the sensor coverage
+        // Position the camera to look at the line of site terrain coverage
         this.positionView(wwd);
 
         return wwd;

worldwind-tutorials/src/main/res/menu/activity_drawer.xml

@@ -44,9 +44,9 @@
             android:icon="@android:drawable/ic_menu_compass"
             android:title="@string/title_navigator_event"/>
         <item
-            android:id="@+id/nav_omnidirectional_sensor_activity"
+            android:id="@+id/nav_omnidirectional_sightline_activity"
             android:icon="@android:drawable/ic_menu_compass"
-            android:title="@string/title_omni_sensor"/>
+            android:title="@string/title_omni_sightline"/>
         <item
             android:id="@+id/nav_placemarks_activity"
             android:icon="@android:drawable/ic_menu_myplaces"

worldwind-tutorials/src/main/res/values/strings.xml

@@ -19,7 +19,7 @@
     <string name="title_labels">Labels</string>
     <string name="title_look_at_view">Look At View</string>
     <string name="title_navigator_event">Navigator Events</string>
-    <string name="title_omni_sensor">Omnidirectional Sensor</string>
+    <string name="title_omni_sightline">Omnidirectional Sightline</string>
     <string name="title_paths">Paths</string>
     <string name="title_placemarks">Placemarks</string>
     <string name="title_placemarks_picking">Placemark Picking</string>