Interface IIcon

All Superinterfaces:
java.io.Serializable

public interface IIcon
extends java.io.Serializable
The representation of an icon shown on the map.
Author:
swong
  • Method Summary

    Modifier and Type Method Description
    java.awt.geom.Point2D getAnchor()
    The position at which to anchor an image in correspondence to the location of the marker on the map.
    java.awt.geom.Point2D getLabelOrigin()
    The origin of the label relative to the top-left corner of the icon image, if a label is supplied by the marker.
    java.awt.geom.Point2D getOrigin()
    The position of the image within a sprite, if any.
    java.awt.Dimension getScaledSize()
    The size of the entire image after scaling, if any.
    java.awt.Dimension getSize()
    The display size of the sprite or image.
    java.lang.String getURL()
    The URL of the image or sprite sheet.
  • Method Details

    • getAnchor

      java.awt.geom.Point2D getAnchor()
      The position at which to anchor an image in correspondence to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image.
      Returns:
      The anchor location
    • getLabelOrigin

      java.awt.geom.Point2D getLabelOrigin()
      The origin of the label relative to the top-left corner of the icon image, if a label is supplied by the marker. By default, the origin is located in the center point of the image.
      Returns:
      The label origin
    • getOrigin

      java.awt.geom.Point2D getOrigin()
      The position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image (0, 0).
      Returns:
      The origin of the image
    • getScaledSize

      java.awt.Dimension getScaledSize()
      The size of the entire image after scaling, if any. Use this property to stretch/shrink an image or a sprite.
      Returns:
      The scaled size of the image
    • getSize

      java.awt.Dimension getSize()
      The display size of the sprite or image. When using sprites, you must specify the sprite size. If the size is not provided, it will be set when the image loads.
      Returns:
      the size of the entity
    • getURL

      java.lang.String getURL()
      The URL of the image or sprite sheet.
      Returns:
      The URL the source of the image or sprite.