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

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

All Implemented Interfaces:

GPTool

public class LayerToKML
extends AbstractGPTool

Converts an in-memory or file-based feature or raster layer into a Keyhole Markup Language (KML) file containing a translation of ESRI geometries and symbology into KML. 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 Layer 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 layer has a scale-dependent renderer and you choose an appropriate "Layer 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 Layer 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

LayerToKML()
Creates the Layer To KML tool with defaults.

LayerToKML(Object layer, Object outKmzFile, double layerOutputScale)
Creates the Layer To KML tool with the required parameters.

Method Summary

Object	getBoundaryBoxExtent() Returns the Extent to Export parameter of this tool .
int	getDpiOfClient() Returns the DPI of output image parameter of this tool .
int	getImageSize() Returns the Size of returned image (pixels) parameter of this tool .
String	getIsComposite() Returns the Return single composite image parameter of this tool .
Object	getLayer() Returns the Layer parameter of this tool .
double	getLayerOutputScale() Returns the Layer 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	setBoundaryBoxExtent(Object boundaryBoxExtent) Sets the Extent to Export parameter of this tool .
void	setDpiOfClient(int dpiOfClient) Sets the DPI of output image parameter of this tool .
void	setImageSize(int imageSize) Sets the Size of returned image (pixels) parameter of this tool .
void	setIsComposite(String isComposite) Sets the Return single composite image parameter of this tool .
void	setLayer(Object layer) Sets the Layer parameter of this tool .
void	setLayerOutputScale(double layerOutputScale) Sets the Layer 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

LayerToKML

public LayerToKML()

Creates the Layer To KML tool with defaults.

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

LayerToKML

public LayerToKML(Object layer,
                  Object outKmzFile,
                  double layerOutputScale)

Creates the Layer 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:

layer - Feature layer, the in-memory layer or layer file stored on disk that will be converted 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.

layerOutputScale - Double, the scale at which to export the in-memory layer or layer file. Any scale-dependent renderer will be observed.

Method Detail

getLayer

public Object getLayer()

Returns the Layer parameter of this tool . This parameter is Feature layer, the in-memory layer or layer file stored on disk that will be converted to KML. This is a required parameter.

Returns:

the Layer

setLayer

public void setLayer(Object layer)

Sets the Layer parameter of this tool . This parameter is Feature layer, the in-memory layer or layer file stored on disk that will be converted to KML. This is a required parameter.

Parameters:

layer - Feature layer, the in-memory layer or layer file stored on disk that will be converted 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.

getLayerOutputScale

public double getLayerOutputScale()

Returns the Layer Output Scale parameter of this tool . This parameter is Double, the scale at which to export the in-memory layer or layer file. Any scale-dependent renderer will be observed. This is a required parameter.

Returns:

the Layer Output Scale

setLayerOutputScale

public void setLayerOutputScale(double layerOutputScale)

Sets the Layer Output Scale parameter of this tool . This parameter is Double, the scale at which to export the in-memory layer or layer file. Any scale-dependent renderer will be observed. This is a required parameter.

Parameters:

layerOutputScale - Double, the scale at which to export the in-memory layer or layer file. 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 layer 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 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 layer 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 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 layer 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 will no longer be selectable.

getBoundaryBoxExtent

public Object getBoundaryBoxExtent()

Returns the Extent to Export parameter of this tool . This parameter is Extent, the extent of the output KML different than that defined by the in-memory Layer or Layer file. 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

setBoundaryBoxExtent

public void setBoundaryBoxExtent(Object boundaryBoxExtent)

Sets the Extent to Export parameter of this tool . This parameter is Extent, the extent of the output KML different than that defined by the in-memory Layer or Layer file. 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:

boundaryBoxExtent - Extent, the extent of the output KML different than that defined by the in-memory Layer or Layer file. 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, 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, defines the vertical and horizontal resolution of any rasters in the output KML document. This is an optional parameter.

Parameters:

imageSize - Long, 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