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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analyst3dtools.Intersect3D
All Implemented Interfaces:
GPTool

public class Intersect3D
extends AbstractGPTool

Computes the geometric intersection of two volumes defined by closed multipatch features, based upon the geometric intersection of their patches. Features or portions of features which overlap in the two layers and/or feature classes will be written to the Output Feature Class. The Intersect 3D tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Intersect3D()
          Creates the Intersect 3D tool with defaults.
Intersect3D(Object inFeatureClass1, Object outFeatureClass)
          Creates the Intersect 3D tool with the required parameters.
 
Method Summary
 Object getInFeatureClass1()
          Returns the Input Multipatch Features parameter of this tool .
 Object getInFeatureClass2()
          Returns the Input Multipatch Features 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 setInFeatureClass1(Object inFeatureClass1)
          Sets the Input Multipatch Features parameter of this tool .
 void setInFeatureClass2(Object inFeatureClass2)
          Sets the Input Multipatch Features 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

Intersect3D

public Intersect3D()
Creates the Intersect 3D tool with defaults.

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


Intersect3D

public Intersect3D(Object inFeatureClass1,
                   Object outFeatureClass)
Creates the Intersect 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:
inFeatureClass1 - the first set of multipatch features.
outFeatureClass - the feature class to be created where the resulting features will be written.
Method Detail

getInFeatureClass1

public Object getInFeatureClass1()
Returns the Input Multipatch Features parameter of this tool . This parameter is the first set of multipatch features. This is a required parameter.

Returns:
the Input Multipatch Features

setInFeatureClass1

public void setInFeatureClass1(Object inFeatureClass1)
Sets the Input Multipatch Features parameter of this tool . This parameter is the first set of multipatch features. This is a required parameter.

Parameters:
inFeatureClass1 - the first set of multipatch features.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the feature class to be created where the resulting features will be written. 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 feature class to be created where the resulting features will be written. This is a required parameter.

Parameters:
outFeatureClass - the feature class to be created where the resulting features will be written.

getInFeatureClass2

public Object getInFeatureClass2()
Returns the Input Multipatch Features parameter of this tool . This parameter is an optional second set of multipatch features to be intersected with the first. This is an optional parameter.

Returns:
the Input Multipatch Features

setInFeatureClass2

public void setInFeatureClass2(Object inFeatureClass2)
Sets the Input Multipatch Features parameter of this tool . This parameter is an optional second set of multipatch features to be intersected with the first. This is an optional parameter.

Parameters:
inFeatureClass2 - an optional second set of multipatch features to be intersected with the first.

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