Package com.luciad.lucy.addons.map

Class TLcyMapOverviewAddOn

java.lang.Object
com.luciad.lucy.addons.ALcyAddOn
com.luciad.lucy.addons.map.TLcyMapOverviewAddOn
public class TLcyMapOverviewAddOn extends ALcyAddOn
Lucy add-on that provides an overview map. Multiple slave views can be added to one overview. Programmatic access to the overviews is possible by using getOverviewMapManager()

This addon will try to load the data specified in the config file on newly created the overviews. It therefore needs the necessary model decoders and layer factories, registered by the various data decoder addons. This addon assumes that those are already added to the lucy environment. For instance, if you want to load shp files on your overview, you might want to plug the ALcyDefaultDecodersAddOn before this one.

Note that when the state of this addon is restored by loading some workspace, the above mentioned data will only be loaded to newly created overviews, the overviews defined in the workspace are restored as they were saved.

  • Field Details

  • Constructor Details

    • TLcyMapOverviewAddOn

      public TLcyMapOverviewAddOn()

  • Method Details

    • getMapComponentFactory

      public ALcyMapComponentFactory getMapComponentFactory()
      Get the factory used to create the overview map component.
      Returns:
      factory used to create the overview map component.

    • setMapComponentFactory

      public void setMapComponentFactory(ALcyMapComponentFactory aMapComponentFactory)

      Set the factory used to create the overview map component.

      This setter has to be called before plugInto() is invoked to have any effect. If no factory is set, or it is set to null, the default factory will be used.

      To make your own overview map component, extend TLcyMapComponentFactory or TLcyMapOverviewComponentFactory (will already create an overview and the necessary controllers).

      Parameters:
      aMapComponentFactory - The factory.
      See Also:

    • plugInto

      public void plugInto(ILcyLucyEnv aLucyEnv)
      Description copied from class: ALcyAddOn
      Plugs this addon into the given lucy environment. It is in the implementation of this method that the addon adds its functionality to the Lucy backend.
      Specified by:
      plugInto in class ALcyAddOn
      Parameters:
      aLucyEnv - The lucy environment to plug into.
      See Also:

    • unplugFrom

      public void unplugFrom(ILcyLucyEnv aLucyEnv)
      Description copied from class: ALcyAddOn
      Unplugs this addon from the given Lucy environment. It removes the functionality previously added to the Lucy backend.
      Specified by:
      unplugFrom in class ALcyAddOn
      Parameters:
      aLucyEnv - The lucy environment to unplug from.
      See Also:

    • getOverviewMapManager

      public ILcyMapManager getOverviewMapManager()
      Returns the map manager containing the map overviews. Where ILcyLucyEnv.getMapManager() returns the manager containing all standard maps, this map manager only contains the map overviews. This allows programmatic access to the map overviews, to for example add some custom data.
      Returns:
      The map manager containing the map overviews.