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

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

All Implemented Interfaces:

GPTool

public class InterpolatePolyToPatch
extends AbstractGPTool

This tool creates surface-conforming areal features by extracting those portions of a TIN or terrain dataset surface that fall within the extent of input polygons as multipatches. The Interpolate Polygon to Multipatch tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Convert polygons to multipatches if you are having display problems with polygons conforming to a surface.
• The Maximum Triangle Strip Size value must be 3 or larger. The recommended range is between 128 and 2048.

Field Summary

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

vals

Constructor Summary

InterpolatePolyToPatch()
Creates the Interpolate Polygon to Multipatch tool with defaults.

InterpolatePolyToPatch(Object inSurface, Object inFeatureClass, Object outFeatureClass)
Creates the Interpolate Polygon to Multipatch tool with the required parameters.

Method Summary

String	getAreaField() Returns the Area Field parameter of this tool .
Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
int	getMaxStripSize() Returns the Maximum Strip Size parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
String	getSurfaceAreaField() Returns the Surface Area Field 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.
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setAreaField(String areaField) Sets the Area Field parameter of this tool .
void	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setMaxStripSize(int maxStripSize) Sets the Maximum Strip Size parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setSurfaceAreaField(String surfaceAreaField) Sets the Surface Area Field parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor 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

InterpolatePolyToPatch

public InterpolatePolyToPatch()

Creates the Interpolate Polygon to Multipatch tool with defaults.

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

InterpolatePolyToPatch

public InterpolatePolyToPatch(Object inSurface,
                              Object inFeatureClass,
                              Object outFeatureClass)

Creates the Interpolate Polygon to Multipatch 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:

inSurface - the input triangulated irregular network (TIN) or terrain dataset surface.

inFeatureClass - the input polygon feature class.

outFeatureClass - the output multipatch feature class.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the input triangulated irregular network (TIN) or terrain dataset surface. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is the input triangulated irregular network (TIN) or terrain dataset surface. This is a required parameter.

Parameters:

inSurface - the input triangulated irregular network (TIN) or terrain dataset surface.

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input polygon feature class. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the input polygon feature class. This is a required parameter.

Parameters:

inFeatureClass - the input polygon feature class.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output multipatch feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output multipatch feature class. This is a required parameter.

Parameters:

outFeatureClass - the output multipatch feature class.

getMaxStripSize

public int getMaxStripSize()

Returns the Maximum Strip Size parameter of this tool . This parameter is controls the maximum number of points used to create an individual triangle strip. Note that each multipatch is usually composed of multiple strips. The default value is 1,024. This is an optional parameter.

Returns:

the Maximum Strip Size

setMaxStripSize

public void setMaxStripSize(int maxStripSize)

Sets the Maximum Strip Size parameter of this tool . This parameter is controls the maximum number of points used to create an individual triangle strip. Note that each multipatch is usually composed of multiple strips. The default value is 1,024. This is an optional parameter.

Parameters:

maxStripSize - controls the maximum number of points used to create an individual triangle strip. Note that each multipatch is usually composed of multiple strips. The default value is 1,024.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor by which the heights of the resultant multipatch will be determined from those of the input polygons. Used to convert z-units to x- and y-units. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is the factor by which the heights of the resultant multipatch will be determined from those of the input polygons. Used to convert z-units to x- and y-units. This is an optional parameter.

Parameters:

zFactor - the factor by which the heights of the resultant multipatch will be determined from those of the input polygons. Used to convert z-units to x- and y-units.

getAreaField

public String getAreaField()

Returns the Area Field parameter of this tool . This parameter is the name of the output field containing the planimetric, or 2D, area of the resulting multipatches. This is an optional parameter.

Returns:

the Area Field

setAreaField

public void setAreaField(String areaField)

Sets the Area Field parameter of this tool . This parameter is the name of the output field containing the planimetric, or 2D, area of the resulting multipatches. This is an optional parameter.

Parameters:

areaField - the name of the output field containing the planimetric, or 2D, area of the resulting multipatches.

getSurfaceAreaField

public String getSurfaceAreaField()

Returns the Surface Area Field parameter of this tool . This parameter is the name of the output field containing the 3D area of the resulting multipatches. This area takes the surface undulations into consideration and is always larger than the planimetric area unless the surface is flat, in which case the two are equal. This is an optional parameter.

Returns:

the Surface Area Field

setSurfaceAreaField

public void setSurfaceAreaField(String surfaceAreaField)

Sets the Surface Area Field parameter of this tool . This parameter is the name of the output field containing the 3D area of the resulting multipatches. This area takes the surface undulations into consideration and is always larger than the planimetric area unless the surface is flat, in which case the two are equal. This is an optional parameter.

Parameters:

surfaceAreaField - the name of the output field containing the 3D area of the resulting multipatches. This area takes the surface undulations into consideration and is always larger than the planimetric area unless the surface is flat, in which case the two are equal.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the pyramid-level resolution of the terrain dataset to use for interpolation. 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 pyramid-level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution. This is an optional parameter.

Parameters:

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

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