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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• COLLADA files are an XML representation of a 3D object that can reference additional image files that act as textures draped onto the 3D geometry. This means that exporting a multipatch feature to COLLADA can result in the creation of several files—a .dae file containing the XML representation of the 3D object and one or more image files (for example, a .jpg or .png file) that contain the textures.
• This tool creates one COLLADA representation for each multipatch feature that it exports. The tool uses a field value from each feature—by default this is the Object ID—to define the output filenames. This allows easier identification of which feature was exported to which COLLADA file and also provides the methodology for defining unique names when exporting multiple features to the same directory. Texture files are stored in an images subdirectory, below the COLLADA file.
• This tool automatically overwrites any existing COLLADA files with the same filename. When this happens, a warning message is given stating which files were overwritten with a new file during the export process. A GP message is also generated for any features that fail to export—for example, if the output location is read-only, or the disk is full.
• To ensure a new COLLADA file is created for all the exported multipatch features, set the destination directory to an empty or new folder and choose a filename field that is unique for each feature. Exporting two features with the same attribute value will result in the second exported feature overwriting the COLLADA file of the first.
• When iteratively updating a multipatch feature by exporting it to COLLADA and making changes outside of ArcGIS, export the feature to the same location each time. This will keep a single file on disk for that feature, representing the most up-to-date state of the 3D object.

Field Summary

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

vals

Constructor Summary

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

MultipatchToCollada(java.lang.Object inFeatures, java.lang.Object outputFolder)
Creates the Multipatch To Collada tool with the required parameters.

Method Summary

java.lang.Object	getFieldName() Returns the Use Field Name parameter of this tool .
java.lang.Object	getInFeatures() Returns the Input Multipatch Features parameter of this tool .
java.lang.Object	getOutputFolder() Returns the Output Collada Folder parameter of this tool .
java.lang.String	getPrependSource() Returns the Prepend Source Name parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setFieldName(java.lang.Object fieldName) Sets the Use Field Name parameter of this tool .
void	setInFeatures(java.lang.Object inFeatures) Sets the Input Multipatch Features parameter of this tool .
void	setOutputFolder(java.lang.Object outputFolder) Sets the Output Collada Folder parameter of this tool .
void	setPrependSource(java.lang.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(java.lang.Object inFeatures,
                           java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias