com.esri.arcgis.globecore
Class GlobeHelper

java.lang.Object
  com.esri.arcgis.globecore.GlobeHelper

All Implemented Interfaces:

IGlobeHelperPub, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GlobeHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeHelperPub

A class to serve as a utility helper for common functions.

Description

The GlobeHelper is a utility class designed to help developers to easily access and set some common used functionalities with globe while working in ArcGIS Engine Controls and applications.

Use the GlobeHelper to easily add or find a globe layers properties given the layer, set a group layers cache settings via SetGroupLayerCache, or manipulate a globe layers cache.
IGlobeHelperPub has methods that will additionally allow you to easily Transfer 3D Extrusion properties to Globe Extrusion properties

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

GlobeHelper()
Constructs a GlobeHelper using ArcGIS Engine.

GlobeHelper(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeHelper theGlobeHelper = (GlobeHelper) obj;

Method Summary

void	addGlobeProperties(ILayer pLayer, IGlobeDisplay pGlobeDisplay, int layerType, boolean bIsChildLayer) Process a new layer.
void	adjustGCS360(ILayer pLayer) Adjusts a layer within GCS (0,360) to (-180,180).
void	createAllCacheSubDirectoriesInPath(String fullPath) Creates All Cache Directories in path
void	deleteAllowedLayerCachesInGlobeCacheDirectory(String globeCacheFullPath) Delete Allowed Layer Caches in Globe Directory.
void	deleteLayerCacheDirectory(String layerCacheFullPath) Delete Layer Cache Directory.
boolean	equals(Object o) Compare this object with another
void	findGlobeLayerProperties(ILayer pLayer, IGlobeLayerProperties[] ppGlobeLayerProperties) Returns GlobeLayerProperties of a layer
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	setGroupLayerCache(IGroupLayer pGroupLayer, boolean bConsolidate, IGlobeDisplay pGlobeDisplay, boolean bMapConsolidated, boolean bStrictOnDemand, String groupCacheName, IGlobeLayerProperties[] parentProps) Enables and Sets Group Layer's cache properties.
void	syncExtrusionProperties(ILayer pLayer) Transfers 3D Extrusion properties to Globe Extrusion properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GlobeHelper

public GlobeHelper()
            throws IOException,
                   UnknownHostException

Constructs a GlobeHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeHelper

public GlobeHelper(Object obj)
            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeHelper theGlobeHelper = (GlobeHelper) obj;

Construct a GlobeHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GlobeHelper.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addGlobeProperties

public void addGlobeProperties(ILayer pLayer,
                               IGlobeDisplay pGlobeDisplay,
                               int layerType,
                               boolean bIsChildLayer)
                        throws IOException,
                               AutomationException

Process a new layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addGlobeProperties in interface IGlobeHelperPub

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pGlobeDisplay - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)

layerType - A com.esri.arcgis.globecore.esriGlobeLayerType constant (in)

bIsChildLayer - The bIsChildLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findGlobeLayerProperties

public void findGlobeLayerProperties(ILayer pLayer,
                                     IGlobeLayerProperties[] ppGlobeLayerProperties)
                              throws IOException,
                                     AutomationException

Returns GlobeLayerProperties of a layer

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

findGlobeLayerProperties in interface IGlobeHelperPub

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

ppGlobeLayerProperties - A reference to a com.esri.arcgis.globecore.IGlobeLayerProperties (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createAllCacheSubDirectoriesInPath

public void createAllCacheSubDirectoriesInPath(String fullPath)
                                        throws IOException,
                                               AutomationException

Creates All Cache Directories in path

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

createAllCacheSubDirectoriesInPath in interface IGlobeHelperPub

Parameters:

fullPath - The fullPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteLayerCacheDirectory

public void deleteLayerCacheDirectory(String layerCacheFullPath)
                               throws IOException,
                                      AutomationException

Delete Layer Cache Directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

deleteLayerCacheDirectory in interface IGlobeHelperPub

Parameters:

layerCacheFullPath - The layerCacheFullPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllowedLayerCachesInGlobeCacheDirectory

public void deleteAllowedLayerCachesInGlobeCacheDirectory(String globeCacheFullPath)
                                                   throws IOException,
                                                          AutomationException

Delete Allowed Layer Caches in Globe Directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

deleteAllowedLayerCachesInGlobeCacheDirectory in interface IGlobeHelperPub

Parameters:

globeCacheFullPath - The globeCacheFullPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adjustGCS360

public void adjustGCS360(ILayer pLayer)
                  throws IOException,
                         AutomationException

Adjusts a layer within GCS (0,360) to (-180,180).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adjustGCS360 in interface IGlobeHelperPub

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

syncExtrusionProperties

public void syncExtrusionProperties(ILayer pLayer)
                             throws IOException,
                                    AutomationException

Transfers 3D Extrusion properties to Globe Extrusion properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

syncExtrusionProperties in interface IGlobeHelperPub

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupLayerCache

public void setGroupLayerCache(IGroupLayer pGroupLayer,
                               boolean bConsolidate,
                               IGlobeDisplay pGlobeDisplay,
                               boolean bMapConsolidated,
                               boolean bStrictOnDemand,
                               String groupCacheName,
                               IGlobeLayerProperties[] parentProps)
                        throws IOException,
                               AutomationException

Enables and Sets Group Layer's cache properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setGroupLayerCache in interface IGlobeHelperPub

Parameters:

pGroupLayer - A reference to a com.esri.arcgis.carto.IGroupLayer (in)

bConsolidate - The bConsolidate (in)

pGlobeDisplay - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)

bMapConsolidated - The bMapConsolidated (in)

bStrictOnDemand - The bStrictOnDemand (in)

groupCacheName - The groupCacheName (in)

parentProps - A reference to a com.esri.arcgis.globecore.IGlobeLayerProperties (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.