src.gov.nasa.worldwind.symbology.IconRetriever Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwindx Show documentation
Show all versions of worldwindx Show documentation
World Wind is a collection of components that interactively display 3D geographic information within Java applications or applets.
/*
* Copyright (C) 2012 United States Government as represented by the Administrator of the
* National Aeronautics and Space Administration.
* All Rights Reserved.
*/
package gov.nasa.worldwind.symbology;
import gov.nasa.worldwind.avlist.AVList;
import java.awt.image.*;
/**
* Retrieves icons for symbols in a symbol set from a local disk or the network. Typically, an icon retriever will be
* implemented for a specific symbol set. For example, the {@link gov.nasa.worldwind.symbology.milstd2525.MilStd2525IconRetriever}
* retrieves icons for symbols in the MIL-STD-2525 symbology set. See the Icon Retriever Usage Guide for more information.
*
* @author ccrick
* @version $Id: IconRetriever.java 1171 2013-02-11 21:45:02Z dcollins $
*/
public interface IconRetriever
{
/**
* Create an icon to represent a symbol in a symbol set.
*
* @param symbolId Identifier for the symbol. The format of this identifier depends on the symbology set.
* @param params Parameters that affect icon retrieval.
*
* @return A BufferedImage containing the requested icon, or null if the icon cannot be retrieved.
*/
BufferedImage createIcon(String symbolId, AVList params);
}