com.esri.arcgis.controls
Interface IARGlobe

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ARGlobe, IARGlobeProxy

public interface IARGlobe
extends java.io.Serializable

COM Interface 'IARGlobe'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control the ARGlobe.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String DISPID_1_GET_NAME
           
static java.lang.String DISPID_10_GET_NAME
           
static java.lang.String DISPID_11_GET_NAME
           
static java.lang.String DISPID_13_GET_NAME
           
static java.lang.String DISPID_13_PUT_NAME
           
static java.lang.String DISPID_14_NAME
           
static java.lang.String DISPID_15_NAME
           
static java.lang.String DISPID_16_NAME
           
static java.lang.String DISPID_17_NAME
           
static java.lang.String DISPID_18_NAME
           
static java.lang.String DISPID_19_NAME
           
static java.lang.String DISPID_2_GET_NAME
           
static java.lang.String DISPID_20_NAME
           
static java.lang.String DISPID_21_NAME
           
static java.lang.String DISPID_22_GET_NAME
           
static java.lang.String DISPID_22_PUT_NAME
           
static java.lang.String DISPID_23_GET_NAME
           
static java.lang.String DISPID_23_PUT_NAME
           
static java.lang.String DISPID_3_NAME
           
static java.lang.String DISPID_4_NAME
           
static java.lang.String DISPID_5_GET_NAME
           
static java.lang.String DISPID_6_GET_NAME
           
static java.lang.String DISPID_7_NAME
           
static java.lang.String DISPID_8_GET_NAME
           
static java.lang.String DISPID_9_GET_NAME
           
static java.lang.String IID
          Deprecated. Internal use only
static int IID9e5e80cf_2f1d_49c6_a73c_39308d1fbc61
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void centerAt(double longitude, double latitude)
          Moves the observer over the specified point.
 void centerAtBookmark(java.lang.Object vBookmarkID)
          Zooms the globe display to the bookmark.
 int getAnimationCount()
          The number of animations in the globes's animation collection.
 java.lang.String getAnimationName(int index)
          The name of the animation.
 IARLayer getARLayer(int index)
          The layer at the specified index.
 int getARLayerCount()
          The number of layers in the globe's layer collection.
 double getAzimuth()
          The azimuth of the observer in degrees.
 int getBookmarkCount()
          The number of bookmarks in the globe’s bookmark collection.
 java.lang.String getBookmarkName(int index)
          The name of the bookmark.
 double getElevation()
          The distance between observer location and globe’s surface.
 int getGlobeUnits()
          The geographical units of the globe.
 void getObserverLocation(double[] longitude, double[] latitude, double[] elev)
          Gets the current observer location.
 double getPitch()
          The pitch of the observer in degrees.
 java.lang.String getSpatialReferenceName()
          The name of the globe’s spatial reference.
 boolean getSurfacePoint(int x, int y, double[] longitude, double[] latitude, double[] elev)
          Converts a point in device coordinates (typically pixels) to coordinates in latitude and longitude.
 IARFeature locateARFeature(int x, int y)
          Searches the globe along a ray trace, returns the first feature in the ray.
 void playAnimation(java.lang.Object vAnimationID)
          Plays an animation.
 IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
          Searches the globe using a search definition and returns an ARFeatureSet.
 IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
          Searches the globe using a search definition and returns an ARFeatureCursor.
 void setAzimuth(double azimuth)
          The azimuth of the observer in degrees.
 void setElevation(double elev)
          The distance between observer location and globe’s surface.
 void setObserverLocation(double longitude, double latitude, double elev)
          Sets the current observer location.
 void setPitch(double pitch)
          The pitch of the observer in degrees.
 void zoomToBookmark(java.lang.Object vBookmarkID)
          Zooms the globe display to the bookmark.
 void zoomToFullExtent()
          Zoom to the full extent of the globe.
 

Field Detail

IID9e5e80cf_2f1d_49c6_a73c_39308d1fbc61

static final int IID9e5e80cf_2f1d_49c6_a73c_39308d1fbc61
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME
See Also:
Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME
See Also:
Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME
See Also:
Constant Field Values

DISPID_4_NAME

static final java.lang.String DISPID_4_NAME
See Also:
Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME
See Also:
Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME
See Also:
Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME
See Also:
Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME
See Also:
Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME
See Also:
Constant Field Values

DISPID_10_GET_NAME

static final java.lang.String DISPID_10_GET_NAME
See Also:
Constant Field Values

DISPID_11_GET_NAME

static final java.lang.String DISPID_11_GET_NAME
See Also:
Constant Field Values

DISPID_13_PUT_NAME

static final java.lang.String DISPID_13_PUT_NAME
See Also:
Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME
See Also:
Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME
See Also:
Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME
See Also:
Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME
See Also:
Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME
See Also:
Constant Field Values

DISPID_18_NAME

static final java.lang.String DISPID_18_NAME
See Also:
Constant Field Values

DISPID_19_NAME

static final java.lang.String DISPID_19_NAME
See Also:
Constant Field Values

DISPID_20_NAME

static final java.lang.String DISPID_20_NAME
See Also:
Constant Field Values

DISPID_21_NAME

static final java.lang.String DISPID_21_NAME
See Also:
Constant Field Values

DISPID_22_GET_NAME

static final java.lang.String DISPID_22_GET_NAME
See Also:
Constant Field Values

DISPID_22_PUT_NAME

static final java.lang.String DISPID_22_PUT_NAME
See Also:
Constant Field Values

DISPID_23_GET_NAME

static final java.lang.String DISPID_23_GET_NAME
See Also:
Constant Field Values

DISPID_23_PUT_NAME

static final java.lang.String DISPID_23_PUT_NAME
See Also:
Constant Field Values
Method Detail

getBookmarkCount

int getBookmarkCount()
                     throws java.io.IOException,
                            AutomationException
The number of bookmarks in the globe’s bookmark collection.

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

getBookmarkName

java.lang.String getBookmarkName(int index)
                                 throws java.io.IOException,
                                        AutomationException
The name of the bookmark.

Parameters:
index - The index (in)
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToBookmark

void zoomToBookmark(java.lang.Object vBookmarkID)
                    throws java.io.IOException,
                           AutomationException
Zooms the globe display to the bookmark.

Parameters:
vBookmarkID - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAtBookmark

void centerAtBookmark(java.lang.Object vBookmarkID)
                      throws java.io.IOException,
                             AutomationException
Zooms the globe display to the bookmark.

Parameters:
vBookmarkID - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationCount

int getAnimationCount()
                      throws java.io.IOException,
                             AutomationException
The number of animations in the globes's animation collection.

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

getAnimationName

java.lang.String getAnimationName(int index)
                                  throws java.io.IOException,
                                         AutomationException
The name of the animation.

Parameters:
index - The index (in)
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

playAnimation

void playAnimation(java.lang.Object vAnimationID)
                   throws java.io.IOException,
                          AutomationException
Plays an animation.

Parameters:
vAnimationID - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARLayerCount

int getARLayerCount()
                    throws java.io.IOException,
                           AutomationException
The number of layers in the globe's layer collection.

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

getARLayer

IARLayer getARLayer(int index)
                    throws java.io.IOException,
                           AutomationException
The layer at the specified index.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IARLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReferenceName

java.lang.String getSpatialReferenceName()
                                         throws java.io.IOException,
                                                AutomationException
The name of the globe’s spatial reference.

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

getGlobeUnits

int getGlobeUnits()
                  throws java.io.IOException,
                         AutomationException
The geographical units of the globe.

Returns:
A com.esri.arcgis.controls.esriARUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevation

void setElevation(double elev)
                  throws java.io.IOException,
                         AutomationException
The distance between observer location and globe’s surface.

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

getElevation

double getElevation()
                    throws java.io.IOException,
                           AutomationException
The distance between observer location and globe’s surface.

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

centerAt

void centerAt(double longitude,
              double latitude)
              throws java.io.IOException,
                     AutomationException
Moves the observer over the specified point.

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

getSurfacePoint

boolean getSurfacePoint(int x,
                        int y,
                        double[] longitude,
                        double[] latitude,
                        double[] elev)
                        throws java.io.IOException,
                               AutomationException
Converts a point in device coordinates (typically pixels) to coordinates in latitude and longitude.

Parameters:
x - The x (in)
y - The y (in)
longitude - The longitude (in/out: use single element array)
latitude - The latitude (in/out: use single element array)
elev - The elev (in/out: use single element array)
Returns:
The bHitGlobe
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToFullExtent

void zoomToFullExtent()
                      throws java.io.IOException,
                             AutomationException
Zoom to the full extent of the globe.

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

queryARFeatures

IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
                              throws java.io.IOException,
                                     AutomationException
Searches the globe using a search definition and returns an ARFeatureSet.

Parameters:
pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeatureSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchARFeatures

IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
                                  throws java.io.IOException,
                                         AutomationException
Searches the globe using a search definition and returns an ARFeatureCursor.

Parameters:
pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeatureCursor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateARFeature

IARFeature locateARFeature(int x,
                           int y)
                           throws java.io.IOException,
                                  AutomationException
Searches the globe along a ray trace, returns the first feature in the ray.

Parameters:
x - The x (in)
y - The y (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObserverLocation

void setObserverLocation(double longitude,
                         double latitude,
                         double elev)
                         throws java.io.IOException,
                                AutomationException
Sets the current observer location.

Parameters:
longitude - The longitude (in)
latitude - The latitude (in)
elev - The elev (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObserverLocation

void getObserverLocation(double[] longitude,
                         double[] latitude,
                         double[] elev)
                         throws java.io.IOException,
                                AutomationException
Gets the current observer location.

Parameters:
longitude - The longitude (in/out: use single element array)
latitude - The latitude (in/out: use single element array)
elev - The elev (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPitch

double getPitch()
                throws java.io.IOException,
                       AutomationException
The pitch of the observer in degrees.

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

setPitch

void setPitch(double pitch)
              throws java.io.IOException,
                     AutomationException
The pitch of the observer in degrees.

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

getAzimuth

double getAzimuth()
                  throws java.io.IOException,
                         AutomationException
The azimuth of the observer in degrees.

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

setAzimuth

void setAzimuth(double azimuth)
                throws java.io.IOException,
                       AutomationException
The azimuth of the observer in degrees.

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