Package adams.flow.sink.openstreetmapviewer

Class ImageMapOverlay

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class ImageMapOverlay
extends AbstractPositionableMapOverlay
    Overlays the map with an icon obtained from a file. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -enabled <boolean> (property: enabled)
    If enabled, the overlay gets painted.
    default: true
 
    -x <int> (property: x)
    The X position of the overlay (>=0: absolute, -1: left, -2: center, -3: 
    right).
    default: -3
    minimum: -3
 
    -y <int> (property: y)
    The Y position of the overlay (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 
    -image-file <adams.core.io.PlaceholderFile> (property: imageFile)
    The image file to overlay.
    default: ${CWD}
 
    -scale <double> (property: scale)
    The scaling factor for the image; 1.0 = actual size of image.
    default: 1.0
    minimum: 0.0
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ImageFile

        protected adams.core.io.PlaceholderFile m_ImageFile
        the image file to load.

      • m_Image

        protected transient ImageIcon m_Image
        the image to paint.

      • m_Scale

        protected double m_Scale
        the scaling factor.

    • Constructor Detail

      • ImageMapOverlay

        public ImageMapOverlay()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class AbstractPositionableMapOverlay

      • setImageFile

        public void setImageFile​(adams.core.io.PlaceholderFile value)
        Sets the image file to overlay.
        Parameters:
        value - the file

      • getImageFile

        public adams.core.io.PlaceholderFile getImageFile()
        Returns the image file to overlay.
        Returns:
        the file

      • imageFileTipText

        public String imageFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setScale

        public void setScale​(double value)
        Sets the scaling factor (1.0 = actual image size).
        Parameters:
        value - the scaling factor

      • getScale

        public double getScale()
        Returns the scaling factor (1.0 = actual image size).
        Returns:
        the scaling factor

      • scaleTipText

        public String scaleTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.