com.luciad.earth.tileset.terrain

LuciadLightspeedClass TLcdEarthGXYLayerHeightProviderFactory

java.lang.Object

com.luciad.earth.tileset.terrain.TLcdEarthGXYLayerHeightProviderFactory

All Implemented Interfaces:

ILcdLayerHeightProviderFactory

public class TLcdEarthGXYLayerHeightProviderFactory
extends Object
implements ILcdLayerHeightProviderFactory

A layer-based height provider factory implementation for ILcdEarthTileSets in ILcdGXYViews. Additionally the ILcdGXYLayer must have a TLcdEarthGXYElevationRasterPainter as painter.

Usage

An important advantage of the layer-based height providers vs. model-based height providers is that the returned heights are the same as those visible in the view. This is for example important when you have a label that displays the height at the cursor position.

Another important advantage is that using a layer-based height provider typically results in significantly better performance than the model-based counterpart because all necessary tiles are already cached. This avoids additional tile production which possibly requires expensive operations such as IO. This is especially important when the heights need to be retrieved from the event dispatch thread (ex. while painting).

Since:

10.1

See Also:

TLcdEarthHeightProviderFactory

Field Summary

Fields inherited from interface com.luciad.util.height.ILcdLayerHeightProviderFactory

KEY_GEO_REFERENCE

Constructor Summary

Constructors

Constructor and Description
TLcdEarthGXYLayerHeightProviderFactory()

Method Summary

Modifier and Type	Method and Description
ILcdHeightProvider	createHeightProvider(ILcdLayer aLayer, ILcdView aView, Map<String,Object> aRequiredProperties, Map<String,Object> aOptionalProperties) A height provider is created for each tile set in the layer's model by using the createTileSetHeightProvider(com.luciad.earth.tileset.ILcdEarthTileSet, com.luciad.view.gxy.ILcdGXYLayer, com.luciad.view.gxy.ILcdGXYView, com.luciad.reference.ILcdGeoReference, java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.lang.Object>) method.
protected ILcdHeightProvider	createTileSetHeightProvider(ILcdEarthTileSet aTileSet, ILcdGXYLayer aGXYLayer, ILcdGXYView aGXYView, ILcdGeoReference aReference, Map<String,Object> aRequiredPropertiesSFCT, Map<String,Object> aOptionalProperties) Creates a layer-based height provider for a tile set.
protected TLcdEarthGXYElevationRasterPainter	getGXYElevationPainter(ILcdEarthTileSet aTileSet, ILcdGXYLayer aGXYLayer, ILcdGXYView aGXYView, ILcdGeoReference aReference, Map<String,Object> aRequiredPropertiesSFCT, Map<String,Object> aOptionalProperties) Returns the elevation painter for a tile set.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdEarthGXYLayerHeightProviderFactory

public TLcdEarthGXYLayerHeightProviderFactory()

Method Detail

createHeightProvider

public ILcdHeightProvider createHeightProvider(ILcdLayer aLayer,
                                               ILcdView aView,
                                               Map<String,Object> aRequiredProperties,
                                               Map<String,Object> aOptionalProperties)
                                        throws TLcdMissingPropertyException,
                                               TLcdUnsupportedPropertyException

A height provider is created for each tile set in the layer's model by using the createTileSetHeightProvider(com.luciad.earth.tileset.ILcdEarthTileSet, com.luciad.view.gxy.ILcdGXYLayer, com.luciad.view.gxy.ILcdGXYView, com.luciad.reference.ILcdGeoReference, java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.lang.Object>) method.

Specified by:

createHeightProvider in interface ILcdLayerHeightProviderFactory

Parameters:

aLayer - an ILcdLayer for which a height provider is created.

aView - an ILcdView in which aLayer is contained.

aRequiredProperties - the required properties. The properties can be retrieved using a String key describing the property type. When not all required properties are used, an exception is thrown. aRequiredProperties may be empty but should not be null. When a required property as used, it should always be removed from the list of required properties. When an ILcdHeightProvider is actually made, the list of required properties should be verified.

