ilog.views.maps

Class IlvDefaultAltitudeProvider

java.lang.Object

ilog.views.maps.IlvAltitudeProvider

ilog.views.maps.IlvDefaultAltitudeProvider

All Implemented Interfaces:

IlvApplyObject, IlvPersistentObject, Serializable

public class IlvDefaultAltitudeProvider
extends IlvAltitudeProvider
implements IlvPersistentObject, IlvApplyObject

This class defines the default altitude provider for an IlvManager containing cartographic data.
The getAltitude method tries to find IlvGraphic objects that fill the following criteria:

• They have properties containing an IlvAltitudeDataSource instance.
• They intersect the given region.

Altitude data sources usually come from grid type data such as DTED or other rasters. They can include regions where no data is known.
Each altitude data source is queried in sequence until one is found containing some altitude information for the required point.
You can improve altitude research performance by calling registerPossibleProviders. After this call all the altitude data sources in the manager are cached. The cached list, and only this list, is used in subsequent calls to getAltitude. This gives important performance improvements over the default case where few such object exist, whereas many other graphic objects, such as polygons, exist in the same area.

Since:

JViews 7.5

See Also:

getAltitude(IlvManager, double, double, double), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDefaultAltitudeProvider() Creates a new IlvDefaultAltitudeProvider instance.
IlvDefaultAltitudeProvider(IlvDefaultAltitudeProvider provider) Creates a new IlvDefaultAltitudeProvider by copying an existing one.
IlvDefaultAltitudeProvider(IlvInputStream stream) Creates a new IlvDefaultAltitudeProvider from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
void	apply(IlvGraphic obj, Object vector) The apply method that performs the action.
IlvAltitudeProvider	copy() Creates a new IlvAltitudeProvider from an IlvDefaultAltitudeProvider object.
double	getAltitude(IlvManager manager, double xlon, double ylat, double precision) Returns the altitude of a point located at specified coordinates.
boolean	isUsingInvisibleLayers() Tests if this provider should search for altitude data sources in layers that are currently invisible.
void	registerPossibleProviders(IlvManager manager) Creates the possible provider list for this manager from the objects present.
void	setUsingInvisibleLayers(boolean usingInvisibleLayers) Sets whether the provider should search for altitude data sources in invisible layers.
void	unregisterPossibleProviders() Clears the possible provider list.
void	write(IlvOutputStream stream) This default implementation does nothing.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultAltitudeProvider

public IlvDefaultAltitudeProvider()

Creates a new IlvDefaultAltitudeProvider instance. This default implementation does nothing.

IlvDefaultAltitudeProvider

public IlvDefaultAltitudeProvider(IlvDefaultAltitudeProvider provider)

Creates a new IlvDefaultAltitudeProvider by copying an existing one. This default implementation does nothing.

Parameters:

provider - The source altitude provider to be copied.

IlvDefaultAltitudeProvider

public IlvDefaultAltitudeProvider(IlvInputStream stream)
                           throws IlvReadFileException

Creates a new IlvDefaultAltitudeProvider from an IlvInputStream. This default implementation does nothing.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if an error occurs while reading from the stream.

Method Detail

isUsingInvisibleLayers

public boolean isUsingInvisibleLayers()

Tests if this provider should search for altitude data sources in layers that are currently invisible.
Note: the default value is true.

Returns:

If the provider can search in currently invisible Layers, true is returned.

setUsingInvisibleLayers

public void setUsingInvisibleLayers(boolean usingInvisibleLayers)

Sets whether the provider should search for altitude data sources in invisible layers.
Note: the default value is true.

Parameters:

usingInvisibleLayers - Set to true to search in invisible layers.

copy

public IlvAltitudeProvider copy()

Creates a new IlvAltitudeProvider from an IlvDefaultAltitudeProvider object.

Specified by:

copy in class IlvAltitudeProvider

Returns:

A new IlvAltitudeProvider instance.

write

public void write(IlvOutputStream stream)

This default implementation does nothing.

Specified by:

write in interface IlvPersistentObject

Specified by:

write in class IlvAltitudeProvider

Parameters:

stream - the output stream

See Also:

IlvPersistentObject.write(ilog.views.io.IlvOutputStream)

getAltitude

public double getAltitude(IlvManager manager,
                          double xlon,
                          double ylat,
                          double precision)

Returns the altitude of a point located at specified coordinates.

This method uses the manager's coordinate system to locate all objects at the specified latitude and longitude location. It then locates any attached IlvAttributeProperty objects that contain an IlvAltitudeDataSource value. For each property found, getAltitude is called until one of them returns a non-NaN value. This altitude data source is then cached and reused until it returns a NaN - after which the search is done again.

Specified by:

getAltitude in class IlvAltitudeProvider

Parameters:

manager - The manager to use for finding altitudes providing graphics.

xlon - The longitude in radians.

ylat - The latitude in radians.

precision - The coordinate precision.

Returns:

The altitude of this point. If there is no altitude for the point specified, a NaN is returned.

See Also:

IlvCoordinateSystemProperty.GetCoordinateSystem(IlvManager), IlvManager.mapIntersects(ilog.views.IlvApplyObject, java.lang.Object, ilog.views.IlvRect, ilog.views.IlvTransformer)

registerPossibleProviders

public void registerPossibleProviders(IlvManager manager)

Creates the possible provider list for this manager from the objects present.
Calling this method is optional, but can improve performances. If this method is not called, the default altitude provider will try to find altitude providers from latitude and longitude information.

Parameters:

manager - The Manager to look for altitude providers.

unregisterPossibleProviders

public void unregisterPossibleProviders()

Clears the possible provider list.

See Also:

registerPossibleProviders(IlvManager)

apply

public void apply(IlvGraphic obj,
                  Object vector)

The apply method that performs the action.

Specified by:

apply in interface IlvApplyObject

Parameters:

obj - The current graphic object.

vector - The argument passed when using the IlvApplyObject.

See Also:

IlvApplyObject.apply(ilog.views.IlvGraphic, java.lang.Object)