com.esri.arcgis.arcglobe
Class IGMxApplicationProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.arcglobe.IGMxApplicationProxy

All Implemented Interfaces:

IGMxApplication, Externalizable, Serializable

public class IGMxApplicationProxy
extends com.esri.arcgis.interop.Dispatch
implements IGMxApplication, Serializable

Provides access to members that control the ArcGlobe Application object.

Description

The IGMxApplication interface contains methods/properties to customize the ArGlobe desktop application and allows you to manipulate ArcGlobe application specific properties and methods, such as create a new secondary viewer, setting the default background sky color, making the TOC visible, copying to clipboard and exporting the current display to 2D images. In order to change the sky background color, DefaultHighBackgroundColor and DefaultLowBackgroundColor can be used to change the color of the background color when at a higher and lower altitudes, respectively. For specifying the low and high altitudes of the transition distance within which the sky background color changes from default low background color to default high background color, the SetDefaultBackGroundTransitionDistances can be used.

To create a secondary viewer for viewing data in a different perspective, the CreateSubView method is used. The ShowTOC method and TOCVisible boolean property can be used to the show/hide the Table of Contents dockable window. SetDefaultContentsView can be used to set the default TOC view to the current ative Table of Contents view.

Inorder to clear/suspend/restore animated gestrues with the Navigation tool in ArcGlobe, you can use the ClearGesture, SuspendGesture, RestoreGesture methods.

Remarks

Obtain a reference to IGMxApplication through any object that supports IApplication. In ArcGlobe, IGMxApplication is implemented by the Application CoClass.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

See Also:

IApplication, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGMxApplicationProxy()
	IGMxApplicationProxy(Object obj)
protected	IGMxApplicationProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	clearGesture() Clears gesture.
void	copyToClipboard() Copies the current scene to the Clipboard.
void	createSubView() Makes a new viewer.
void	export2d() Exports the Current Document to a 2d file format.
void	export3d() Exports the Current Document to a 3d file format.
String	getBuildNum() The build number.
void	getDefaultBackgroundTransitionDistances(float[] lowAltitude, float[] highAltitude) The Default Background Transition Distances for New Documents.
IRgbColor	getDefaultHighBackgroundColor() The Default High Background Color for New Documents.
IRgbColor	getDefaultLowBackgroundColor() The Default Low Background Color for New Documents.
IPage	getPage() The current page settings.
IPaper	getPaper() The current paper settings.
IPrinter	getPrinter() The current printer settings.
ISelectionEnvironment	getSelectionEnvironment() The selection environment.
boolean	isTOCVisible() Indicates if the TOC is visible.
void	removeListener(String iidStr, Object theListener)
void	restoreGesture() Restores gesture.
void	setDefaultBackgroundTransitionDistances(float lowAltitude, float highAltitude) The Default Background Transition Distances for New Documents.
void	setDefaultContentsViews() Set current TOC configuration as defaults in Normal.3dt.
void	setDefaultHighBackgroundColor(IRgbColor ppRgbColor) The Default High Background Color for New Documents.
void	setDefaultLowBackgroundColor(IRgbColor ppRgbColor) The Default Low Background Color for New Documents.
void	setPrinterByRef(IPrinter printer) The current printer settings.
void	showContextMenu(int x, int y) Displays a context menu for the current selection.
void	showTOC(boolean bShow) Displays the table content.
void	suspendGesture() Suspends gesture.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGMxApplicationProxy

public IGMxApplicationProxy()

IGMxApplicationProxy

public IGMxApplicationProxy(Object obj)
                     throws IOException

Throws:

IOException

IGMxApplicationProxy

protected IGMxApplicationProxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

showContextMenu

public void showContextMenu(int x,
                            int y)
                     throws IOException,
                            AutomationException

Displays a context menu for the current selection.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

showContextMenu in interface IGMxApplication

Parameters:

x - The x (in)

