gov/nasa/worldwind/render/UserFacingIcon.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind.render;
   8
   9 import gov.nasa.worldwind.Movable;
  10 import gov.nasa.worldwind.avlist.AVListImpl;
  11 import gov.nasa.worldwind.geom.Position;
  12 import gov.nasa.worldwind.util.Logging;
  13
  14 import java.awt.*;
  15
  16 /**
  17  * @author tag
  18  * @version $Id$
  19  */
  20 public class UserFacingIcon extends AVListImpl implements WWIcon, Movable
  21 {
  22     //    private final String iconPath;
  23     private Position iconPosition; // may be null because placement may be relative
  24     private Dimension iconSize; // may be null to indicate "use native image size"
  25     private boolean isHighlighted = false;
  26     private boolean isVisible = true;
  27     private double highlightScale = 1.2; // TODO: make configurable
  28     private String toolTipText;
  29     private Font toolTipFont;
  30     private boolean showToolTip = false;
  31     private java.awt.Color textColor;
  32     private Object imageSource;
  33
  34     public UserFacingIcon(String iconPath, Position iconPosition)
  35     {
  36         if (iconPath == null)
  37         {
  38             String message = Logging.getMessage("nullValue.IconFilePath");
  39             Logging.logger().severe(message);
  40             throw new IllegalArgumentException(message);
  41         }
  42
  43         this.imageSource = iconPath;
  44         this.iconPosition = iconPosition;
  45     }
  46
  47     public UserFacingIcon(Object imageSource, Position iconPosition)
  48     {
  49         if (imageSource == null)
  50         {
  51             String message = Logging.getMessage("nullValue.IconFilePath");
  52             Logging.logger().severe(message);
  53             throw new IllegalArgumentException(message);
  54         }
  55
  56         this.imageSource = imageSource;
  57         this.iconPosition = iconPosition;
  58     }
  59
  60     public Object getImageSource()
  61     {
  62         return imageSource;
  63     }
  64
  65     public void setImageSource(Object imageSource)
  66     {
  67         this.imageSource = imageSource;
  68     }
  69
  70     public String getPath()
  71     {
  72         return this.imageSource instanceof String ? (String) this.imageSource : null;
  73     }
  74
  75     public Position getPosition()
  76     {
  77         return this.iconPosition;
  78     }
  79
  80     public void setPosition(Position iconPosition)
  81     {
  82         this.iconPosition = iconPosition;
  83     }
  84
  85     public boolean isHighlighted()
  86     {
  87         return isHighlighted;
  88     }
  89
  90     public void setHighlighted(boolean highlighted)
  91     {
  92         isHighlighted = highlighted;
  93     }
  94
  95     public double getHighlightScale()
  96     {
  97         return highlightScale;
  98     }
  99
 100     public void setHighlightScale(double highlightScale)
 101     {
 102         this.highlightScale = highlightScale;
 103     }
 104
 105     public Dimension getSize()
 106     {
 107         return this.iconSize;
 108     }
 109
 110     public void setSize(Dimension size)
 111     {
 112         this.iconSize = size;
 113     }
 114
 115     public boolean isVisible()
 116     {
 117         return isVisible;
 118     }
 119
 120     public void setVisible(boolean visible)
 121     {
 122         isVisible = visible;
 123     }
 124
 125     public String getToolTipText()
 126     {
 127         return toolTipText;
 128     }
 129
 130     public void setToolTipText(String toolTipText)
 131     {
 132         this.toolTipText = toolTipText;
 133     }
 134
 135     public Font getToolTipFont()
 136     {
 137         return toolTipFont;
 138     }
 139
 140     public void setToolTipFont(Font toolTipFont)
 141     {
 142         this.toolTipFont = toolTipFont;
 143     }
 144
 145     public boolean isShowToolTip()
 146     {
 147         return showToolTip;
 148     }
 149
 150     public void setShowToolTip(boolean showToolTip)
 151     {
 152         this.showToolTip = showToolTip;
 153     }
 154
 155     public Color getToolTipTextColor()
 156     {
 157         return textColor;
 158     }
 159
 160     public void setToolTipTextColor(Color textColor)
 161     {
 162         this.textColor = textColor;
 163     }
 164
 165     public void move(Position position)
 166     {
 167         if (position == null)
 168         {
 169             String msg = Logging.getMessage("nullValue.PositionIsNull");
 170             Logging.logger().severe(msg);
 171             throw new IllegalArgumentException(msg);
 172         }
 173
 174         this.iconPosition = this.iconPosition.add(position);
 175     }
 176
 177     public void moveTo(Position position)
 178     {
 179         if (position == null)
 180         {
 181             String msg = Logging.getMessage("nullValue.PositionIsNull");
 182             Logging.logger().severe(msg);
 183             throw new IllegalArgumentException(msg);
 184         }
 185
 186         this.iconPosition = position;
 187     }
 188
 189     public Position getReferencePosition()
 190     {
 191         return this.iconPosition;
 192     }
 193
 194     public String toString()
 195     {
 196         return this.imageSource != null ? this.imageSource.toString() : this.getClass().getName();
 197     }
 198 }