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

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

All Implemented Interfaces:

GPTool

public class RemoveTerrainPoints
extends AbstractGPTool

This tool removes points within an area of interest from one or more embedded feature classes. The Remove Terrain Points tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• This tool functions only on feature classes embedded in a terrain. The terrain and at least one embedded feature class must already exist.
• A rectangular area of interest (AOI) is required. This defines the area in the embedded feature class where multipoint vertices will be deleted. If a multipoint crosses the AOI boundary, only those vertices within the boundary will be deleted.
• Remove Terrain Points looks for an existing edit session to piggyback on. This supports undo if the edit session was initialized to support undo (for example, using Editor inside ArcMap). If there's no edit session, it starts and stops one itself, in which case there is no chance for an undo.
• To use this tool on a terrain inside an ArcSDE database, the terrain needs to be registered as versioned. You do this by registering the feature dataset the terrain resides in as versioned.
• Removing points from an embedded feature class will invalidate the terrain. Run after adding points.

Field Summary

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

vals

Constructor Summary

RemoveTerrainPoints()
Creates the Remove Terrain Points tool with defaults.

RemoveTerrainPoints(Object inTerrain, Object dataSource, Object aoiExtents)
Creates the Remove Terrain Points tool with the required parameters.

Method Summary

Object	getAoiExtents() Returns the Area of Interest parameter of this tool .
Object	getDataSource() Returns the Input Terrain Data Source parameter of this tool .
Object	getDerivedOutTerrain() Returns the Output Terrain parameter of this tool (Read only).
Object	getInTerrain() Returns the Input Terrain 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	setAoiExtents(Object aoiExtents) Sets the Area of Interest parameter of this tool .
void	setDataSource(Object dataSource) Sets the Input Terrain Data Source parameter of this tool .
void	setInTerrain(Object inTerrain) Sets the Input Terrain 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

RemoveTerrainPoints

public RemoveTerrainPoints()

Creates the Remove Terrain Points tool with defaults.

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

RemoveTerrainPoints

public RemoveTerrainPoints(Object inTerrain,
                           Object dataSource,
                           Object aoiExtents)

Creates the Remove Terrain Points 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 modified

dataSource - one or more embedded feature classes from which points will be removed

aoiExtents - the XY extent defining the area from which points will be removed

Method Detail

getInTerrain

public Object getInTerrain()

Returns the Input Terrain parameter of this tool . This parameter is the terrain dataset to be modified 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 modified This is a required parameter.

Parameters:

inTerrain - the terrain dataset to be modified

getDataSource

public Object getDataSource()

Returns the Input Terrain Data Source parameter of this tool . This parameter is one or more embedded feature classes from which points will be removed This is a required parameter.

Returns:

the Input Terrain Data Source

setDataSource

public void setDataSource(Object dataSource)

Sets the Input Terrain Data Source parameter of this tool . This parameter is one or more embedded feature classes from which points will be removed This is a required parameter.

Parameters:

dataSource - one or more embedded feature classes from which points will be removed

getAoiExtents

public Object getAoiExtents()

Returns the Area of Interest parameter of this tool . This parameter is the XY extent defining the area from which points will be removed This is a required parameter.

Returns:

the Area of Interest

setAoiExtents

public void setAoiExtents(Object aoiExtents)

Sets the Area of Interest parameter of this tool . This parameter is the XY extent defining the area from which points will be removed This is a required parameter.

Parameters:

aoiExtents - the XY extent defining the area from which points will be removed

getDerivedOutTerrain

public Object getDerivedOutTerrain()

Returns the Output Terrain parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output 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