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

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

All Implemented Interfaces:

GPTool

public class FeatureTo3DByAttribute
extends AbstractGPTool

Adds a height dimension based on one or two attributes. The height (z-value) of the shape of each feature in the input feature class is set to the value found in the user-specified height field in that feature class. The Feature to 3D By Attribute tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Supports points, multipoints, lines, and polygon geometries.
• If the shape of the feature is a line or a polygon, every vertex will be assigned the same z-value if one field is used.
• With lines, you can optionally provide a second height field. When using two height fields, each line will start at the first height and end at the second (sloped). The heights for any intermediate vertices will be interpolated between the two endpoints.

Field Summary

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

vals

Constructor Summary

FeatureTo3DByAttribute()
Creates the Feature to 3D By Attribute tool with defaults.

FeatureTo3DByAttribute(Object inFeatures, Object outFeatureClass, Object heightField)
Creates the Feature to 3D By Attribute tool with the required parameters.

Method Summary

Object	getHeightField() Returns the Height Field parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getToHeightField() Returns the To Height 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.
void	setHeightField(Object heightField) Sets the Height Field parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setToHeightField(Object toHeightField) Sets the To Height Field 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

FeatureTo3DByAttribute

public FeatureTo3DByAttribute()

Creates the Feature to 3D By Attribute tool with defaults.

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

FeatureTo3DByAttribute

public FeatureTo3DByAttribute(Object inFeatures,
                              Object outFeatureClass,
                              Object heightField)

Creates the Feature to 3D By Attribute 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:

inFeatures - the input feature class for which z information will be found in the attribute table.

outFeatureClass - the output feature class.

heightField - the height field found in the attribute table.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature class for which z information will be found in the attribute table. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input feature class for which z information will be found in the attribute table. This is a required parameter.

Parameters:

inFeatures - the input feature class for which z information will be found in the attribute table.

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.

getHeightField

public Object getHeightField()

Returns the Height Field parameter of this tool . This parameter is the height field found in the attribute table. This is a required parameter.

Returns:

the Height Field

setHeightField

public void setHeightField(Object heightField)

Sets the Height Field parameter of this tool . This parameter is the height field found in the attribute table. This is a required parameter.

Parameters:

heightField - the height field found in the attribute table.

getToHeightField

public Object getToHeightField()

Returns the To Height Field parameter of this tool . This parameter is an optional second height field used for lines. When using two height fields, each line will start at the first height and end at the second (sloped). This is an optional parameter.

Returns:

the To Height Field

setToHeightField

public void setToHeightField(Object toHeightField)

Sets the To Height Field parameter of this tool . This parameter is an optional second height field used for lines. When using two height fields, each line will start at the first height and end at the second (sloped). This is an optional parameter.

Parameters:

toHeightField - an optional second height field used for lines. When using two height fields, each line will start at the first height and end at the second (sloped).

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