Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore
Interface IGlobeTileGenerator

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGlobeTileGenerator2
All Known Implementing Classes:
GlobeTileGenerator, IGlobeTileGenerator2Proxy, IGlobeTileGeneratorProxy
public interface IGlobeTileGenerator
extends Serializable

Provides access to members that control globe tile generation.

Superseded By

IGlobeTileGenerator2

Product Availability

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

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.
 

Method Detail

getLayer

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

Product Availability

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

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

setLayerByRef

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

Product Availability

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

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

getLayerProperties

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

Product Availability

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

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

setLayerPropertiesByRef

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

Product Availability

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

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

getDisplay

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

Product Availability

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

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

setDisplayByRef

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

Product Availability

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

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

generateConfigFiles

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

Product Availability

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

Throws:
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 IOException,
                           AutomationException
Generates a tile for the source layer, and stores it into its cache file.

Product Availability

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

Parameters:
face - The face (in)
level - The level (in)
row - The row (in)
column - The column (in)
Returns:
An unsigned byte
Throws:
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 IOException,
                          AutomationException
Generate tiles in association with a GlobeServer object.

Product Availability

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

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:
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 IOException,
                              AutomationException
Queries for the current tile position.

Product Availability

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

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:
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 IOException,
                            AutomationException
Sets the current tile position.

Product Availability

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

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

getMaxTileCount

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

Product Availability

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

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

setMaxTileCount

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

Product Availability

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

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

exit

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

Product Availability

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

Throws:
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 IOException,
                        AutomationException
Updates cache for a given layer within a given extent.

Product Availability

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

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:
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 IOException,
                        AutomationException
Deletes all tiles from cache for a given layer within a given extent.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD