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

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

All Implemented Interfaces:

GPTool

public class TerrainToTin
extends AbstractGPTool

This tool converts a terrain dataset to a file-based TIN. The Terrain to TIN tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Define the extent of the output TIN using the geoprocessing environment extent setting.
• Use an extent and pyramid level that are not likely to be too large for a TIN. While the maximum size of a TIN that can be used under Win32 is between 15 to 20 million nodes, it's recommended that you cap the size at a few million. Triangulated surfaces larger than this are best represented by terrain datasets.

Field Summary

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

vals

Constructor Summary

TerrainToTin()
Creates the Terrain to TIN tool with defaults.

TerrainToTin(Object inTerrain, Object outTin)
Creates the Terrain to TIN tool with the required parameters.

Method Summary

String	getClipToExtent() Returns the Clip to Extent parameter of this tool .
Object	getInTerrain() Returns the Input Terrain parameter of this tool .
int	getMaxNodes() Returns the Maximum Number of Nodes parameter of this tool .
Object	getOutTin() Returns the Output TIN parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution 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	setClipToExtent(String clipToExtent) Sets the Clip to Extent parameter of this tool .
void	setInTerrain(Object inTerrain) Sets the Input Terrain parameter of this tool .
void	setMaxNodes(int maxNodes) Sets the Maximum Number of Nodes parameter of this tool .
void	setOutTin(Object outTin) Sets the Output TIN parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution 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

TerrainToTin

public TerrainToTin()

Creates the Terrain to TIN tool with defaults.

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

TerrainToTin

public TerrainToTin(Object inTerrain,
                    Object outTin)

Creates the Terrain to TIN 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:

inTerrain - the terrain dataset to be converted.

outTin - the TIN to be created.

Method Detail

getInTerrain

public Object getInTerrain()

Returns the Input Terrain parameter of this tool . This parameter is the terrain dataset to be converted. This is a required parameter.

Returns:

the Input Terrain

setInTerrain

public void setInTerrain(Object inTerrain)

Sets the Input Terrain parameter of this tool . This parameter is the terrain dataset to be converted. This is a required parameter.

Parameters:

inTerrain - the terrain dataset to be converted.

getOutTin

public Object getOutTin()

Returns the Output TIN parameter of this tool . This parameter is the TIN to be created. This is a required parameter.

Returns:

the Output TIN

setOutTin

public void setOutTin(Object outTin)

Sets the Output TIN parameter of this tool . This parameter is the TIN to be created. This is a required parameter.

Parameters:

outTin - the TIN to be created.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Returns:

the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the resolution of the pyramid level to use for conversion. The default is 0, full resolution.

getMaxNodes

public int getMaxNodes()

Returns the Maximum Number of Nodes parameter of this tool . This parameter is the maximum number of nodes permitted in the output TIN. The tool will return an error if the conversion properties (in other words, analysis extent and pyramid level) would produce a TIN that exceeds this size. The default is 5 million. This is an optional parameter.

Returns:

the Maximum Number of Nodes

setMaxNodes

public void setMaxNodes(int maxNodes)

Sets the Maximum Number of Nodes parameter of this tool . This parameter is the maximum number of nodes permitted in the output TIN. The tool will return an error if the conversion properties (in other words, analysis extent and pyramid level) would produce a TIN that exceeds this size. The default is 5 million. This is an optional parameter.

Parameters:

maxNodes - the maximum number of nodes permitted in the output TIN. The tool will return an error if the conversion properties (in other words, analysis extent and pyramid level) would produce a TIN that exceeds this size. The default is 5 million.

getClipToExtent

public String getClipToExtent()

Returns the Clip to Extent parameter of this tool . This parameter is performs a neatline clip on the output TIN. The analysis extent is used as the clip polygon. This only has an effect if the analysis extent is defined and it's smaller than the extent of the input terrain. This is an optional parameter.

Returns:

the Clip to Extent

setClipToExtent

public void setClipToExtent(String clipToExtent)

Sets the Clip to Extent parameter of this tool . This parameter is performs a neatline clip on the output TIN. The analysis extent is used as the clip polygon. This only has an effect if the analysis extent is defined and it's smaller than the extent of the input terrain. This is an optional parameter.

Parameters:

clipToExtent - performs a neatline clip on the output TIN. The analysis extent is used as the clip polygon. This only has an effect if the analysis extent is defined and it's smaller than the extent of the input terrain.

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