com.esri.arcgis.controls
Class ARGlobe

java.lang.Object
  extended by com.esri.arcgis.controls.ARGlobe
All Implemented Interfaces:
IARGlobe, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ARGlobe
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IARGlobe

COM Class 'ARGlobe'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description 'The ARGlobe container for the display of globe data.' 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.controls.IARGlobe
DISPID_1_GET_NAME, DISPID_10_GET_NAME, DISPID_11_GET_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_18_NAME, DISPID_19_NAME, DISPID_2_GET_NAME, DISPID_20_NAME, DISPID_21_NAME, DISPID_22_GET_NAME, DISPID_22_PUT_NAME, DISPID_23_GET_NAME, DISPID_23_PUT_NAME, DISPID_3_NAME, DISPID_4_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_NAME, DISPID_8_GET_NAME, DISPID_9_GET_NAME, IID, IID9e5e80cf_2f1d_49c6_a73c_39308d1fbc61, xxDummy
 
Constructor Summary
ARGlobe(java.lang.Object obj)
          Construct a ARGlobe using a reference to such an object returned from ArcGIS Engine or Server.
 
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.
 boolean equals(java.lang.Object o)
          Compare this object with another
 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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 int hashCode()
          the hashcode for this object
 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.
 void release()
          Release a ARGlobe.
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ARGlobe

public ARGlobe(java.lang.Object obj)
        throws java.io.IOException
Construct a ARGlobe using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARGlobe.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARGlobe o = (ARGlobe)obj; // will not work

ARGlobe o = new ARGlobe(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems ARGlobe theARGlobe = (ARGlobe) obj;
Method Detail

equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ARGlobe.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getBookmarkCount

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

Specified by:
getBookmarkCount in interface IARGlobe
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBookmarkName

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

Specified by:
getBookmarkName in interface IARGlobe
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

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

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

centerAtBookmark

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

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

getAnimationCount

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

Specified by:
getAnimationCount in interface IARGlobe
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationName

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

Specified by:
getAnimationName in interface IARGlobe
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

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

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

getARLayerCount

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

Specified by:
getARLayerCount in interface IARGlobe
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARLayer

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

Specified by:
getARLayer in interface IARGlobe
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

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

Specified by:
getSpatialReferenceName in interface IARGlobe
Returns:
The sSpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeUnits

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

Specified by:
getGlobeUnits in interface IARGlobe
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

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

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

getElevation

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

Specified by:
getElevation in interface IARGlobe
Returns:
The elev
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

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

Specified by:
centerAt in interface IARGlobe
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

public 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.

Specified by:
getSurfacePoint in interface IARGlobe
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

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

Specified by:
zoomToFullExtent in interface IARGlobe
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryARFeatures

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

Specified by:
queryARFeatures in interface IARGlobe
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

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

Specified by:
searchARFeatures in interface IARGlobe
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

public 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.

Specified by:
locateARFeature in interface IARGlobe
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

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

Specified by:
setObserverLocation in interface IARGlobe
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

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

Specified by:
getObserverLocation in interface IARGlobe
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

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

Specified by:
getPitch in interface IARGlobe
Returns:
The pitch
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPitch

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

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

getAzimuth

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

Specified by:
getAzimuth in interface IARGlobe
Returns:
The azimuth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAzimuth

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

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