com.esri.arcgis.geoprocessing.tools.conversiontools
Class MultipatchToCollada

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

public class MultipatchToCollada
extends AbstractGPTool

Converts one or more multipatch features into a collection of COLLADA files and referenced texture image files in an output folder. The inputs can be a layer or a feature class. The Multipatch To Collada tool is contained in the Conversion Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MultipatchToCollada()
          Creates the Multipatch To Collada tool with defaults.
MultipatchToCollada(Object inFeatures, Object outputFolder)
          Creates the Multipatch To Collada tool with the required parameters.
 
Method Summary
 Object getFieldName()
          Returns the Use Field Name parameter of this tool .
 Object getInFeatures()
          Returns the Input Multipatch Features parameter of this tool .
 Object getOutputFolder()
          Returns the Output Collada Folder parameter of this tool .
 String getPrependSource()
          Returns the Prepend Source Name 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 setFieldName(Object fieldName)
          Sets the Use Field Name parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Multipatch Features parameter of this tool .
 void setOutputFolder(Object outputFolder)
          Sets the Output Collada Folder parameter of this tool .
 void setPrependSource(String prependSource)
          Sets the Prepend Source Name 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

MultipatchToCollada

public MultipatchToCollada()
Creates the Multipatch To Collada tool with defaults.

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


MultipatchToCollada

public MultipatchToCollada(Object inFeatures,
                           Object outputFolder)
Creates the Multipatch To Collada 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 multipatch features to be exported.
outputFolder - the destination folder where the output COLLADA files and texture image files will be placed.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Multipatch Features parameter of this tool . This parameter is the multipatch features to be exported. This is a required parameter.

Returns:
the Input Multipatch Features

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Multipatch Features parameter of this tool . This parameter is the multipatch features to be exported. This is a required parameter.

Parameters:
inFeatures - the multipatch features to be exported.

getOutputFolder

public Object getOutputFolder()
Returns the Output Collada Folder parameter of this tool . This parameter is the destination folder where the output COLLADA files and texture image files will be placed. This is a required parameter.

Returns:
the Output Collada Folder

setOutputFolder

public void setOutputFolder(Object outputFolder)
Sets the Output Collada Folder parameter of this tool . This parameter is the destination folder where the output COLLADA files and texture image files will be placed. This is a required parameter.

Parameters:
outputFolder - the destination folder where the output COLLADA files and texture image files will be placed.

getPrependSource

public String getPrependSource()
Returns the Prepend Source Name parameter of this tool . This parameter is prepend the file names of the output COLLADA files with the name of the source feature layer. This is an optional parameter.

Returns:
the Prepend Source Name

setPrependSource

public void setPrependSource(String prependSource)
Sets the Prepend Source Name parameter of this tool . This parameter is prepend the file names of the output COLLADA files with the name of the source feature layer. This is an optional parameter.

Parameters:
prependSource - prepend the file names of the output COLLADA files with the name of the source feature layer.

getFieldName

public Object getFieldName()
Returns the Use Field Name parameter of this tool . This parameter is the feature attribute to use as the output COLLADA filename for each exported feature. If no field is specified, the feature's Object ID is used. This is an optional parameter.

Returns:
the Use Field Name

setFieldName

public void setFieldName(Object fieldName)
Sets the Use Field Name parameter of this tool . This parameter is the feature attribute to use as the output COLLADA filename for each exported feature. If no field is specified, the feature's Object ID is used. This is an optional parameter.

Parameters:
fieldName - the feature attribute to use as the output COLLADA filename for each exported feature. If no field is specified, the feature's Object ID is used.

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