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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analyst3dtools.InterpolatePolyToPatch
All Implemented Interfaces:
GPTool

public class InterpolatePolyToPatch
extends AbstractGPTool

Creates surface-conforming areal features by extracting those portions of a surface that fall within the extent of input polygons as multipatches. The attributes from the input features are copied to the output. Planimetric and surface area is calculated for each feature and added as attribution to the output. The Interpolate Polygon to Multipatch tool is contained in the 3D Analyst Tools tool box.
Learn more about how Interpolate Polygon To Multipatch (3D Analyst) works

Software restrictions: none

Usage tips:


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 inTin, 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 getInTin()
          Returns the Input TIN 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 .
 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 setInTin(Object inTin)
          Sets the Input TIN 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 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 inTin,
                              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:
inTin - Tin Layer, the input TIN.
inFeatureClass - Feature Layer, the input polygon feature class.
outFeatureClass - Feature Class, the output multipatch feature class.
Method Detail

getInTin

public Object getInTin()
Returns the Input TIN parameter of this tool . This parameter is Tin Layer, the input TIN. This is a required parameter.

Returns:
the Input TIN

setInTin

public void setInTin(Object inTin)
Sets the Input TIN parameter of this tool . This parameter is Tin Layer, the input TIN. This is a required parameter.

Parameters:
inTin - Tin Layer, the input TIN.

getInFeatureClass

public Object getInFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, 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 Feature Layer, the input polygon feature class. This is a required parameter.

Parameters:
inFeatureClass - Feature Layer, the input polygon feature class.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, 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 Feature Class, the output multipatch feature class. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the output multipatch feature class.

getMaxStripSize

public int getMaxStripSize()
Returns the Maximum Strip Size parameter of this tool . This parameter is Long, 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 Long, 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 - Long, 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 Double, the factor by which the heights of the resultant multipatch will be multiplied 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 Double, the factor by which the heights of the resultant multipatch will be multiplied from those of the input polygons. Used to convert z units to x and y units. This is an optional parameter.

Parameters:
zFactor - Double, the factor by which the heights of the resultant multipatch will be multiplied 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 String, the name of the output field containing the planimetric, or 2-D, 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 String, the name of the output field containing the planimetric, or 2-D, area of the resulting multipatches. This is an optional parameter.

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

getSurfaceAreaField

public String getSurfaceAreaField()
Returns the Surface Area Field parameter of this tool . This parameter is String, the name of the output field containing the 3-D 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 String, the name of the output field containing the 3-D 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 - String, the name of the output field containing the 3-D 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.

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