aOptionalProperties - the optional properties. The properties can be retrieved using a String key describing the property type. The optional properties may or may not be used by the implementation. aOptionalProperties may be empty but should not be null.

Returns:

a height provider if elevation is supported, or null when elevation is not supported or when no valid height provider can be created.

Throws:

TLcdMissingPropertyException - when the implementation misses a necessary property.

TLcdUnsupportedPropertyException - when a required property is not used by the implementation.

See Also:

ILcdModelHeightProviderFactory

createTileSetHeightProvider

protected ILcdHeightProvider createTileSetHeightProvider(ILcdEarthTileSet aTileSet,
                                                         ILcdGXYLayer aGXYLayer,
                                                         ILcdGXYView aGXYView,
                                                         ILcdGeoReference aReference,
                                                         Map<String,Object> aRequiredPropertiesSFCT,
                                                         Map<String,Object> aOptionalProperties)

Creates a layer-based height provider for a tile set.

The elevation painter for the tile set is retrieved using the getGXYElevationPainter(com.luciad.earth.tileset.ILcdEarthTileSet, com.luciad.view.gxy.ILcdGXYLayer, com.luciad.view.gxy.ILcdGXYView, com.luciad.reference.ILcdGeoReference, java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.lang.Object>) method.

Parameters:

aTileSet - the ILcdEarthTileSet for which a height provider is created.

aGXYLayer - an ILcdGXYLayer for which a height provider is created.

aGXYView - an ILcdGXYView in which aLayer is contained.

aReference - the geographic reference of the height provider.

aRequiredPropertiesSFCT - the required properties. The properties can be retrieved using a String key describing the property type. When not all required properties are used, an exception is thrown. aRequiredProperties may be empty but should not be null. When a required property as used, it should always be removed from the list of required properties. When an ILcdHeightProvider is actually made, the list of required properties should be verified.

aOptionalProperties - the optional properties. The properties can be retrieved using a String key describing the property type. The optional properties may or may not be used by the implementation. aOptionalProperties may be empty but should not be null.

Returns:

a height provider if elevation is supported, or null when elevation is not supported or when no valid height provider can be created.

See Also:

getGXYElevationPainter(com.luciad.earth.tileset.ILcdEarthTileSet, com.luciad.view.gxy.ILcdGXYLayer, com.luciad.view.gxy.ILcdGXYView, com.luciad.reference.ILcdGeoReference, java.util.Map<java.lang.String, java.lang.Object>, java.util.Map<java.lang.String, java.lang.Object>)

getGXYElevationPainter

protected TLcdEarthGXYElevationRasterPainter getGXYElevationPainter(ILcdEarthTileSet aTileSet,
                                                                    ILcdGXYLayer aGXYLayer,
                                                                    ILcdGXYView aGXYView,
                                                                    ILcdGeoReference aReference,
                                                                    Map<String,Object> aRequiredPropertiesSFCT,
                                                                    Map<String,Object> aOptionalProperties)

Returns the elevation painter for a tile set.

The default implementation returns a painter if the layer is a TLcdGXYLayer with a TLcdEarthGXYElevationRasterPainter as one of its painter providers or null otherwise.

This method can be overridden to retrieve the elevation painter from a layer that is not supported by the default implementation.

Parameters:

aTileSet - the ILcdEarthTileSet for which a height provider is created.

aGXYLayer - an ILcdGXYLayer for which a height provider is created.

aGXYView - an ILcdGXYView in which aLayer is contained.

aReference - the geographic reference of the height provider.

aRequiredPropertiesSFCT - the required properties. The properties can be retrieved using a String key describing the property type. When not all required properties are used, an exception is thrown. aRequiredProperties may be empty but should not be null. When a required property as used, it should always be removed from the list of required properties. When an ILcdHeightProvider is actually made, the list of required properties should be verified.

aOptionalProperties - the optional properties. The properties can be retrieved using a String key describing the property type. The optional properties may or may not be used by the implementation. aOptionalProperties may be empty but should not be null.

Returns:

an elevation painter or null when none is available.

See Also:

TLcdGXYLayer.getGXYPainterProviderArray()