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

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

All Implemented Interfaces:

GPTool

public class TinTriangle
extends AbstractGPTool

This tool extracts triangles as polygons from an input TIN into an output feature class and produces a polygon feature class whose polygons are constructed from the input TIN's triangles. The TIN Triangle tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Slope and aspect are calculated based on the plane defined for each triangle.
• If the TIN has triangle tag values, you can specify an output field that will be added to the output feature class to contain these values.

Field Summary

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

vals

Constructor Summary

TinTriangle()
Creates the TIN Triangle tool with defaults.

TinTriangle(Object inTin, Object outFeatureClass)
Creates the TIN Triangle tool with the required parameters.

Method Summary

String	getHillshade() Returns the HILLSHADE azimuth, altitude parameter of this tool .
Object	getInTin() Returns the Input TIN parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getTagField() Returns the Tag Value 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.
String	getUnits() Returns the Slope Units parameter of this tool .
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setHillshade(String hillshade) Sets the HILLSHADE azimuth, altitude parameter of this tool .
void	setInTin(Object inTin) Sets the Input TIN parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setTagField(String tagField) Sets the Tag Value Field parameter of this tool .
void	setUnits(String units) Sets the Slope Units 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

TinTriangle

public TinTriangle()

Creates the TIN Triangle tool with defaults.

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

TinTriangle

public TinTriangle(Object inTin,
                   Object outFeatureClass)

Creates the TIN Triangle 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 - the input TIN.

outFeatureClass - the output feature class.

Method Detail

getInTin

public Object getInTin()

Returns the Input TIN parameter of this tool . This parameter is 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 the input TIN. This is a required parameter.

Parameters:

inTin - the input TIN.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output 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 feature class. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getUnits

public String getUnits()

Returns the Slope Units parameter of this tool . This parameter is the units of measure to be used in calculating the slope. By default, the units will be degrees. This is an optional parameter.

Returns:

the Slope Units

setUnits

public void setUnits(String units)

Sets the Slope Units parameter of this tool . This parameter is the units of measure to be used in calculating the slope. By default, the units will be degrees. This is an optional parameter.

Parameters:

units - the units of measure to be used in calculating the slope. By default, the units will be degrees.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor applied to the triangle slope calculation to convert the TIN's z-units to its x- and y-units. By default, the Z factor is 1. 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 applied to the triangle slope calculation to convert the TIN's z-units to its x- and y-units. By default, the Z factor is 1. This is an optional parameter.

Parameters:

zFactor - the factor applied to the triangle slope calculation to convert the TIN's z-units to its x- and y-units. By default, the Z factor is 1.

getHillshade

public String getHillshade()

Returns the HILLSHADE azimuth, altitude parameter of this tool . This parameter is provides hillshading for the feature class and sets the light source's. This is an optional parameter.

Returns:

the HILLSHADE azimuth, altitude

setHillshade

public void setHillshade(String hillshade)

Sets the HILLSHADE azimuth, altitude parameter of this tool . This parameter is provides hillshading for the feature class and sets the light source's. This is an optional parameter.

Parameters:

hillshade - provides hillshading for the feature class and sets the light source's.

getTagField

public String getTagField()

Returns the Tag Value Field parameter of this tool . This parameter is the output tag value field name into which the triangle tags will be placed. This is an optional parameter.

Returns:

the Tag Value Field

setTagField

public void setTagField(String tagField)

Sets the Tag Value Field parameter of this tool . This parameter is the output tag value field name into which the triangle tags will be placed. This is an optional parameter.

Parameters:

tagField - the output tag value field name into which the triangle tags will be placed.

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