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

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

All Implemented Interfaces:

GPTool

public class Difference3D
extends AbstractGPTool

Computes the geometric intersection of two volumes defined by closed multipatch features, based upon the geometric intersection of their patches. Subtracts all the volumes of one feature class from the other and writes the result to a new output feature class. The Difference 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 3D geoprocessing tool to see if any features are not closed.
• The output feature class will not have any of the attributes of the input feature class. If necessary, you can use spatial join to reconnect the attributes from the original input features.
• Difference 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

Difference3D()
Creates the Difference 3D tool with defaults.

Difference3D(Object inFeaturesMinuend, Object inFeaturesSubtrahend, Object outFeatureClass)
Creates the Difference 3D tool with the required parameters.

Method Summary

Object	getInFeaturesMinuend() Returns the Input Multipatch Features to be Subtracted from parameter of this tool .
Object	getInFeaturesSubtrahend() Returns the Input Multipatch Features to be Subtracted 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	setInFeaturesMinuend(Object inFeaturesMinuend) Sets the Input Multipatch Features to be Subtracted from parameter of this tool .
void	setInFeaturesSubtrahend(Object inFeaturesSubtrahend) Sets the Input Multipatch Features to be Subtracted 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

Difference3D

public Difference3D()

Creates the Difference 3D tool with defaults.

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

Difference3D

public Difference3D(Object inFeaturesMinuend,
                    Object inFeaturesSubtrahend,
                    Object outFeatureClass)

Creates the Difference 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:

inFeaturesMinuend - the collection of multipatch features from which the subtrahend multipatch features will be removed.

inFeaturesSubtrahend - the collection of multipatch features which will be subtracted from the minuend multipatch features.

outFeatureClass - the multipatch feature class into which the newly generated multipatches will be placed.

Method Detail

getInFeaturesMinuend

public Object getInFeaturesMinuend()

Returns the Input Multipatch Features to be Subtracted from parameter of this tool . This parameter is the collection of multipatch features from which the subtrahend multipatch features will be removed. This is a required parameter.

Returns:

the Input Multipatch Features to be Subtracted from

setInFeaturesMinuend

public void setInFeaturesMinuend(Object inFeaturesMinuend)

Sets the Input Multipatch Features to be Subtracted from parameter of this tool . This parameter is the collection of multipatch features from which the subtrahend multipatch features will be removed. This is a required parameter.

Parameters:

inFeaturesMinuend - the collection of multipatch features from which the subtrahend multipatch features will be removed.

getInFeaturesSubtrahend

public Object getInFeaturesSubtrahend()

Returns the Input Multipatch Features to be Subtracted parameter of this tool . This parameter is the collection of multipatch features which will be subtracted from the minuend multipatch features. This is a required parameter.

Returns:

the Input Multipatch Features to be Subtracted

setInFeaturesSubtrahend

public void setInFeaturesSubtrahend(Object inFeaturesSubtrahend)

Sets the Input Multipatch Features to be Subtracted parameter of this tool . This parameter is the collection of multipatch features which will be subtracted from the minuend multipatch features. This is a required parameter.

Parameters:

inFeaturesSubtrahend - the collection of multipatch features which will be subtracted from the minuend multipatch features.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - the multipatch feature class into which the newly generated multipatches 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