com.esri.arcgis.arcscene
Interface ISxApplication

All Superinterfaces:
Serializable
All Known Implementing Classes:
Application, ISxApplicationProxy

public interface ISxApplication
extends Serializable

Provides access to members that control the ArcScene Application object.

Remarks

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

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.


Method Summary
 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.
 IRgbColor getDefaultBackgroundColor()
          The Default 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 restoreGesture()
          Restores gesture.
 void setDefaultBackgroundColor(IRgbColor ppRgbColor)
          The Default 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.
 

Method Detail

showContextMenu

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

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

boolean isTOCVisible()
                     throws IOException,
                            AutomationException
Indicates if the TOC is visible.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Returns:
The bVisible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showTOC

void showTOC(boolean bShow)
             throws IOException,
                    AutomationException
Displays the table content.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:
bShow - The bShow (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSubView

void createSubView()
                   throws IOException,
                          AutomationException
Makes a new viewer.

Description

This member creates a secondary viewer that, while associated with the ArcScene application, displays in its own separate window. The viewer supports ISceneViewer and has its own camera so that perspective can be controlled independently of the primary viewer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

export2d

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

export3d

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copyToClipboard

void copyToClipboard()
                     throws IOException,
                            AutomationException
Copies the current scene to the Clipboard.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrinterByRef

void setPrinterByRef(IPrinter printer)
                     throws IOException,
                            AutomationException
The current printer settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

IPrinter getPrinter()
                    throws IOException,
                           AutomationException
The current printer settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

IPaper getPaper()
                throws IOException,
                       AutomationException
The current paper settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

IPage getPage()
              throws IOException,
                     AutomationException
The current page settings.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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

ISelectionEnvironment getSelectionEnvironment()
                                              throws IOException,
                                                     AutomationException
The selection environment.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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.

getDefaultBackgroundColor

IRgbColor getDefaultBackgroundColor()
                                    throws IOException,
                                           AutomationException
The Default Background Color for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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.

setDefaultBackgroundColor

void setDefaultBackgroundColor(IRgbColor ppRgbColor)
                               throws IOException,
                                      AutomationException
The Default Background Color for New Documents.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

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.

clearGesture

void clearGesture()
                  throws IOException,
                         AutomationException
Clears gesture.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

suspendGesture

void suspendGesture()
                    throws IOException,
                           AutomationException
Suspends gesture.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreGesture

void restoreGesture()
                    throws IOException,
                           AutomationException
Restores gesture.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.