Package com.luciad.lucy.addons.tea.visibility

Class TLcyVisibilityAddOn

java.lang.Object
com.luciad.lucy.addons.ALcyAddOn
com.luciad.lucy.addons.ALcyPreferencesAddOn
com.luciad.lucy.addons.ALcyFormatAddOn
com.luciad.lucy.addons.tea.visibility.TLcyVisibilityAddOn
public class TLcyVisibilityAddOn extends ALcyFormatAddOn
Add-on to calculate visibility between domain objects and visualize the results on a GXY map.

For visibility calculations on a Lightspeed map, refer to TLcyShapeVisibilityAddOn and TLcyLspShapeVisibilityFormatAddOn.

The back-end 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.

See Also:

  • Field Details

  • Constructor Details

    • TLcyVisibilityAddOn

      public TLcyVisibilityAddOn()
      Default constructor for the visibility add-on.

  • Method Details

    • plugInto

      public void plugInto(ILcyLucyEnv aLucyEnv)
      Builds a GUI, back-end and file format for visibility calculations and plugs in the GUI and file format.
      Parameters:
      aLucyEnv - the Lucy instance to plug into
      See Also:

    • getVisibilityBackEnd

      public TLcyVisibilityBackEnd getVisibilityBackEnd()
      The back-end that the GUI can use for performing visibility calculations.

      Override createVisibilityBackEnd() to extend the back-end.

      Returns:
      a TLcyVisibilityBackEnd object for performing visibility calculations
      See Also:

    • createVisibilityBackEnd

      protected TLcyVisibilityBackEnd createVisibilityBackEnd()
      Returns a new back-end for visibility calculations. Override this method to extend the default back-end with new functionality.
      Returns:
      a new back-end for extreme point calculations

    • 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 TLcyVisibilityGUIFactory

      Returns:
      a new GUI factory for this add-on

    • 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

    • 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:

    • 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. It also ensures that the panel is updated from the selected TEA layer's stored GUI properties.

      Returns:
      the add-on's application pane tool
      See Also:

    • getGUIFactory

      public ALcyGUIFactory<Component> 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

    • unplugFrom

      public void unplugFrom(ILcyLucyEnv aLucyEnv)
      Unplugs the add-on's format, preferences tool and application pane tool.
      Overrides:
      unplugFrom in class ALcyFormatAddOn
      Parameters:
      aLucyEnv - the Lucy environment
      See Also:

    • 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.