/**************************************************************************************************
 **
 ** $Id: GraphicIcon.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/go/display/primitive/GraphicIcon.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.primitive;

import java.awt.geom.Point2D;

import javax.swing.Icon;
import javax.units.Unit;

import org.opengis.go.display.style.PointSymbolizer;
import org.opengis.spatialschema.geometry.DirectPosition;

/**
 * The GraphicIcon defines a common abstraction for implementations that render
 * icons on a drawing surface.
 * 

* The rotation of the icon with respect to an external Coordinate Reference System is * measured positively as a clockwise angle, starting from a reference line within the * Coordinate Reference System and ending at the x-axis of the local Cartesian plane. * * @author Open GIS Consortium, Inc. * @version $Revision: 658 $, $Date: 2006-02-23 12:09:34 +1100 (jeu., 23 févr. 2006) $ */ public interface GraphicIcon extends Graphic { /** * Sets the icon represented by this GraphicIcon. * @param icon the icon to be rendered. */ public void setIcon(Icon icon); /** * Returns the icon represented by this GraphicIcon. * @return the icon to be rendered. */ public Icon getIcon(); /** * Sets the DirectPosition corresponding to the position of the icon. * @param coord the wrapper for the positon. */ public void setPosition(DirectPosition coord); /** * Returns the DirectPosition corresponding to the position of the icon. * @return the wrapper for the position of the center point. */ public DirectPosition getPosition(); /** * Sets the angle by which to rotate the icon. Use rotation to rotate * rotatable icons. For example, use the entity's course to rotate an icon * whose shape indicates the direction of the entity (e.g., top-down * view of a aircraft) Note: the actual drawing angle may differ from the * rotation angle once the GraphicIcon has been projected onto the drawing * surface. * @param angle the new rotation. * @param unit the Unit for the angle value. */ public void setRotation(double angle, Unit unit); /** * Gets the angle by which to rotate the icon. * @param unit the Unit for the angle value. * @return the rotation angle measured clockwise from the horizontal. */ public double getRotation(Unit unit); /** * Sets the location in the icon (as an offset from the upper left) that * will be drawn over the icon's position. This will also be the point * about which rotation will occur. If the offset coordinate is null, then * the icon will be centered over its position. */ public void setOffset(Point2D offset); /** * Returns the location in the icon (as an offset from the upper left) * that will be drawn over the icon's position. This is the center * of rotation as well. If the offset coordinate is null, then the icon * will be centered over its position. */ public Point2D getOffset(); /** * Returns the GraphicStyle for this GraphicIcon, * which is required to be a PointSymbolizer. * @return the GraphicIcon's GraphicStyle. */ public PointSymbolizer getPointSymbolizer(); /** * Indicates whether this primitive is displaying anchor handles that allow the * user to change the rotation of this icon. */ public boolean isAllowingRotation(); /** * Sets the boolean that indicates whether this primitive is displaying * anchor handles that allow the user to change the rotation of this icon. */ public void setAllowingRotation(boolean newValue); }

Ads help maintain this website.