ilog.views.maps.defense.terrain

Class IlvLineOfVisibility

java.lang.Object

ilog.views.IlvGraphic

ilog.views.graphic.IlvPolyPoints

ilog.views.graphic.IlvPolyline

ilog.views.maps.graphic.IlvMapPolyline

ilog.views.maps.defense.terrain.IlvLineOfVisibility

All Implemented Interfaces:

IlvPolyPointsInterface, IlvPersistentObject, IlvMapGraphic, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable

public class IlvLineOfVisibility
extends IlvMapPolyline

IlvLineOfVisibility represents a georeferenced polyline that is colored according the visibility information.

Since:

JViews 7.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IlvLineOfVisibility.ComputeListener ComputeListener represents a listener interface that can be attached to the line of view, and used to track its changes.
static class	IlvLineOfVisibility.Segment This class contains the distances from the beginning of a visible or invisible segment.

Field Summary

Fields inherited from class ilog.views.maps.graphic.IlvMapPolyline

style

Constructor Summary

Constructors

Constructor and Description
IlvLineOfVisibility(IlvInputStream stream) Reads an IlvLineOfVisibility instance from an IlvInputStream.
IlvLineOfVisibility(IlvLineOfVisibility source) Creates an IlvLineOfVisibility object by copying an existing one.
IlvLineOfVisibility(IlvManager manager, double pointOfViewHeight, double precision, IlvCoordinate pointOfView, IlvCoordinate targetPoint) Creates a new IlvLineOfVisibility object.
IlvLineOfVisibility(IlvManager manager, double pointOfViewHeight, double precision, IlvCoordinateSystem cs, IlvAltitudeProvider elevationProvider, IlvCoordinate pointOfView, IlvCoordinate targetPoint) Creates a new IlvLineOfVisibility object.
IlvLineOfVisibility(IlvManager manager, double pointOfViewHeight, double precision, IlvPoint p1, IlvPoint p2) Creates a new IlvLineOfVisibility object.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(IlvLineOfVisibility.ComputeListener c) Adds a listener to this line of view instance that will be called whenever visibility information has changed.
void	applyTransform(IlvTransformer t) This overridden method of the superclass is used to make sure colors are updated.
protected void	computeSegments(double[] measureDistances, boolean[] visibilities) Computes and sets the segment list from the curvilinear abscissa and visibility arrays.
protected void	computeVisibility() Computes the new visible and invisible segments arrays.
IlvGraphic	copy() Copies this object.
void	draw(Graphics dst, IlvTransformer t) Draws this IlvMapPolyline object with the specified graphics and transformer.
protected void	fireChange() Fires a change in the line of visibility that will execute all registered listeners.
protected double	getDistance(double lon1, double lat1, double lon2, double lat2) Returns the distance in meters between the specified latitude and longitude coordinates.
IlvAltitudeProvider	getElevationProvider() Returns the elevation provider.
protected IlvGeodeticComputation	getGeodeticComputation() Returns the geodetic computation used to compute distances on the surface of the earth
Color	getHiddenZoneColor() Returns the color of non-visible zones.
protected IlvLineOfVisibility.Segment[]	getInvisibleSegments() Possibly computes and return the array of invisible segments.
protected IlvCoordinateTransformation	getKernelToSystemTransformation() Returns the kernel to system transformation.
protected IlvCoordinate	getLatLon(int iPoint) Returns a point on the line in latitude and longitude coordinates..
double	getLength() Returns the distance between the viewpoint and the target in meters.
IlvLineOfVisibilityStyle	getLineOfVisibilityStyle() Returns the style of this line.
IlvManager	getManager() Returns the reference manager.
IlvCoordinate	getPointOfView() Returns the current viewpoint location.
double	getPointOfViewHeight() Returns the viewpoint height.
double	getPrecision() Returns the current precision.
IlvMapStyle	getStyle() Retrieves the IlvMapStyle attached to this graphic.
protected IlvCoordinateTransformation	getSystemToKernelTransformation() Returns the system to kernel transformation.
IlvCoordinate	getTargetPoint() Returns the current viewpoint location.
protected IlvLineOfVisibility.Segment[]	getVisibleSegments() Returns the array of visible segments.
Color	getVisibleZoneColor() Returns the color of the visible zones.
boolean	isUsingEarthCurvature() Tests if the computation should take into account the mean curvature of the earth.
boolean	isVisible(double distanceFromStart) Returns whether or not the point located at a certain distance is visible to the observer using the current line of visibility parameters.
void	move(double x, double y) This overridden method of the superclass also calls mustRecompute().
void	movePoint(int index, double x, double y, IlvTransformer t) This overridden method of the superclass also calls mustRecompute().
void	moveResize(IlvRect r) This overridden method of the superclass also calls mustRecompute().
protected void	mustRecompute() Indicates that the computed list of invisible and visible segments is no longer valid.
void	refresh() Forces the recomputation of the visible and invisible segments.
void	removeChangeListener(IlvLineOfVisibility.ComputeListener c) Removes a listener from the listener list.
protected void	setCoordinateSystem(IlvCoordinateSystem coordinateSystem) Sets the geodetic computation according to the ellipsoid defined in the coordinate system projection.
protected void	setElevationProvider(IlvAltitudeProvider provider) Sets the elevation provider that is used to retrieve altitudes from latitude and longitude coordinates.
protected void	setGeodeticComputation(IlvGeodeticComputation geodeticComputation) Sets the geodetic computation used to compute the distance between pairs of latitude and longitude coordinates.
void	setHiddenZoneColor(Color hiddenZoneColor) Sets the color of non-visible zones.
void	setPointOfView(IlvCoordinate pointOfView) Sets the new viewpoint location.
void	setPointOfViewHeight(double pointOfViewHeight) Sets the new viewpoint height.
void	setPrecision(double precision) Sets the new precision in meters.
void	setStyle(IlvMapStyle style) This overridden method is used to install a listener on the style changes that can require the recomputation of the line.
void	setTargetPoint(IlvCoordinate targetPoint) Sets the new target point location.
void	setUsingEarthCurvature(boolean usingEarthCurvature) Set to true if the computation should take into account the mean curvature of the earth.
void	setVisibleZoneColor(Color visibleZoneColor) Sets the color of visible segments.
void	write(IlvOutputStream stream) Writes this IlvLineOfVisibility object to the IlvOutputStream passed as parameter.

