com.esri.arcgis.analyst3d
Class VRMLExporter

java.lang.Object
  com.esri.arcgis.analyst3d.VRMLExporter

All Implemented Interfaces:

ISceneExporter3d, IVRMLExporter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class VRMLExporter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISceneExporter3d, IVRMLExporter

An exporter to VRML format.

Remarks

As of ArcGIS 9.3, VRMLExporter requires a Scene object, which contains the SceneGraph object that cannot be constructed without a Window. This means that the VRMLExport coclass can only be used on a desktop program, not a server program.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

VRMLExporter()
Constructs a VRMLExporter using ArcGIS Engine.

VRMLExporter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
VRMLExporter theVRMLExporter = (VRMLExporter) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
void	exportScene(IScene pScene) Exports the scene.
static String	getClsid() getClsid.
String	getExportFileName() The exported file name.
String	getFileExtension() The file extension associated with the current exporter.
String	getFilter() The filter string used in the CFileDialog class.
String	getName() The name of the exporter.
int	getQuality() The quality of textures when exported to JPEG (1-100).
int	hashCode() the hashcode for this object
boolean	isIndentation() Indicates if VRML text is indented.
boolean	isMoveToOrigin() Indicates if the origin of the coordinate system is in the middle of the scene.
boolean	isSaveOnlyVisible() Indicates if only the visible items are saved.
boolean	isUseElevationGrid() Indicates if an elevation grid is used to save raster surfaces.
boolean	isUseGeoVRML() Indicates if the GeoVRML Extension is used.
boolean	isYUp() Indicates if the scene's y-axis is used as the exporter's up direction.
void	setExportFileName(String fileName) The exported file name.
void	setIndentation(boolean pIndentation) Indicates if VRML text is indented.
void	setIsYUp(boolean pIsYUp) Indicates if the scene's y-axis is used as the exporter's up direction.
void	setMoveToOrigin(boolean pbMoveToOrigin) Indicates if the origin of the coordinate system is in the middle of the scene.
void	setQuality(int quality) The quality of textures when exported to JPEG (1-100).
void	setSaveOnlyVisible(boolean pSaveOnlyVisible) Indicates if only the visible items are saved.
void	setUseElevationGrid(boolean pbUseElevationGrid) Indicates if an elevation grid is used to save raster surfaces.
void	setUseGeoVRML(boolean pbUseGeoVRML) Indicates if the GeoVRML Extension is used.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

VRMLExporter

public VRMLExporter()
             throws IOException,
                    UnknownHostException

Constructs a VRMLExporter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

VRMLExporter

public VRMLExporter(Object obj)
             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
VRMLExporter theVRMLExporter = (VRMLExporter) obj;

Construct a VRMLExporter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to VRMLExporter.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ISceneExporter3d

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

The filter string used in the CFileDialog class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface ISceneExporter3d

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileExtension

public String getFileExtension()
                        throws IOException,
                               AutomationException

The file extension associated with the current exporter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFileExtension in interface ISceneExporter3d

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(String fileName)
                       throws IOException,
                              AutomationException

The exported file name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExportFileName in interface ISceneExporter3d

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportFileName

public String getExportFileName()
                         throws IOException,
                                AutomationException

The exported file name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExportFileName in interface ISceneExporter3d

Returns:

The fileName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportScene

public void exportScene(IScene pScene)
                 throws IOException,
                        AutomationException

Exports the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

exportScene in interface ISceneExporter3d

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndentation

public void setIndentation(boolean pIndentation)
                    throws IOException,
                           AutomationException

Indicates if VRML text is indented.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIndentation in interface IVRMLExporter

Parameters:

pIndentation - The pIndentation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIndentation

public boolean isIndentation()
                      throws IOException,
                             AutomationException

Indicates if VRML text is indented.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIndentation in interface IVRMLExporter

Returns:

The pIndentation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveOnlyVisible

public void setSaveOnlyVisible(boolean pSaveOnlyVisible)
                        throws IOException,
                               AutomationException

Indicates if only the visible items are saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSaveOnlyVisible in interface IVRMLExporter

Parameters:

pSaveOnlyVisible - The pSaveOnlyVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveOnlyVisible

public boolean isSaveOnlyVisible()
                          throws IOException,
                                 AutomationException

Indicates if only the visible items are saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSaveOnlyVisible in interface IVRMLExporter

Returns:

The pSaveOnlyVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsYUp

public void setIsYUp(boolean pIsYUp)
              throws IOException,
                     AutomationException

Indicates if the scene's y-axis is used as the exporter's up direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsYUp in interface IVRMLExporter

Parameters:

pIsYUp - The pIsYUp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isYUp

public boolean isYUp()
              throws IOException,
                     AutomationException

Indicates if the scene's y-axis is used as the exporter's up direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isYUp in interface IVRMLExporter

Returns:

The pIsYUp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMoveToOrigin

public void setMoveToOrigin(boolean pbMoveToOrigin)
                     throws IOException,
                            AutomationException

Indicates if the origin of the coordinate system is in the middle of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMoveToOrigin in interface IVRMLExporter

Parameters:

pbMoveToOrigin - The pbMoveToOrigin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMoveToOrigin

public boolean isMoveToOrigin()
                       throws IOException,
                              AutomationException

Indicates if the origin of the coordinate system is in the middle of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMoveToOrigin in interface IVRMLExporter

Returns:

The pbMoveToOrigin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGeoVRML

public void setUseGeoVRML(boolean pbUseGeoVRML)
                   throws IOException,
                          AutomationException

Indicates if the GeoVRML Extension is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseGeoVRML in interface IVRMLExporter

Parameters:

pbUseGeoVRML - The pbUseGeoVRML (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGeoVRML

public boolean isUseGeoVRML()
                     throws IOException,
                            AutomationException

Indicates if the GeoVRML Extension is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseGeoVRML in interface IVRMLExporter

Returns:

The pbUseGeoVRML

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseElevationGrid

public void setUseElevationGrid(boolean pbUseElevationGrid)
                         throws IOException,
                                AutomationException

Indicates if an elevation grid is used to save raster surfaces.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseElevationGrid in interface IVRMLExporter

Parameters:

pbUseElevationGrid - The pbUseElevationGrid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseElevationGrid

public boolean isUseElevationGrid()
                           throws IOException,
                                  AutomationException

Indicates if an elevation grid is used to save raster surfaces.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseElevationGrid in interface IVRMLExporter

Returns:

The pbUseElevationGrid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQuality

public void setQuality(int quality)
                throws IOException,
                       AutomationException

The quality of textures when exported to JPEG (1-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setQuality in interface IVRMLExporter

Parameters:

quality - The quality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQuality

public int getQuality()
               throws IOException,
                      AutomationException

The quality of textures when exported to JPEG (1-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getQuality in interface IVRMLExporter

Returns:

The quality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.