com.esri.arcgis.globecore
Interface IGlobeTileGenerator

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IGlobeTileGenerator2, IGlobeTileGenerator3
All Known Implementing Classes:
GlobeTileGenerator, IGlobeTileGenerator2Proxy, IGlobeTileGenerator3Proxy, IGlobeTileGeneratorProxy

public interface IGlobeTileGenerator
extends java.io.Serializable

COM Interface 'IGlobeTileGenerator'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description: 'Provides access to members that control globe tile generation.' 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 IID
          Deprecated. Internal use only
static int IIDe2318a63_2434_49ae_8535_985948cdeb28
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void deleteTiles(IGlobeServer pGlobeServer, int layerID, IEnvelope pExtent, int minLOD, int maxLOD, ITrackCancel pCancelTracker)
          Deletes all tiles from cache for a given layer within a given extent.
 void exit()
          Exits the tile generator host process.
 void generateConfigFiles()
          Generates a cache configuration file for the source layer.
 byte[] generateTile(int face, int level, int row, int column)
          Generates a tile for the source layer, and stores it into its cache file.
 void generateTiles(IGlobeServer pGlobeServer, int layerID, IEnvelope pExtent, int minLOD, int maxLOD, ITrackCancel pCancelTracker)
          Generate tiles in association with a GlobeServer object.
 IGlobeDisplay getDisplay()
          The associated globe display.
 ILayer getLayer()
          The source layer from which to generate tiles.
 IGlobeLayerProperties getLayerProperties()
          The globe layer properties.
 int getMaxTileCount()
          The maximum number of tiles to be generated.
 void putTilePosition(int face, int level, int row, int column)
          Sets the current tile position.
 void queryTilePosition(int[] pFace, int[] pLevel, int[] pRow, int[] pColumn)
          Queries for the current tile position.
 void setDisplayByRef(IGlobeDisplay ppDisplay)
          The associated globe display.
 void setLayerByRef(ILayer ppLayer)
          The source layer from which to generate tiles.
 void setLayerPropertiesByRef(IGlobeLayerProperties ppProps)
          The globe layer properties.
 void setMaxTileCount(int pNumTiles)
          The maximum number of tiles to be generated.
 void updateTiles(IGlobeServer pGlobeServer, int layerID, IEnvelope pExtent, int minLOD, int maxLOD, int updateMode, ITrackCancel pCancelTracker)
          Updates cache for a given layer within a given extent.
 

Field Detail

IIDe2318a63_2434_49ae_8535_985948cdeb28

static final int IIDe2318a63_2434_49ae_8535_985948cdeb28
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
Method Detail

getLayer

ILayer getLayer()
                throws java.io.IOException,
                       AutomationException
The source layer from which to generate tiles.

Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerByRef

void setLayerByRef(ILayer ppLayer)
                   throws java.io.IOException,
                          AutomationException
The source layer from which to generate tiles.

Parameters:
ppLayer - 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.

getLayerProperties

IGlobeLayerProperties getLayerProperties()
                                         throws java.io.IOException,
                                                AutomationException
The globe layer properties.

Returns:
A reference to a com.esri.arcgis.globecore.IGlobeLayerProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerPropertiesByRef

void setLayerPropertiesByRef(IGlobeLayerProperties ppProps)
                             throws java.io.IOException,
                                    AutomationException
The globe layer properties.

Parameters:
ppProps - A reference to a com.esri.arcgis.globecore.IGlobeLayerProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplay

IGlobeDisplay getDisplay()
                         throws java.io.IOException,
                                AutomationException
The associated globe display.

Returns:
A reference to a com.esri.arcgis.globecore.IGlobeDisplay
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayByRef

void setDisplayByRef(IGlobeDisplay ppDisplay)
                     throws java.io.IOException,
                            AutomationException
The associated globe display.

Parameters:
ppDisplay - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateConfigFiles

void generateConfigFiles()
                         throws java.io.IOException,
                                AutomationException
Generates a cache configuration file for the source layer.

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

generateTile

byte[] generateTile(int face,
                    int level,
                    int row,
                    int column)
                    throws java.io.IOException,
                           AutomationException
Generates a tile for the source layer, and stores it into its cache file.

Parameters:
face - The face (in)
level - The level (in)
row - The row (in)
column - The column (in)
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateTiles

void generateTiles(IGlobeServer pGlobeServer,
                   int layerID,
                   IEnvelope pExtent,
                   int minLOD,
                   int maxLOD,
                   ITrackCancel pCancelTracker)
                   throws java.io.IOException,
                          AutomationException
Generate tiles in association with a GlobeServer object.

Parameters:
pGlobeServer - A reference to a com.esri.arcgis.globecore.IGlobeServer (in)
layerID - The layerID (in)
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
minLOD - The minLOD (in)
maxLOD - The maxLOD (in)
pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTilePosition

void queryTilePosition(int[] pFace,
                       int[] pLevel,
                       int[] pRow,
                       int[] pColumn)
                       throws java.io.IOException,
                              AutomationException
Queries for the current tile position.

Parameters:
pFace - The pFace (out: use single element array)
pLevel - The pLevel (out: use single element array)
pRow - The pRow (out: use single element array)
pColumn - The pColumn (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putTilePosition

void putTilePosition(int face,
                     int level,
                     int row,
                     int column)
                     throws java.io.IOException,
                            AutomationException
Sets the current tile position.

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

getMaxTileCount

int getMaxTileCount()
                    throws java.io.IOException,
                           AutomationException
The maximum number of tiles to be generated.

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

setMaxTileCount

void setMaxTileCount(int pNumTiles)
                     throws java.io.IOException,
                            AutomationException
The maximum number of tiles to be generated.

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

exit

void exit()
          throws java.io.IOException,
                 AutomationException
Exits the tile generator host process.

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

updateTiles

void updateTiles(IGlobeServer pGlobeServer,
                 int layerID,
                 IEnvelope pExtent,
                 int minLOD,
                 int maxLOD,
                 int updateMode,
                 ITrackCancel pCancelTracker)
                 throws java.io.IOException,
                        AutomationException
Updates cache for a given layer within a given extent.

Parameters:
pGlobeServer - A reference to a com.esri.arcgis.globecore.IGlobeServer (in)
layerID - The layerID (in)
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
minLOD - The minLOD (in)
maxLOD - The maxLOD (in)
updateMode - A com.esri.arcgis.globecore.esriGlobeCacheUpdateMode constant (in)
pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteTiles

void deleteTiles(IGlobeServer pGlobeServer,
                 int layerID,
                 IEnvelope pExtent,
                 int minLOD,
                 int maxLOD,
                 ITrackCancel pCancelTracker)
                 throws java.io.IOException,
                        AutomationException
Deletes all tiles from cache for a given layer within a given extent.

Parameters:
pGlobeServer - A reference to a com.esri.arcgis.globecore.IGlobeServer (in)
layerID - The layerID (in)
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
minLOD - The minLOD (in)
maxLOD - The maxLOD (in)
pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.