com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class MapToKML

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.MapToKML

All Implemented Interfaces:

GPTool

public class MapToKML
extends AbstractGPTool

Converts a Map Document into a Keyhole Markup Language (KML) file containing a translation of ESRI geometries and symbology. This file is compressed using zip compression and will have a ".KMZ" extension and can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. The Map To KML tool is contained in the 3D Analyst Tools tool box.

Software restrictions: none

Usage tips:

• The output KMZ file cannot already exist.
• You can reduce the size of the output KMZ document if your map has scale-dependent renderers and you choose an appropriate "Map Output Scale".
• To output a single raster image draped over topography use the "Return single composite image" option.
• To output every layer as separate raster image use the "Convert Vector to Raster" option.
• The following environment settings affect this tool:
• For more information about tool options, click Show Help on the Map to KML dialog box to expand the built-in geoprocessing help system. Click Hide help to collapse it from the view.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MapToKML()
Creates the Map To KML tool with defaults.

MapToKML(Object inMapDocument, String dataFrame, Object outKmzFile, double mapOutputScale)
Creates the Map To KML tool with the required parameters.

Method Summary

String	getDataFrame() Returns the Data Frame parameter of this tool .
int	getDpiOfClient() Returns the DPI of output image parameter of this tool .
Object	getExtentToExport() Returns the Extent to Export parameter of this tool .
int	getImageSize() Returns the Size of returned image (pixels) parameter of this tool .
Object	getInMapDocument() Returns the Map Document parameter of this tool .
String	getIsComposite() Returns the Return single composite image parameter of this tool .
String	getIsVectorToRaster() Returns the Convert Vector to Raster parameter of this tool .
double	getMapOutputScale() Returns the Map Output Scale parameter of this tool .
Object	getOutKmzFile() Returns the Output File parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setDataFrame(String dataFrame) Sets the Data Frame parameter of this tool .
void	setDpiOfClient(int dpiOfClient) Sets the DPI of output image parameter of this tool .
void	setExtentToExport(Object extentToExport) Sets the Extent to Export parameter of this tool .
void	setImageSize(int imageSize) Sets the Size of returned image (pixels) parameter of this tool .
void	setInMapDocument(Object inMapDocument) Sets the Map Document parameter of this tool .
void	setIsComposite(String isComposite) Sets the Return single composite image parameter of this tool .
void	setIsVectorToRaster(String isVectorToRaster) Sets the Convert Vector to Raster parameter of this tool .
void	setMapOutputScale(double mapOutputScale) Sets the Map Output Scale parameter of this tool .
void	setOutKmzFile(Object outKmzFile) Sets the Output File parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MapToKML

public MapToKML()

Creates the Map To KML tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

MapToKML

public MapToKML(Object inMapDocument,
                String dataFrame,
                Object outKmzFile,
                double mapOutputScale)

Creates the Map To KML tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inMapDocument - Feature layer, the Map Document to convert to KML.

dataFrame - Data frame, the data frame of the Map Document to convert to KML.

outKmzFile - KML file, the KML file to write. This file is compressed and will have a ".KMZ" extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

mapOutputScale - Double, the scale at which to export the Map Document. Any scale-dependent renderer will be observed.

Method Detail

getInMapDocument

public Object getInMapDocument()

Returns the Map Document parameter of this tool . This parameter is Feature layer, the Map Document to convert to KML. This is a required parameter.

Returns:

the Map Document

setInMapDocument

public void setInMapDocument(Object inMapDocument)

Sets the Map Document parameter of this tool . This parameter is Feature layer, the Map Document to convert to KML. This is a required parameter.

Parameters:

inMapDocument - Feature layer, the Map Document to convert to KML.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is Data frame, the data frame of the Map Document to convert to KML. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is Data frame, the data frame of the Map Document to convert to KML. This is a required parameter.

Parameters:

dataFrame - Data frame, the data frame of the Map Document to convert to KML.

getOutKmzFile

public Object getOutKmzFile()

Returns the Output File parameter of this tool . This parameter is KML file, the KML file to write. This file is compressed and will have a ".KMZ" extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. This is a required parameter.

Returns:

the Output File

setOutKmzFile

public void setOutKmzFile(Object outKmzFile)

Sets the Output File parameter of this tool . This parameter is KML file, the KML file to write. This file is compressed and will have a ".KMZ" extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth. This is a required parameter.

Parameters:

outKmzFile - KML file, the KML file to write. This file is compressed and will have a ".KMZ" extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

getMapOutputScale

public double getMapOutputScale()

