com.esri.arcgis.globecore
Class GlobeHelper

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

All Implemented Interfaces:

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

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

COM Class 'GlobeHelper'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description 'A class to serve as a utility helper for common functions.' 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.globecore.IGlobeHelperPub

IID, IIDc61d0917_097f_44cf_ba84_80a4b6537bf6, xxDummy

Constructor Summary

GlobeHelper()
Constructs a GlobeHelper using ArcGIS Engine.

GlobeHelper(java.lang.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(java.lang.String fullPath) Creates All Cache Directories in path
void	deleteAllowedLayerCachesInGlobeCacheDirectory(java.lang.String globeCacheFullPath) Delete Allowed Layer Caches in Globe Directory.
void	deleteLayerCacheDirectory(java.lang.String layerCacheFullPath) Delete Layer Cache Directory.
boolean	equals(java.lang.Object o) Compare this object with another
void	findGlobeLayerProperties(ILayer pLayer, IGlobeLayerProperties[] ppGlobeLayerProperties) Returns GlobeLayerProperties of a layer
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
void	release() Release a GlobeHelper.
void	setGroupLayerCache(IGroupLayer pGroupLayer, boolean bConsolidate, IGlobeDisplay pGlobeDisplay, boolean bMapConsolidated, boolean bStrictOnDemand, java.lang.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

Constructor Detail

GlobeHelper

public GlobeHelper()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a GlobeHelper using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GlobeHelper

public GlobeHelper(java.lang.Object obj)
            throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

addGlobeProperties

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

Process a new layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findGlobeLayerProperties

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

Returns GlobeLayerProperties of a layer

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createAllCacheSubDirectoriesInPath

public void createAllCacheSubDirectoriesInPath(java.lang.String fullPath)
                                        throws java.io.IOException,
                                               AutomationException

Creates All Cache Directories in path

Specified by:

createAllCacheSubDirectoriesInPath in interface IGlobeHelperPub

Parameters:

fullPath - The fullPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteLayerCacheDirectory

public void deleteLayerCacheDirectory(java.lang.String layerCacheFullPath)
                               throws java.io.IOException,
                                      AutomationException

Delete Layer Cache Directory.

Specified by:

deleteLayerCacheDirectory in interface IGlobeHelperPub

Parameters:

layerCacheFullPath - The layerCacheFullPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllowedLayerCachesInGlobeCacheDirectory

public void deleteAllowedLayerCachesInGlobeCacheDirectory(java.lang.String globeCacheFullPath)
                                                   throws java.io.IOException,
                                                          AutomationException

Delete Allowed Layer Caches in Globe Directory.

Specified by:

deleteAllowedLayerCachesInGlobeCacheDirectory in interface IGlobeHelperPub

Parameters:

globeCacheFullPath - The globeCacheFullPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adjustGCS360

public void adjustGCS360(ILayer pLayer)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

adjustGCS360 in interface IGlobeHelperPub

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

syncExtrusionProperties

public void syncExtrusionProperties(ILayer pLayer)
                             throws java.io.IOException,
                                    AutomationException

Transfers 3D Extrusion properties to Globe Extrusion properties.

Specified by:

syncExtrusionProperties in interface IGlobeHelperPub

Parameters:

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

Throws:

java.io.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,
                               java.lang.String groupCacheName,
                               IGlobeLayerProperties[] parentProps)
                        throws java.io.IOException,
                               AutomationException

Enables and Sets Group Layer's cache properties.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.