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

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

All Implemented Interfaces:

GPTool

public class Layer3DToFeatureClass
extends AbstractGPTool

This tool applies 3D properties associated with a feature layer and writes the result to a new multipatch or line feature class. The Layer 3D to Feature Class tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• For an input feature to be converted, the result must support representation as a multipatch. For example, points symbolized as 3D markers can be converted.
• Only certain 3D properties are applied, for example:
• Texture fill symbols are not supported.
• Draped layers in ArcGlobe are not supported. Due to the dynamic nature of draped surfaces, height values will not be maintained.
• If the input layer contains 3D marker symbols with restricted geometries—for example, textured multipatch—the 3D features will not be added to the output feature class.

Field Summary

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

vals

Constructor Summary

Layer3DToFeatureClass()
Creates the Layer 3D to Feature Class tool with defaults.

Layer3DToFeatureClass(Object inFeatureLayer, Object outFeatureClass)
Creates the Layer 3D to Feature Class tool with the required parameters.

Method Summary

Object	getGroupField() Returns the Grouping Field parameter of this tool .
Object	getInFeatureLayer() Returns the Input Feature Layer parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class 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	setGroupField(Object groupField) Sets the Grouping Field parameter of this tool .
void	setInFeatureLayer(Object inFeatureLayer) Sets the Input Feature Layer parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class 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

Layer3DToFeatureClass

public Layer3DToFeatureClass()

Creates the Layer 3D to Feature Class tool with defaults.

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

Layer3DToFeatureClass

public Layer3DToFeatureClass(Object inFeatureLayer,
                             Object outFeatureClass)

Creates the Layer 3D to Feature Class 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:

inFeatureLayer - the input feature layer with 3D properties.

outFeatureClass - the output multipatch feature class.

Method Detail

getInFeatureLayer

public Object getInFeatureLayer()

Returns the Input Feature Layer parameter of this tool . This parameter is the input feature layer with 3D properties. This is a required parameter.

Returns:

the Input Feature Layer

setInFeatureLayer

public void setInFeatureLayer(Object inFeatureLayer)

Sets the Input Feature Layer parameter of this tool . This parameter is the input feature layer with 3D properties. This is a required parameter.

Parameters:

inFeatureLayer - the input feature layer with 3D properties.

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.

getGroupField

public Object getGroupField()

Returns the Grouping Field parameter of this tool . This parameter is a group field is used to combine the geometry of multiple input features into individual output records. The output attribute values will be set to one of the input records. This is an optional parameter.

Returns:

the Grouping Field

setGroupField

public void setGroupField(Object groupField)

Sets the Grouping Field parameter of this tool . This parameter is a group field is used to combine the geometry of multiple input features into individual output records. The output attribute values will be set to one of the input records. This is an optional parameter.

Parameters:

groupField - a group field is used to combine the geometry of multiple input features into individual output records. The output attribute values will be set to one of the input records.

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