com.luciad.lucy.addons.tea.hypsometry

LuciadLightspeedClass TLcyHypsometryAddon

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.ALcyPreferencesAddOn

com.luciad.lucy.addons.ALcyFormatAddOn

com.luciad.lucy.addons.tea.hypsometry.TLcyHypsometryAddon

public class TLcyHypsometryAddon
extends ALcyFormatAddOn

Add-on to compute slopes, orientations, azimuths, and other parameters derived from elevations, and visualize the results on a GXY map. It provides a terrain analysis back-end, format and GUI.

The GUI's application pane is built by a ALcyApplicationPaneTool, using the add-on's GUI factory. By default, this GUI uses the composite workspace preferences of the add-on's preferences tool.

The add-on's functionality can be changed by extending the back-end, or by extending the GUI builder and tapping into the latter preferences object. See the TEA developer's guide for more information on using and extending TEA add-ons.

Note that this add-on depends on the LuciadLightspeed TEA Industry Specific Component.

See Also:

TLcyHypsometryBackEnd, TLcyHypsometryGUIFactory, TLcyPreferencesTool.getCompositeWorkspacePreferences()

Field Summary

Fields

Modifier and Type	Field and Description
static int	LAYER_ACTION_ID Creation of a hypsometry layer based on the selected layer.
static String	SELECTED_ACTION_KEY Property name defining how the hypsometry should be created.
static int	SELECTED_ACTION_VALUE_DEFAULT Default value for the SELECTED_ACTION_KEY property.
static String	SELECTED_VALUE_PROVIDER_KEY Property name for the hypsometric value provider to use in the hypsometry calculations.
static String	SELECTED_VALUE_PROVIDER_VALUE_DEFAULT Default hypsometric value provider to use in the hypsometry calculations.
static int	SHAPE_ACTION_ID Creation of a hypsometry layer based on all visible layers, inside the bounds of the selected shape.
static String	VALUE_PROVIDER_LIST_KEY Property name defining the hypsometric value providers that can be chosen from.
static String[]	VALUE_PROVIDER_LIST_VALUE_DEFAULT Default hypsometric value providers that can be chosen from.

Constructor Summary

Constructors

Constructor and Description
TLcyHypsometryAddon() Default constructor for the hypsometry add-on.

Method Summary

Modifier and Type	Method and Description
protected ALcyApplicationPaneTool	createApplicationPaneTool() Returns the add-on's application pane tool.
protected ALcyFormat	createBaseFormat() Returns a new data format for this add-on.
TLcyFormatTool	createFormatTool(ALcyFormat aFormat) Creates a new format tool for the given format.
ALcyFormat	createFormatWrapper(ALcyFormat aBaseFormat) Returns a new data format wrapper for this add-on.
protected ALcyGUIFactory<Component>	createGUIFactory() Returns a new GUI factory for this add-on.
protected TLcyHypsometryBackEnd	createHypsometryBackEnd() Returns a new back-end for hypsometry calculations.
protected ALcyFormat	createHypsometryGeoTIFFBaseFormat() Returns a new file format for the snapshots taken of all visible elevation layers.
protected ALcyFormat	createHypsometryGeoTIFFBaseFormatWrapper(ALcyFormat aBaseFormat) Returns a new file format wrapper for this format's snapshot format.
protected TLcyPreferencesTool	createPreferencesTool() Creates the TLcyPreferencesTool to be used by this add-on.
ALcyApplicationPaneTool	getApplicationPaneTool() Returns the tool that creates the add-on's application pane.
ALcyGUIFactory<T>	getGUIFactory() Returns the GUI factory to create the add-on's application pane.
TLcyHypsometryBackEnd	getHypsometryBackEnd() The back-end that the GUI can use for performing hypsometry calculations.
ALcyFormat	getHypsometryGeoTIFFFormat() Returns the ALcyFormat class that encapsulates a data format for the snapshots taken of all visible elevation layers.
void	plugInto(ILcyLucyEnv aLucyEnv) Builds a GUI, back-end and file formats for hypsometry calculations and plugs in the GUI and file format.
void	unplugFrom(ILcyLucyEnv aLucyEnv) Unplugs the add-on's format, preferences tool and application pane tool.

Methods inherited from class com.luciad.lucy.addons.ALcyFormatAddOn

getFormat

Methods inherited from class com.luciad.lucy.addons.ALcyPreferencesAddOn

