Package com.luciad.lucy.addons.kml22

Class TLcyKML22AddOn

java.lang.Object
com.luciad.lucy.addons.ALcyAddOn
com.luciad.lucy.addons.ALcyPreferencesAddOn
com.luciad.lucy.addons.ALcyFormatAddOn
com.luciad.lucy.addons.kml22.TLcyKML22AddOn
public class TLcyKML22AddOn extends ALcyFormatAddOn

Lucy AddOn for KML 2.2

This AddOn can decode and visualize KML 2.2. The TLcyKML22AddOn will add an application pane to Lucy that can display the model content tree of the KML models that have been added to a specific view. The model content tree can manipulate the visibility of its elements.

Time dependant data can be visualized using the TLcyKML22RealtimeAddOn.

The model content tree of KML is created with the TLcyKML22GUIFactory, a class that follows the standard ALcyGUIFactory so it can easily be overridden for customization.

The KML 2.2 AddOn can also display balloons on its features. These balloons contain HTML documents. This TLcyKML22AddOn will make use of Lucy services to notify any HyperlinkListener that has been registered using ILcyLucyEnv.addService(). If the TLcyHyperlinkAddOn has been plugged into Lucy, the TLcyKML22AddOn will use that as default behavior to load hyperlinks.

Since:
10.0

  • Constructor Details

    • TLcyKML22AddOn

      public TLcyKML22AddOn()
      Creates a new TLcyKML22AddOn.

  • Method Details

    • createFormatTool

      protected 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

    • plugInto

      public void plugInto(ILcyLucyEnv aLucyEnv)
      Description copied from class: ALcyFormatAddOn

      Creates and plugs in the add-on's format.

      Overrides:
      plugInto in class ALcyFormatAddOn
      Parameters:
      aLucyEnv - the Lucy environment to plug into
      See Also:

    • unplugFrom

      public void unplugFrom(ILcyLucyEnv aLucyEnv)
      Description copied from class: ALcyFormatAddOn
      Unplugs the add-on's format.
      Overrides:
      unplugFrom in class ALcyFormatAddOn
      Parameters:
      aLucyEnv - the Lucy environment
      See Also:

    • createApplicationPaneTool

      protected ALcyApplicationPaneTool createApplicationPaneTool()

      Creates the application pane tool responsible for the creation of the ILcyApplicationPane containing a model content tree.

      Returns:
      the application pane tool
      See Also:

    • getApplicationPaneTool

      public ALcyApplicationPaneTool getApplicationPaneTool()
      Returns the ALcyApplicationPaneTool created in createApplicationPaneTool()
      Returns:
      the ALcyApplicationPaneTool created in createApplicationPaneTool()

    • createGUIFactory

      protected ALcyGUIFactory<Component> createGUIFactory()

      Creates the ALcyGUIFactory responsible for creating all the components of the KML model content tree

      Returns:
      the GUI factory

    • getGUIFactory

      public ALcyGUIFactory<Component> getGUIFactory()
      Returns the ALcyGUIFactory created in createGUIFactory()
      Returns:
      the ALcyGUIFactory created in createGUIFactory()

    • createBaseFormat

      protected ALcyFormat createBaseFormat()
      Description copied from class: ALcyFormatAddOn

      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;
         }
       }
     }
   }
 }
      Specified by:
      createBaseFormat in class ALcyFormatAddOn
      Returns:
      a new format for this add-on

    • createFormatWrapper

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