Returns the Map Output Scale parameter of this tool . This parameter is Double, the scale at which to export the Map Document. Any scale-dependent renderer will be observed. This is a required parameter.

Returns:

the Map Output Scale

setMapOutputScale

public void setMapOutputScale(double mapOutputScale)

Sets the Map Output Scale parameter of this tool . This parameter is Double, the scale at which to export the Map Document. Any scale-dependent renderer will be observed. This is a required parameter.

Parameters:

mapOutputScale - Double, the scale at which to export the Map Document. Any scale-dependent renderer will be observed.

getIsComposite

public String getIsComposite()

Returns the Return single composite image parameter of this tool . This parameter is String, direct the output KML file to only contain a single image that composites all the features in this map into a single raster image. The raster will be draped over terrain as a KML GroundOverlay. Select this option to reduce the size of the output KMZ file. Individual features and layers will no longer be selectable. This is an optional parameter.

Returns:

the Return single composite image

setIsComposite

public void setIsComposite(String isComposite)

Sets the Return single composite image parameter of this tool . This parameter is String, direct the output KML file to only contain a single image that composites all the features in this map into a single raster image. The raster will be draped over terrain as a KML GroundOverlay. Select this option to reduce the size of the output KMZ file. Individual features and layers will no longer be selectable. This is an optional parameter.

Parameters:

isComposite - String, direct the output KML file to only contain a single image that composites all the features in this map into a single raster image. The raster will be draped over terrain as a KML GroundOverlay. Select this option to reduce the size of the output KMZ file. Individual features and layers will no longer be selectable.

getIsVectorToRaster

public String getIsVectorToRaster()

Returns the Convert Vector to Raster parameter of this tool . This parameter is String, convert each vector layer in the map into a separate raster image in the KML output. Normal raster layers will also be added to the KML output. Each output KML raster layer will be selectable and its transparency can be adjusted in certain KML clients. This is an optional parameter.

Returns:

the Convert Vector to Raster

setIsVectorToRaster

public void setIsVectorToRaster(String isVectorToRaster)

Sets the Convert Vector to Raster parameter of this tool . This parameter is String, convert each vector layer in the map into a separate raster image in the KML output. Normal raster layers will also be added to the KML output. Each output KML raster layer will be selectable and its transparency can be adjusted in certain KML clients. This is an optional parameter.

Parameters:

isVectorToRaster - String, convert each vector layer in the map into a separate raster image in the KML output. Normal raster layers will also be added to the KML output. Each output KML raster layer will be selectable and its transparency can be adjusted in certain KML clients.

getExtentToExport

public Object getExtentToExport()

Returns the Extent to Export parameter of this tool . This parameter is Extent, choose an extent for the output KML different from that defined by the default Map Frame. Either define the extent box (in the WGS84 coordinate system) or select a layer or map document that defines an extent using the file selection button and text field. This is an optional parameter.

Returns:

the Extent to Export

setExtentToExport

public void setExtentToExport(Object extentToExport)

Sets the Extent to Export parameter of this tool . This parameter is Extent, choose an extent for the output KML different from that defined by the default Map Frame. Either define the extent box (in the WGS84 coordinate system) or select a layer or map document that defines an extent using the file selection button and text field. This is an optional parameter.

Parameters:

extentToExport - Extent, choose an extent for the output KML different from that defined by the default Map Frame. Either define the extent box (in the WGS84 coordinate system) or select a layer or map document that defines an extent using the file selection button and text field.

getImageSize

public int getImageSize()

Returns the Size of returned image (pixels) parameter of this tool . This parameter is Long, size of returned image (pixels): (optional): Defines the vertical and horizontal resolution of any rasters in the output KML document. This is an optional parameter.

Returns:

the Size of returned image (pixels)

setImageSize

public void setImageSize(int imageSize)

Sets the Size of returned image (pixels) parameter of this tool . This parameter is Long, size of returned image (pixels): (optional): Defines the vertical and horizontal resolution of any rasters in the output KML document. This is an optional parameter.

Parameters:

imageSize - Long, size of returned image (pixels): (optional): Defines the vertical and horizontal resolution of any rasters in the output KML document.

getDpiOfClient

public int getDpiOfClient()

Returns the DPI of output image parameter of this tool . This parameter is Long, define the device resolution for any rasters in the output KML document. This is an optional parameter.

Returns:

the DPI of output image

setDpiOfClient

public void setDpiOfClient(int dpiOfClient)

Sets the DPI of output image parameter of this tool . This parameter is Long, define the device resolution for any rasters in the output KML document. This is an optional parameter.

Parameters:

dpiOfClient - Long, define the device resolution for any rasters in the output KML document.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias