com.esri.arcgis.controls
Interface IOrbitalFlyTool

All Superinterfaces:

Serializable

All Known Implementing Classes:

ControlsGlobeOrbitalFlyTool

public interface IOrbitalFlyTool
extends Serializable

Provides access to properties of the ControlsGlobeOrbitalFlyTool.

Description

The IOrbitalFlyTool interface controls the properties of the ControlsGlobeOrbitalFlyTool.

Product Availability

Available with ArcGIS Engine.

Method Summary

void	flyToolOnly(boolean bFlyOnly) Suppresses the pivot and zoom functionality.
void	getDefaultPos(int[] left, int[] top) The default position of the tool panel.
boolean	isFixedLineOfSight() Indicates if the line of sight between the observer and target is fixed.
boolean	isStopAtSurface() Indicates if the fly tool stops at the globe surface.
void	setDefaultPos(int left, int top) The default position of the tool panel.
void	setFixedLineOfSight(boolean bBool) Indicates if the line of sight between the observer and target is fixed.
void	setStopAtSurface(boolean bBool) Indicates if the fly tool stops at the globe surface.

Method Detail

setFixedLineOfSight

void setFixedLineOfSight(boolean bBool)
                         throws IOException,
                                AutomationException

Indicates if the line of sight between the observer and target is fixed.

Product Availability

Available with ArcGIS Engine.

Parameters:

bBool - The bBool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedLineOfSight

boolean isFixedLineOfSight()
                           throws IOException,
                                  AutomationException

Indicates if the line of sight between the observer and target is fixed.

Description

Indicates whether the IGlobeCamera observer location moves around the IGlobeCamera target location when the ControlsGlobeOrbitalFlyTool is used. By default FixedLineOfSight is false.

For example, if FixedLineOfSight is true, panning up or down or turning sideways forces the observer location to rotate around the target location. If FixedLineOfSight is false, the target location is rotated around the observer location.

Product Availability

Available with ArcGIS Engine.

Returns:

The bBool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopAtSurface

void setStopAtSurface(boolean bBool)
                      throws IOException,
                             AutomationException

Indicates if the fly tool stops at the globe surface.

Product Availability

Available with ArcGIS Engine.

Parameters:

bBool - The bBool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStopAtSurface

boolean isStopAtSurface()
                        throws IOException,
                               AutomationException

Indicates if the fly tool stops at the globe surface.

Description

Indicates whether the IGlobeCamera observer location can go under the surface of the globe when the ControlsGlobeOrbitalFlyTool is used for pivoting and zooming. By default StopAtSurface is false.

Product Availability

Available with ArcGIS Engine.

Returns:

The bBool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultPos

void setDefaultPos(int left,
                   int top)
                   throws IOException,
                          AutomationException

The default position of the tool panel.

Description

Set the default position in screen coordinates of the ControlsGlobeOrbitalFlyTool navigation panel. Passing left as -1 and top as -1, will display the navigation panel positioned to the top left of the IGlobeViewer object the ControlsGlobeOrbitalFlyTool is working with.

Product Availability

Available with ArcGIS Engine.

Parameters:

left - The left (in)

top - The top (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultPos

void getDefaultPos(int[] left,
                   int[] top)
                   throws IOException,
                          AutomationException

The default position of the tool panel.

Description

The default position in screen coordinates of the ControlsGlobeOrbitalFlyTool navigation panel. By default left is -1 and top is -1, indicating the navigation panel will display positioned to the top left of the IGlobeViewer object the ControlsGlobeOrbitalFlyTool is working with.

Product Availability

Available with ArcGIS Engine.

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flyToolOnly

void flyToolOnly(boolean bFlyOnly)
                 throws IOException,
                        AutomationException

Suppresses the pivot and zoom functionality.

Description

Use the FlyToolOnly method to control whether pivoting and zooming are disabled in the ControlsGlobeOrbitalFlyTool, and only flying is supported.

Product Availability

Available with ArcGIS Engine.

Parameters:

bFlyOnly - The bFlyOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.