Methods inherited from class ilog.views.maps.graphic.IlvMapPolyline

boundingBox, contains, copy, drawDecoration, getBackground, getDecoration, getDecorationPaint, getEndCap, getForeground, getLineJoin, getLineStyle, getLineWidth, getLineWidth, getMaximumLineWidth, isDecorationOnly, isPreciseContains, makeGeometry, setBackground, setDecoration, setDecorationOnly, setDecorationPaint, setEndCap, setForeground, setLineJoin, setLineStyle, setLineWidth, setPreciseContains, zoomable

Methods inherited from class ilog.views.graphic.IlvPolyline

computeBBox, finalize, getIntersectionWithOutline, pointsInBBox, setMaximumLineWidth

Methods inherited from class ilog.views.graphic.IlvPolyPoints

allowsPointInsertion, allowsPointMove, allowsPointRemoval, getPointAt, getPoints, getPointsCardinal, inBBox, insertPoint, intersects, makeSelection, recomputeBBox, removePoint, translate

Methods inherited from class ilog.views.IlvGraphic

addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, getAndAssociateObjectInteractor, getBaseTextDirection, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getComponentOrientation, getDefaultInteractor, getGraphicBag, GetGraphicObject, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getResolvedBaseTextDirection, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getULocale, getZOrderIndex, hasProperty, inside, invalidateBBoxCache, invalidateBidiCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, move, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBaseTextDirection, setBaseTextDirectionDuringConstruction, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvLineOfVisibility

