Package com.luciad.lucy.addons.map

Class TLcyMapRotationAddOn

java.lang.Object
com.luciad.lucy.addons.ALcyAddOn
com.luciad.lucy.addons.map.TLcyMapRotationAddOn
public class TLcyMapRotationAddOn extends ALcyAddOn
Adds a menu item that opens a panel that allows to manually rotate the map. Also adds a menu item to add a compass icon to a map, indicating the north.

The application pane can be programmatically activated using setApplicationPaneActive(boolean).

  • Field Details

    • MAP_ROTATION_GROUP_DESCRIPTOR

      public static final TLcyGroupDescriptor MAP_ROTATION_GROUP_DESCRIPTOR

  • Constructor Details

    • TLcyMapRotationAddOn

      public TLcyMapRotationAddOn()

  • Method Details

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

    • isApplicationPaneActive

      public boolean isApplicationPaneActive()
      Returns true if the ILcyApplicationPane is currently active, false otherwise.
      Returns:
      true if the ILcyApplicationPane is currently active, false otherwise.
      See Also:

    • setApplicationPaneActive

      public void setApplicationPaneActive(boolean aActive)
      Sets the active state of the map rotation ILcyApplicationPane. Active means the ILcyApplicationPane is present in the user interface.

      Note that loading a workspace can change this property.

      Parameters:
      aActive - True to make sure the ILcyApplicationPane is present in the user interface, false to make sure the ILcyApplicationPane is not present.

    • getMapComponentArray

      public ILcyMapComponent[] getMapComponentArray()
      Retrieve the array of map components on which the map rotation panel works.
      Returns:
      A list of map components, null if there are no map components on the map rotation panel.

    • setMapComponentArray

      public void setMapComponentArray(ILcyMapComponent[] aMapComponentArray)
      Set the list of ILcyMapComponents on which the map rotation panel should work. If there is only one object in this list, no ComboBox will be displayed.
      Parameters:
      aMapComponentArray - Array of map components.

    • getSize

      public Dimension getSize()

    • setSize

      public void setSize(Dimension aSize)

    • isDisplayArrow

      public boolean isDisplayArrow()

    • setDisplayArrow

      public void setDisplayArrow(boolean aDisplayArrow)

    • is4SideArrow

      public boolean is4SideArrow()

    • set4SideArrow

      public void set4SideArrow(boolean a4SideArrow)

    • isOpaque

      public boolean isOpaque()

    • setOpaque

      public void setOpaque(boolean aOpaque)

    • getCompassFillColor

      public Color getCompassFillColor()

    • setCompassFillColor

      public void setCompassFillColor(Color aCompassFillColor)

    • getArrowColor

      public Color getArrowColor()

    • setArrowColor

      public void setArrowColor(Color aArrowColor)

    • getArrowColorShadow

      public Color getArrowColorShadow()

    • setArrowColorShadow

      public void setArrowColorShadow(Color aArrowColorShadow)

    • getNorthArrowColor

      public Color getNorthArrowColor()

    • setNorthArrowColor

      public void setNorthArrowColor(Color aArrowColor)

    • getNorthArrowColorShadow

      public Color getNorthArrowColorShadow()

    • setNorthArrowColorShadow

      public void setNorthArrowColorShadow(Color aArrowColorShadow)

    • getLineColor

      public Color getLineColor()

    • setLineColor

      public void setLineColor(Color aLineColor)

    • isClassTraceOn

      @Deprecated public static boolean isClassTraceOn()
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Returns true if tracing is enabled for this class.
      Returns:
      true if tracing is enabled for this class, false otherwise.

    • setClassTraceOn

      @Deprecated public static void setClassTraceOn(boolean aClassTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
      Parameters:
      aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.