y - The y (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTOCVisible

public boolean isTOCVisible()
                     throws IOException,
                            AutomationException

Indicates if the TOC is visible.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

isTOCVisible in interface IGMxApplication

Returns:

The bVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showTOC

public void showTOC(boolean bShow)
             throws IOException,
                    AutomationException

Displays the table content.

Remarks

The ShowTOC method allows you to show/hide the Table of Contents (TOC) dockable window. The state of the TOC is applied to the current and new globe documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

showTOC in interface IGMxApplication

Parameters:

bShow - The bShow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSubView

public void createSubView()
                   throws IOException,
                          AutomationException

Makes a new viewer.

Remarks

Similar to the main viewer, secondary viewers allow you to display the data in perspective,which is independent from the perspective of the main viewer. This helps in viewing the same data from different directions.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

createSubView in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

export2d

public void export2d()
              throws IOException,
                     AutomationException

Exports the Current Document to a 2d file format.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

export2d in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

export3d

public void export3d()
              throws IOException,
                     AutomationException

Exports the Current Document to a 3d file format.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

export3d in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copyToClipboard

public void copyToClipboard()
                     throws IOException,
                            AutomationException

Copies the current scene to the Clipboard.

Remarks

This method copies the ArcGlobe document to the system clipboard so that it can be copied into other applications. For example, after copying a document to the clipboard, you can paste it into a Word document. The type of object pasted is ESRI ArcGlobe Document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

copyToClipboard in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrinterByRef

public void setPrinterByRef(IPrinter printer)
                     throws IOException,
                            AutomationException

The current printer settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

setPrinterByRef in interface IGMxApplication

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrinter

public IPrinter getPrinter()
                    throws IOException,
                           AutomationException

The current printer settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getPrinter in interface IGMxApplication

Returns:

A reference to a com.esri.arcgis.output.IPrinter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaper

public IPaper getPaper()
                throws IOException,
                       AutomationException

The current paper settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getPaper in interface IGMxApplication

Returns:

A reference to a com.esri.arcgis.output.IPaper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPage

public IPage getPage()
              throws IOException,
                     AutomationException

The current page settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getPage in interface IGMxApplication

Returns:

A reference to a com.esri.arcgis.carto.IPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionEnvironment

public ISelectionEnvironment getSelectionEnvironment()
                                              throws IOException,
                                                     AutomationException

The selection environment.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getSelectionEnvironment in interface IGMxApplication

Returns:

A reference to a com.esri.arcgis.carto.ISelectionEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultHighBackgroundColor

public IRgbColor getDefaultHighBackgroundColor()
                                        throws IOException,
                                               AutomationException

The Default High Background Color for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getDefaultHighBackgroundColor in interface IGMxApplication

Returns:

A reference to a com.esri.arcgis.display.IRgbColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultHighBackgroundColor

public void setDefaultHighBackgroundColor(IRgbColor ppRgbColor)
                                   throws IOException,
                                          AutomationException

The Default High Background Color for New Documents.

Remarks

This property allows you to change the sky background color when viewing the globe at high altitudes. The altitude, upto which this background color is visible, can be set using IGMxAppilcation::SetDefaultBackGroundTransitionDistances method.

By default, the default high background color is set to black. Changing the default high color is reflected in new documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setDefaultHighBackgroundColor in interface IGMxApplication

Parameters:

ppRgbColor - A reference to a com.esri.arcgis.display.IRgbColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultLowBackgroundColor

public IRgbColor getDefaultLowBackgroundColor()
                                       throws IOException,
                                              AutomationException

The Default Low Background Color for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getDefaultLowBackgroundColor in interface IGMxApplication

Returns:

A reference to a com.esri.arcgis.display.IRgbColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultLowBackgroundColor

public void setDefaultLowBackgroundColor(IRgbColor ppRgbColor)
                                  throws IOException,
                                         AutomationException

The Default Low Background Color for New Documents.

Remarks

This property allows you to change the sky background color when viewing the globe at low altitude. The altitude, upto which this background color is visible, can be set using IGMxAppilcation::SetDefaultBackGroundTransitionDistances method.

By default, the default low background color is set to sky blue. Changing the default low color is reflected in new documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setDefaultLowBackgroundColor in interface IGMxApplication

Parameters:

ppRgbColor - A reference to a com.esri.arcgis.display.IRgbColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultBackgroundTransitionDistances

public void getDefaultBackgroundTransitionDistances(float[] lowAltitude,
                                                    float[] highAltitude)
                                             throws IOException,
                                                    AutomationException

The Default Background Transition Distances for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getDefaultBackgroundTransitionDistances in interface IGMxApplication

Parameters:

lowAltitude - The lowAltitude (out: use single element array)

highAltitude - The highAltitude (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultBackgroundTransitionDistances

public void setDefaultBackgroundTransitionDistances(float lowAltitude,
                                                    float highAltitude)
                                             throws IOException,
                                                    AutomationException

The Default Background Transition Distances for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setDefaultBackgroundTransitionDistances in interface IGMxApplication

Parameters:

lowAltitude - The lowAltitude (in)

highAltitude - The highAltitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearGesture

public void clearGesture()
                  throws IOException,
                         AutomationException

Clears gesture.

Remarks

ClearGesture clears/disables the animated rotation gesture. This is similar to hitting the Escape key to stop the animated rotation with the Navaigate tool.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

clearGesture in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

suspendGesture

public void suspendGesture()
                    throws IOException,
                           AutomationException

Suspends gesture.

Remarks

SuspendGesture suspends the animated rotation gesture. This method allows you to suspend the animated rotation (enabled with the Navigate tool) when a different tool such as the Fly tool is chosen.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

suspendGesture in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreGesture

public void restoreGesture()
                    throws IOException,
                           AutomationException

Restores gesture.

Description

RestoreGesture restores the animated rotation gesture. This method allows you to restore the animated rotation when the Navigate tool is chosen after a different tool such as the Fly tool was chosen.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

restoreGesture in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBuildNum

public String getBuildNum()
                   throws IOException,
                          AutomationException

The build number.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

getBuildNum in interface IGMxApplication

Returns:

The pBuildNum

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultContentsViews

public void setDefaultContentsViews()
                             throws IOException,
                                    AutomationException

Set current TOC configuration as defaults in Normal.3dt.

Remarks

SetDefaultContentsView sets the TOC view of new ArcGlobe documents to be the TOC view of the current ArcGlobe document. ArcGlobe supports three TOC views - Display (esriArcGlobe::TOCGMxDisplayView), Source (esriArcGlobe::TOCGMxCatalogView), and Type (esriArcGlobe::TOCGMxTypeView ). Only one contents view can be active at a time.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:

setDefaultContentsViews in interface IGMxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.