public IlvLineOfVisibility(IlvManager manager,
                           double pointOfViewHeight,
                           double precision,
                           IlvCoordinateSystem cs,
                           IlvAltitudeProvider elevationProvider,
                           IlvCoordinate pointOfView,
                           IlvCoordinate targetPoint)

Creates a new IlvLineOfVisibility object.

Parameters:

manager - The manager the line of visibility is attached to.

pointOfViewHeight - The altitude of the observer above the ground.

precision - The step in meters.

cs - The coordinate system.

elevationProvider - The elevation provider.

pointOfView - The viewpoint coordinates.

targetPoint - The target coordinates.

IlvLineOfVisibility

public IlvLineOfVisibility(IlvInputStream stream)
                    throws IlvReadFileException

Reads an IlvLineOfVisibility instance from an IlvInputStream.

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException - if there is a problem reading from stream.

IlvLineOfVisibility

public IlvLineOfVisibility(IlvManager manager,
                           double pointOfViewHeight,
                           double precision,
                           IlvCoordinate pointOfView,
                           IlvCoordinate targetPoint)

Creates a new IlvLineOfVisibility object.

Parameters:

manager - The manager the line of visibility is attached to.

pointOfViewHeight - The altitude of the observer above ground.

precision - The step in meters.

pointOfView - The viewpoint coordinates.

targetPoint - The target coordinates.

IlvLineOfVisibility

public IlvLineOfVisibility(IlvManager manager,
                           double pointOfViewHeight,
                           double precision,
                           IlvPoint p1,
                           IlvPoint p2)

Creates a new IlvLineOfVisibility object.

Parameters:

manager - The manager the line of visibility is attached to.

pointOfViewHeight - The altitude of the observer above ground.

precision - The step in meters.

p1 - An IlvPoint instance that represents the viewpoint.

p2 - An IlvPoint instance that represents the target.

IlvLineOfVisibility

public IlvLineOfVisibility(IlvLineOfVisibility source)

Creates an IlvLineOfVisibility object by copying an existing one.

Parameters:

source - The source IlvLineOfVisibility instance.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this IlvLineOfVisibility object to the IlvOutputStream passed as parameter.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvMapPolyline

Parameters:

stream - The stream to write to.

Throws:

IOException - if there is a problem writing to stream.

draw

public void draw(Graphics dst,
                 IlvTransformer t)

Draws this IlvMapPolyline object with the specified graphics and transformer.

Overrides:

draw in class IlvMapPolyline

Parameters:

dst - The graphics to draw to.

t - The view transformer.

See Also:

IlvPolyline.draw(java.awt.Graphics, ilog.views.IlvTransformer)

getHiddenZoneColor

public Color getHiddenZoneColor()

Returns the color of non-visible zones.

Returns:

The color of non visible zones. If the zones should not appear, null is returned.

getInvisibleSegments

protected IlvLineOfVisibility.Segment[] getInvisibleSegments()

Possibly computes and return the array of invisible segments.

Returns:

The array of invisible segments.

getLength

public double getLength()

Returns the distance between the viewpoint and the target in meters.

Returns:

The distance between the viewpoint and the target.

See Also:

getGeodeticComputation()

getPointOfView

public IlvCoordinate getPointOfView()

Returns the current viewpoint location.

Returns:

The point of view.

getPointOfViewHeight

public double getPointOfViewHeight()

Returns the viewpoint height.

Returns:

The viewpoint height.

getPrecision

public double getPrecision()

Returns the current precision.

Returns:

The current precision.

getTargetPoint

public IlvCoordinate getTargetPoint()

Returns the current viewpoint location.

Returns:

The target point.

getVisibleSegments

protected IlvLineOfVisibility.Segment[] getVisibleSegments()

Returns the array of visible segments.

Returns:

The array of visible segments.

getVisibleZoneColor

public Color getVisibleZoneColor()

Returns the color of the visible zones.

Returns:

The color of visible zones. If the zones should not appear, null is returned.

isVisible

public boolean isVisible(double distanceFromStart)

