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

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

All Implemented Interfaces:

GPTool

public class Union3D
extends AbstractGPTool

Computes the geometric intersection of the patches of overlapping multipatches, then aggregates the multipatches together. How many features are created as output depends on the tool's settings. The Union 3D tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Input feature class or layer must have multipatch geometry.
• Only closed multipatches will be processed. All other multipatches will be skipped, and an error written to the geoprocessing log. Use the Is Closed geoprocessing tool to see if any features are not closed.
• Union 3D can create very large and complex features in the output feature class. These features may cause display problems and/or have poor performance when displayed. Use caution when deciding how many features to aggregate together.
• The output feature class will not have any of the attributes on the input feature class. An optional table can be created recording which features where unioned together to create a new feature.
• Union 3D is a 3D set operator as part of the 3D Features toolset. See for more information on what set operators are and how to use them.

Field Summary

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

vals

Constructor Summary

Union3D()
Creates the Union 3D tool with defaults.

Union3D(Object inFeatureClass, Object outFeatureClass)
Creates the Union 3D tool with the required parameters.

Method Summary

String	getDisableOptimization() Returns the Disable Optimization parameter of this tool .
Object	getGroupField() Returns the Grouping Field parameter of this tool .
Object	getInFeatureClass() Returns the Input Multipatch Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getOutputAll() Returns the Output All Solids parameter of this tool .
Object	getOutTable() Returns the Output Table 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	setDisableOptimization(String disableOptimization) Sets the Disable Optimization parameter of this tool .
void	setGroupField(Object groupField) Sets the Grouping Field parameter of this tool .
void	setInFeatureClass(Object inFeatureClass) Sets the Input Multipatch Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutputAll(String outputAll) Sets the Output All Solids parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table 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

Union3D

public Union3D()

Creates the Union 3D tool with defaults.

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

Union3D

public Union3D(Object inFeatureClass,
               Object outFeatureClass)

Creates the Union 3D 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:

inFeatureClass - the closed multipatch features to be intersected and aggregated.

outFeatureClass - the multipatch feature class into which the aggregated multipatch(es) will be placed.

Method Detail

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Multipatch Features parameter of this tool . This parameter is the closed multipatch features to be intersected and aggregated. This is a required parameter.

Returns:

the Input Multipatch Features

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Multipatch Features parameter of this tool . This parameter is the closed multipatch features to be intersected and aggregated. This is a required parameter.

Parameters:

inFeatureClass - the closed multipatch features to be intersected and aggregated.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the multipatch feature class into which the aggregated multipatch(es) will be placed. 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 multipatch feature class into which the aggregated multipatch(es) will be placed. This is a required parameter.

Parameters:

outFeatureClass - the multipatch feature class into which the aggregated multipatch(es) will be placed.

getGroupField

public Object getGroupField()

Returns the Grouping Field parameter of this tool . This parameter is the field used to group input multipatch features together for aggregation. 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 the field used to group input multipatch features together for aggregation. This is an optional parameter.

Parameters:

groupField - the field used to group input multipatch features together for aggregation.

getDisableOptimization

public String getDisableOptimization()

Returns the Disable Optimization parameter of this tool . This parameter is disables the optimization that automatically determines which multipatch features overlap, and only unions those features with overlaps. This is an optional parameter.

Returns:

the Disable Optimization

setDisableOptimization

public void setDisableOptimization(String disableOptimization)

Sets the Disable Optimization parameter of this tool . This parameter is disables the optimization that automatically determines which multipatch features overlap, and only unions those features with overlaps. This is an optional parameter.

Parameters:

disableOptimization - disables the optimization that automatically determines which multipatch features overlap, and only unions those features with overlaps.

getOutputAll

public String getOutputAll()

Returns the Output All Solids parameter of this tool . This parameter is this option forces the tool to write out all input features as output features. Features that have no overlaps are written to the output unmodified. Overlapping features are unioned together, and then written to the output. This is an optional parameter.

Returns:

the Output All Solids

setOutputAll

public void setOutputAll(String outputAll)

Sets the Output All Solids parameter of this tool . This parameter is this option forces the tool to write out all input features as output features. Features that have no overlaps are written to the output unmodified. Overlapping features are unioned together, and then written to the output. This is an optional parameter.

Parameters:

outputAll - this option forces the tool to write out all input features as output features. Features that have no overlaps are written to the output unmodified. Overlapping features are unioned together, and then written to the output.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is a many to one table representing the Input Features and the Output Features that they where aggregated in to. This is an optional parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(Object outTable)

Sets the Output Table parameter of this tool . This parameter is a many to one table representing the Input Features and the Output Features that they where aggregated in to. This is an optional parameter.

Parameters:

outTable - a many to one table representing the Input Features and the Output Features that they where aggregated in to.

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