getLongPrefix, getLucyEnv, getPreferences, getPreferencesTool, getShortPrefix

Methods inherited from class com.luciad.lucy.addons.ALcyAddOn

getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED_VALUE_PROVIDER_KEY

public static final String SELECTED_VALUE_PROVIDER_KEY

Property name for the hypsometric value provider to use in the hypsometry calculations. The associated property value is of type String. See TLcyHypsometryBackEnd for the supported value providers.

The property value is used to define additional sub-properties for the value provider. For example, the azimuth of the slope value provider can be found in the following property:

""TLcyHypsometryAddon.layer.tea.provider."" +
TLcyHypsometryBackEnd.HYPSOMETRIC_VALUE_PROVIDER_SLOPE_ID + "." +
TLcyHypsometryBackEnd.AZIMUTH_KEY.

TLcyHypsometryBackEnd.createHypsometricValueProvider(com.luciad.lucy.util.properties.ALcyProperties) is used to construct the actual provider.

See Also:

TLcyHypsometryBackEnd.createHypsometricValueProvider(ALcyProperties), TLcyHypsometryBackEnd.retrieveHypsometricValueProviderLabel(String), Constant Field Values

SELECTED_VALUE_PROVIDER_VALUE_DEFAULT

public static final String SELECTED_VALUE_PROVIDER_VALUE_DEFAULT

Default hypsometric value provider to use in the hypsometry calculations.

See Also:

Constant Field Values

VALUE_PROVIDER_LIST_KEY

public static final String VALUE_PROVIDER_LIST_KEY

Property name defining the hypsometric value providers that can be chosen from. See TLcyHypsometryBackEnd for a list of supported value providers. The associated value is an array of String objects.

See Also:

Constant Field Values

VALUE_PROVIDER_LIST_VALUE_DEFAULT

public static final String[] VALUE_PROVIDER_LIST_VALUE_DEFAULT

Default hypsometric value providers that can be chosen from.

LAYER_ACTION_ID

public static final int LAYER_ACTION_ID

Creation of a hypsometry layer based on the selected layer.

See Also:

Constant Field Values

SHAPE_ACTION_ID

public static final int SHAPE_ACTION_ID

Creation of a hypsometry layer based on all visible layers, inside the bounds of the selected shape.

See Also:

Constant Field Values

SELECTED_ACTION_KEY

public static final String SELECTED_ACTION_KEY

Property name defining how the hypsometry should be created. One of SHAPE_ACTION_ID or LAYER_ACTION_ID.

See Also:

Constant Field Values

SELECTED_ACTION_VALUE_DEFAULT

public static final int SELECTED_ACTION_VALUE_DEFAULT

Default value for the SELECTED_ACTION_KEY property.

See Also:

Constant Field Values

Constructor Detail

TLcyHypsometryAddon

public TLcyHypsometryAddon()

Default constructor for the hypsometry add-on.

Method Detail

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Builds a GUI, back-end and file formats for hypsometry calculations and plugs in the GUI and file format.

Parameters:

aLucyEnv - the Lucy instance to plug into

See Also:

ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)

unplugFrom

public void unplugFrom(ILcyLucyEnv aLucyEnv)

Unplugs the add-on's format, preferences tool and application pane tool.

Parameters:

aLucyEnv - the Lucy environment

See Also:

ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)

createHypsometryBackEnd

protected TLcyHypsometryBackEnd createHypsometryBackEnd()

Returns a new back-end for hypsometry calculations. Override this method to extend the default back-end with new functionality.

Returns:

a new back-end for hypsometry calculations

getHypsometryBackEnd

public TLcyHypsometryBackEnd getHypsometryBackEnd()

The back-end that the GUI can use for performing hypsometry calculations.

Override createHypsometryBackEnd() to extend the back-end.

Returns:

a TLcyHypsometryBackEnd object for performing contour calculations

See Also:

createHypsometryBackEnd(), TLcyHypsometryBackEnd

getHypsometryGeoTIFFFormat

public ALcyFormat getHypsometryGeoTIFFFormat()

Returns the ALcyFormat class that encapsulates a data format for the snapshots taken of all visible elevation layers.

Returns:

the ALcyFormat class that encapsulates a data format for the snapshots taken of all visible elevation layers

See Also:

ALcyFormatAddOn.getFormat()

createHypsometryGeoTIFFBaseFormat

protected ALcyFormat createHypsometryGeoTIFFBaseFormat()

Returns a new file format for the snapshots taken of all visible elevation layers.

Returns:

a new file format for the snapshots taken of all visible elevation layers

createHypsometryGeoTIFFBaseFormatWrapper

protected ALcyFormat createHypsometryGeoTIFFBaseFormatWrapper(ALcyFormat aBaseFormat)

Returns a new file format wrapper for this format's snapshot format.

Parameters:

aBaseFormat - the base file format to wrap

Returns:

a new file format wrapper for this format's snapshot format

See Also:

ALcyFormatWrapper

createBaseFormat

protected ALcyFormat createBaseFormat()

Returns a new data format for this add-on. Override this method to extend the default format with new functionality.

For example, to alter the icon of the layers of this format, you can decorate the layer factory created in the format:

 @Override
 protected ALcyFormat createBaseFormat() {
   return new ALcyFormatWrapper(super.createBaseFormat()){
     @Override
     protected ILcdGXYLayerFactory createGXYLayerFactory(){
       final ILcdGXYLayerFactory delegate = super.createGXYLayerFactory();
       return new ILcdGXYLayerFactory(){
         @Override
         public ILcdGXYLayer createGXYLayer(ILcdModel aModel){
           ILcdGXYLayer layer = delegate.createGXYLayer(aModel);
           if (layer != null){
             ILcdIcon icon = ...;
             layer.setIcon(icon);
           }
           return layer;
         }
       }
     }
   }
 }
 

Note that the created format is at least wrapped by a TLcySafeGuardFormatWrapper (or equivalent) before it is plugged in ILcyLucyEnv (using e.g. TLcyFormatTool). So it is safe to rely on the safety checks performed by that wrapper.

Returns:

a new file format for this add-on

createFormatTool

public TLcyFormatTool createFormatTool(ALcyFormat aFormat)

Description copied from class: ALcyFormatAddOn

Creates a new format tool for the given format. It is used to plug all parts of the format ( e.g. ILcdGXYLayerFactory, ILcdModelDecoder, etc.) into ILcyLucyEnv.

Overrides:

createFormatTool in class ALcyFormatAddOn

Parameters:

aFormat - the format for which to create a tool

Returns:

the created TLcyFormatTool

createFormatWrapper

public final ALcyFormat createFormatWrapper(ALcyFormat aBaseFormat)

Description copied from class: ALcyFormatAddOn

Returns a new data format wrapper for this add-on. A format wrapper extends the base format with aspects such as asynchronous painting, mutable file behavior, safe guarding, etc.

Overriding this method of an existing add-on should be done with extreme care as add-ons typically rely on the wrappers that should be present (e.g. a safe guard).

Specified by:

createFormatWrapper in class ALcyFormatAddOn

Parameters:

aBaseFormat - the base format to wrap

Returns:

a new format for this add-on

See Also:

ALcyFormatWrapper

createGUIFactory

protected ALcyGUIFactory<Component> createGUIFactory()

Returns a new GUI factory for this add-on. Override this method to extend the default GUI with new functionality.

For example, this add-on could return a new instance of TLcyHypsometryGUIFactory

Returns:

a new GUI factory for this add-on

createApplicationPaneTool

protected ALcyApplicationPaneTool createApplicationPaneTool()

Returns the add-on's application pane tool. Override this method to add to the default application pane tool's functionality.

This add-on's application pane tool initializes the GUI factory with the add-on's composite workspace preferences.

Returns:

the add-on's application pane tool

getGUIFactory

public ALcyGUIFactory<T> getGUIFactory()

Returns the GUI factory to create the add-on's application pane. See createGUIFactory() if you want to override or extend the add-on's factory.

Returns:

the add-on's GUI factory

getApplicationPaneTool

public ALcyApplicationPaneTool getApplicationPaneTool()

Returns the tool that creates the add-on's application pane. See createApplicationPaneTool() if you want to override or extend the add-on's application pane tool.

Returns:

the tool that creates the add-on's application pane

createPreferencesTool

protected TLcyPreferencesTool createPreferencesTool()

Creates the TLcyPreferencesTool to be used by this add-on. Overwriting this method for example allows to register additional ILcyPropertyConverters for (complex) custom properties, to make sure they are correctly decoded from the add-on's configuration file and/or saved to the workspace. Note that this isn't required for simple properties such as String, int, double, etc.

Overrides:

createPreferencesTool in class ALcyPreferencesAddOn

Returns:

the created TLcyPreferencesTool.