Returns whether or not the point located at a certain distance is visible to the observer using the current line of visibility parameters.

Note: this method is designed for an external use by an application, it uses the internally computed visible segments.

Parameters:

distanceFromStart - The distance from the view point.

Returns:

If the point is visible, true is returned.

applyTransform

public void applyTransform(IlvTransformer t)

This overridden method of the superclass is used to make sure colors are updated.

Overrides:

applyTransform in class IlvPolyPoints

Parameters:

t - The transformer for this object.

See Also:

IlvPolyPoints.applyTransform(ilog.views.IlvTransformer)

refresh

public void refresh()

Forces the recomputation of the visible and invisible segments.

setHiddenZoneColor

public void setHiddenZoneColor(Color hiddenZoneColor)

Sets the color of non-visible zones.

Parameters:

hiddenZoneColor - The color of non-visible zones. Set to null if these zones should not appear.

setPointOfView

public void setPointOfView(IlvCoordinate pointOfView)

Sets the new viewpoint location.

Parameters:

pointOfView - The new viewpoint location.

setPointOfViewHeight

public void setPointOfViewHeight(double pointOfViewHeight)

Sets the new viewpoint height.

Parameters:

pointOfViewHeight - The new viewpoint height.

setPrecision

public void setPrecision(double precision)

Sets the new precision in meters. This indicates the distance between consecutive points when retrieving the altitude from the altitude provider and computing visibility.

Parameters:

precision - The new precision.

setTargetPoint

public void setTargetPoint(IlvCoordinate targetPoint)

Sets the new target point location.

Parameters:

targetPoint - The latitude and logitude coordinates of the new target point.

setVisibleZoneColor

public void setVisibleZoneColor(Color visibleZoneColor)

Sets the color of visible segments. The default color is is green.

Parameters:

visibleZoneColor - The color of visible zones. Set to null if these segments should not appear.

computeVisibility

protected void computeVisibility()

Computes the new visible and invisible segments arrays. This can be also be done by first creating the table of curvilinear abscissa to use, along with a visibility boolean table, then calling computeSegments(double[], boolean[]).

computeSegments

protected void computeSegments(double[] measureDistances,
                               boolean[] visibilities)

Computes and sets the segment list from the curvilinear abscissa and visibility arrays.

Parameters:

measureDistances - The curvilinear abscissa.

visibilities - The visibility array.

addChangeListener

public void addChangeListener(IlvLineOfVisibility.ComputeListener c)

Adds a listener to this line of view instance that will be called whenever visibility information has changed.

Parameters:

c - The listener to add.

removeChangeListener

public void removeChangeListener(IlvLineOfVisibility.ComputeListener c)

Removes a listener from the listener list.

Parameters:

c - The listener to remove.

fireChange

protected void fireChange()

Fires a change in the line of visibility that will execute all registered listeners.

getDistance

protected double getDistance(double lon1,
                             double lat1,
                             double lon2,
                             double lat2)

Returns the distance in meters between the specified latitude and longitude coordinates.

Parameters:

lon1 - The longitude in radians of the first point.

lat1 - The latitude in radians of the first point.

lon2 - The longitude in radians of the second point.

lat2 - The latitude in radians of the second point.

Returns:

The distance in meters.

See Also:

IlvGeodeticComputation

getLatLon

protected IlvCoordinate getLatLon(int iPoint)

Returns a point on the line in latitude and longitude coordinates..

Parameters:

iPoint - Should be 0 or 1.

Returns:

The point on the line.

getGeodeticComputation

protected IlvGeodeticComputation getGeodeticComputation()

Returns the geodetic computation used to compute distances on the surface of the earth

Returns:

The geodetic computation used to compute distances on the surface of earth.

setGeodeticComputation

protected void setGeodeticComputation(IlvGeodeticComputation geodeticComputation)

Sets the geodetic computation used to compute the distance between pairs of latitude and longitude coordinates.

Parameters:

geodeticComputation - The geodetic computation to use.

