public class TLcyViewshedAddOn extends ALcyFormatAddOn
The getViewshedBackEnd()
performs the actual calculation. It can be used independently of the used
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 Terrain Analysis Engine component.
TLcyViewshedBackEnd
,
TLcyViewshedGUIFactory
,
TLcyPreferencesTool.getCompositeWorkspacePreferences()
Modifier and Type | Field and Description |
---|---|
static String |
AREA_BOUNDS_LIST_KEY
Property name for the available viewshed area bounds.
|
static String |
AUTO_UPDATE_KEY
Determines whether GUI changes should be automatically propagated to the layer and start a viewshed
calculation.
|
static boolean |
AUTO_UPDATE_VALUE_DEFAULT
The default value of the auto update property.
|
static String |
EYEPOINT_LIST_KEY
Property name for the available viewshed eyepoints.
|
static String |
LINKED_LAYER_KEY
The
ILcdGXYLayer that is linked to the GUI panel. |
static ILcdGXYLayer |
LINKED_LAYER_VALUE_DEFAULT
Default value for the property
LINKED_LAYER_KEY . |
static String |
QUALITY_DESCRIPTIONS_KEY
Property name for descriptions of the predefined quality levels to choose from.
|
static String[] |
QUALITY_DESCRIPTIONS_VALUE_DEFAULT
Default value for the
QUALITY_DESCRIPTIONS_KEY property. |
static String |
QUALITY_ITEMS_KEY
Property name for predefined quality levels to choose from.
|
static double[] |
QUALITY_ITEMS_VALUE_DEFAULT
Default value for the
QUALITY_ITEMS_KEY property. |
static String |
QUALITY_KEY
Quality property for calculations, expressed in meters per discretization step.
|
static double |
QUALITY_VALUE_DEFAULT
Default value for the
QUALITY_KEY property. |
static String |
SELECTED_AREA_BOUNDS_KEY
Property name for the currently selected area bounds.
|
static String |
SELECTED_EYEPOINT_KEY
Property name for the currently selected eyepoint.
|
Constructor and Description |
---|
TLcyViewshedAddOn()
Default constructor for the viewshed add-on.
|
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.
|
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 TLcyPreferencesTool |
createPreferencesTool()
Creates the
TLcyPreferencesTool to be used by this add-on. |
protected TLcyViewshedBackEnd |
createViewshedBackEnd()
Returns a new back-end for viewshed calculations.
|
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.
|
TLcyViewshedBackEnd |
getViewshedBackEnd()
The back-end that the GUI can use for performing viewshed calculations.
|
void |
plugInto(ILcyLucyEnv aLucyEnv)
Builds a GUI, back-end and file format for viewshed and plugs in the GUI and file format.
|
void |
unplugFrom(ILcyLucyEnv aLucyEnv)
Unplugs the add-on's format, preferences tool and application pane tool.
|
createFormatTool, getFormat
getLongPrefix, getLucyEnv, getPreferences, getPreferencesTool, getShortPrefix
getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName
public static final String EYEPOINT_LIST_KEY
SELECTED_EYEPOINT_KEY
public static final String SELECTED_EYEPOINT_KEY
TLcyViewshedAddOn
.public static final String AREA_BOUNDS_LIST_KEY
SELECTED_AREA_BOUNDS_KEY
public static final String SELECTED_AREA_BOUNDS_KEY
TLcyViewshedAddOn
.public static final String LINKED_LAYER_KEY
ILcdGXYLayer
that is linked to the GUI panel. This value is automatically set when selecting
a viewshed layer in the active map's layer panel.
The corresponding property value is of type ILcdGXYLayer
public static final ILcdGXYLayer LINKED_LAYER_VALUE_DEFAULT
LINKED_LAYER_KEY
.public static final String QUALITY_KEY
public static final double QUALITY_VALUE_DEFAULT
QUALITY_KEY
property.public static final String QUALITY_ITEMS_KEY
public static final double[] QUALITY_ITEMS_VALUE_DEFAULT
QUALITY_ITEMS_KEY
property.public static final String QUALITY_DESCRIPTIONS_KEY
public static final String[] QUALITY_DESCRIPTIONS_VALUE_DEFAULT
QUALITY_DESCRIPTIONS_KEY
property.public static final String AUTO_UPDATE_KEY
public static final boolean AUTO_UPDATE_VALUE_DEFAULT
public TLcyViewshedAddOn()
public void plugInto(ILcyLucyEnv aLucyEnv)
aLucyEnv
- the Lucy instance to plug intoALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)
public TLcyViewshedBackEnd getViewshedBackEnd()
Override createViewshedBackEnd()
to extend the back-end.
TLcyViewshedBackEnd
object for performing viewshed calculationscreateViewshedBackEnd()
,
TLcyViewshedBackEnd
protected TLcyViewshedBackEnd createViewshedBackEnd()
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.
public final ALcyFormat createFormatWrapper(ALcyFormat aBaseFormat)
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).
createFormatWrapper
in class ALcyFormatAddOn
aBaseFormat
- the base format to wrapALcyFormatWrapper
protected ALcyGUIFactory<Component> createGUIFactory()
For example, this add-on could return a new instance of TLcyViewshedGUIFactory
protected ALcyApplicationPaneTool createApplicationPaneTool()
This add-on's application pane tool initializes the GUI factory with the add-on's composite workspace preferences. It also ensures that the panel is updated from the selected TEA layer's stored GUI properties.
TLcyViewshedGUIFactory.UPDATE_LAYER_ACTION
public ALcyGUIFactory<T> getGUIFactory()
createGUIFactory()
if you want to override or extend the add-on's factory.public ALcyApplicationPaneTool getApplicationPaneTool()
createApplicationPaneTool()
if you want to override or extend the add-on's application pane tool.public void unplugFrom(ILcyLucyEnv aLucyEnv)
unplugFrom
in class ALcyFormatAddOn
aLucyEnv
- the Lucy environmentALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)
protected TLcyPreferencesTool createPreferencesTool()
TLcyPreferencesTool
to be used by this add-on. Overwriting this method
for example allows to register additional ILcyPropertyConverter
s 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.createPreferencesTool
in class ALcyPreferencesAddOn
TLcyPreferencesTool
.