com.esri.arcgis.globecore
Class GlobeTileGenerator

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

All Implemented Interfaces:

IGlobeTileGenerator, IGlobeTileGenerator2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GlobeTileGenerator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeTileGenerator2

The OnDemand Globe Tile Generator coclass.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GlobeTileGenerator()
Constructs a GlobeTileGenerator using ArcGIS Engine.

GlobeTileGenerator(Object obj)
Construct a GlobeTileGenerator using a reference to such an object returned from ArcGIS Engine or 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.
boolean	equals(Object o) Compare this object with another
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.
static String	getClsid() getClsid.
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	getStatusTileCount(int[] pTileCount) number of tiles processed in the current job
int	hashCode() the hashcode for this object
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.
void	updateTilesByGeometry(IGlobeServer pGlobeServer, int layerID, IGeometry pGeometry, int minLOD, int maxLOD, int updateMode, ITrackCancel pCancelTracker) Updates cache for a given layer within a given extent.

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

GlobeTileGenerator

public GlobeTileGenerator()
                   throws IOException,
                          UnknownHostException

Constructs a GlobeTileGenerator using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeTileGenerator

public GlobeTileGenerator(Object obj)
                   throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GlobeTileGenerator theGlobeTileGenerator = (GlobeTileGenerator) obj;

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

updateTilesByGeometry

public void updateTilesByGeometry(IGlobeServer pGlobeServer,
                                  int layerID,
                                  IGeometry pGeometry,
                                  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.

Specified by:

updateTilesByGeometry in interface IGlobeTileGenerator2

Parameters:

pGlobeServer - A reference to a com.esri.arcgis.globecore.IGlobeServer (in)

layerID - The layerID (in)

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (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.

getStatusTileCount

public void getStatusTileCount(int[] pTileCount)
                        throws IOException,
                               AutomationException

number of tiles processed in the current job

Product Availability

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

Specified by:

getStatusTileCount in interface IGlobeTileGenerator2

Parameters:

pTileCount - The pTileCount (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException

The source layer from which to generate tiles.

Product Availability

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

Specified by:

getLayer in interface IGlobeTileGenerator

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

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

Specified by:

setLayerByRef in interface IGlobeTileGenerator

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

public IGlobeLayerProperties getLayerProperties()
                                         throws IOException,
                                                AutomationException

The globe layer properties.

Product Availability

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

Specified by:

getLayerProperties in interface IGlobeTileGenerator

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

public void setLayerPropertiesByRef(IGlobeLayerProperties ppProps)
                             throws IOException,
                                    AutomationException

The globe layer properties.

Product Availability

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

Specified by:

setLayerPropertiesByRef in interface IGlobeTileGenerator

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

public IGlobeDisplay getDisplay()
                         throws IOException,
                                AutomationException

The associated globe display.

Product Availability

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

Specified by:

getDisplay in interface IGlobeTileGenerator

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

public void setDisplayByRef(IGlobeDisplay ppDisplay)
                     throws IOException,
                            AutomationException

The associated globe display.

Product Availability

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

Specified by:

setDisplayByRef in interface IGlobeTileGenerator

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

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

Specified by:

generateConfigFiles in interface IGlobeTileGenerator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateTile

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

Specified by:

generateTile in interface IGlobeTileGenerator

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

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

Specified by:

generateTiles in interface IGlobeTileGenerator

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

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

Specified by:

queryTilePosition in interface IGlobeTileGenerator

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

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

Specified by:

putTilePosition in interface IGlobeTileGenerator

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

public int getMaxTileCount()
                    throws IOException,
                           AutomationException

The maximum number of tiles to be generated.

Product Availability

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

Specified by:

getMaxTileCount in interface IGlobeTileGenerator

Returns:

The pNumTiles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxTileCount

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

Specified by:

setMaxTileCount in interface IGlobeTileGenerator

Parameters:

pNumTiles - The pNumTiles (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exit

public void exit()
          throws IOException,
                 AutomationException

Exits the tile generator host process.

Product Availability

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

Specified by:

exit in interface IGlobeTileGenerator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTiles

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

Specified by:

updateTiles in interface IGlobeTileGenerator

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

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

Specified by:

deleteTiles in interface IGlobeTileGenerator

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.