getElevationProvider

public IlvAltitudeProvider getElevationProvider()

Returns the elevation provider.

Returns:

The elevation provider.

setElevationProvider

protected void setElevationProvider(IlvAltitudeProvider provider)

Sets the elevation provider that is used to retrieve altitudes from latitude and longitude coordinates.

Parameters:

provider - The elevation provider to use to retrieve altitudes from latitude and longitude coordinates.

getManager

public IlvManager getManager()

Returns the reference manager.

Returns:

The reference manager.

getKernelToSystemTransformation

protected IlvCoordinateTransformation getKernelToSystemTransformation()

Returns the kernel to system transformation.

Returns:

The kernel to system transformation

getSystemToKernelTransformation

protected IlvCoordinateTransformation getSystemToKernelTransformation()

Returns the system to kernel transformation.

Returns:

The system to kernel transformation.

setCoordinateSystem

protected void setCoordinateSystem(IlvCoordinateSystem coordinateSystem)

Sets the geodetic computation according to the ellipsoid defined in the coordinate system projection. This method also stores the kernel to system and system to kernel transformations used to transform latitude and longitude coordinates to and from IlvManager coordinates.

Parameters:

coordinateSystem - The coordinateSystem to set.

mustRecompute

protected void mustRecompute()

Indicates that the computed list of invisible and visible segments is no longer valid.

isUsingEarthCurvature

public boolean isUsingEarthCurvature()

Tests if the computation should take into account the mean curvature of the earth.

Returns:

If the computation should take into account the mean curvature of the earth, true is returned.

See Also:

setUsingEarthCurvature(boolean )

setUsingEarthCurvature

public void setUsingEarthCurvature(boolean usingEarthCurvature)

Set to true if the computation should take into account the mean curvature of the earth. The default value is true.

Parameters:

usingEarthCurvature - Set to true if the computation should take into account the mean curvature of the earth.

getLineOfVisibilityStyle

public IlvLineOfVisibilityStyle getLineOfVisibilityStyle()

Returns the style of this line.

Returns:

The style of this line.

getStyle

public IlvMapStyle getStyle()

Retrieves the IlvMapStyle attached to this graphic.

Specified by:

getStyle in interface IlvMapGraphic

Overrides:

getStyle in class IlvMapPolyline

Returns:

The IlvMapStyle attached to this graphic.

See Also:

IlvMapPolyline.getStyle()

setStyle

public void setStyle(IlvMapStyle style)

This overridden method is used to install a listener on the style changes that can require the recomputation of the line.

Specified by:

setStyle in interface IlvMapGraphic

Overrides:

setStyle in class IlvMapPolyline

Parameters:

style - The IlvMapStyle to set. This parameter must be a IlvLineOfVisibilityStyle instance.

copy

public IlvGraphic copy()

Copies this object.

Overrides:

copy in class IlvMapPolyline

Returns:

A new IlvLineOfVisibility object.

See Also:

IlvGraphic

move

public void move(double x,
                 double y)

This overridden method of the superclass also calls mustRecompute().

Overrides:

move in class IlvGraphic

Parameters:

x - The x coordinate.

y - The y coordinate.

See Also:

IlvGraphic.move(double, double)

movePoint

public void movePoint(int index,
                      double x,
                      double y,
                      IlvTransformer t)

This overridden method of the superclass also calls mustRecompute().

Specified by:

movePoint in interface IlvPolyPointsInterface

Overrides:

movePoint in class IlvPolyPoints

Parameters:

index - The index of the point.

x - The x coordinate.

y - The y coordinate.

t - The transformer to move the point.

See Also:

IlvPolyPoints.movePoint(int, double, double, ilog.views.IlvTransformer)

moveResize

public void moveResize(IlvRect r)

This overridden method of the superclass also calls mustRecompute().

Overrides:

moveResize in class IlvGraphic

Parameters:

r - The rectangle to recompute.

See Also:

IlvGraphic.moveResize(ilog.views.IlvRect)