Class TLcdEarthMetadataTerrainTileSet
- All Implemented Interfaces:
ILcdEarthTileSet
,ILcdBounded
,ILcdDisposable
,AutoCloseable
ILcdEarthTileSet
which creates 3D terrain tiles based on a
model containing ILcdEarthAsset
objects.- Since:
- 8.2
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The texture coverage blended with the lightmap coverage.static final int
The terrain elevation coverage based on the elevation assets.static final int
The terrain geometry coverage based on the elevation assets.static final int
The light map coverage based on the elevation assets and light parameters.static final int
The normal map coverage based on the elevation assets.static final int
The terrain texture coverage based on the raster assets. -
Constructor Summary
ConstructorDescriptionTLcdEarthMetadataTerrainTileSet
(ILcdBounds aBounds, int aLevels, int aLevel0Rows, int aLevel0Columns, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory, int aTextureOversamplingFactor, int aCoverages, int aGeometryTileResolution, int aTextureTileResolution) Creates a metadata tileset with the specified coverages..TLcdEarthMetadataTerrainTileSet
(ILcdBounds aBounds, int aLevels, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory) Creates a metadata tileset with only a texture and geometry coverage.TLcdEarthMetadataTerrainTileSet
(ILcdBounds aBounds, int aLevels, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory, int aTextureOversamplingFactor) Creates a metadata tileset with only a texture and geometry coverage.TLcdEarthMetadataTerrainTileSet
(ILcdBounds aBounds, int aLevels, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory, int aTextureOversamplingFactor, int aCoverages) Creates a metadata tileset with the specified coverages. -
Method Summary
Modifier and TypeMethodDescriptionvoid
cancelTile
(int aLevel, long aTileX, long aTileY, ILcdEarthTileSetCoverage aCoverage, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, ILcdEarthTileSetCallback aCallback, Object aContext) Cancels any pending tile requests for the given parameters.boolean
containsTile
(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aX, long aY, Object aContext) Returns true if the repository contains the specified tile.boolean
containsTileSetCoverage
(String aCoverageName) Returns true if the repository contains a coverage with the specified name.void
dispose()
This method releases all resources held by the repository, such as file locks, threads or server connections.Returns the bounds of this tile set, expressed in the model reference of the model that contains this tile set.The elevation tileset used to produce the geometry, elevation, normalmap and lightmap coverages.int
Returns the number of available detail levels.The raster tileset used to produce the texture coverages.long
getTileColumnCount
(int aLevel) Returns the number of columns in the tile grid at the given level.long
getTileRowCount
(int aLevel) Returns the number of rows in the tile grid at the given level.getTileSetCoverage
(int aIndex) Returns the coverage at the specified index.getTileSetCoverage
(String aCoverageName) Returns the tileset coverage with the specified name.int
Returns the number of coverages this tileset contains.boolean
isFormatSupported
(ILcdEarthTileSetCoverage aCoverage, TLcdEarthTileFormat aFormat) Returns true if the tileset can produce tiles for the given coverage in the given format.boolean
isGeoReferenceSupported
(ILcdEarthTileSetCoverage aCoverage, ILcdGeoReference aGeoReference) Returns true if the tileset can produce tiles for the given coverage in the given reference system.void
produceTile
(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aTileX, long aTileY, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, TLcdEarthTileOperationMode aMode, ILcdEarthTileSetCallback aCallback, Object aContext) Produces the requested tile, and invoke the supplied callback when done.produceTile
(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aX, long aY, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, Object aContext) Gets a tile from the repository.void
setModelDecoderFactory
(ILcdEarthModelDecoderFactory aModelDecoderFactory) Sets the model decoder factory to use for decoding the assets.void
updateTile
(ALcdEarthTile aTile, TLcdEarthTileOperationMode aMode, ILcdEarthTileSetCallback aCallback, Object aContext) Produces an updated version of the given tile, if necessary.updateTile
(ALcdEarthTile aEarthTile, Object aContext) Returns an updated version of the specified tile.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.luciad.util.ILcdDisposable
close
-
Field Details
-
TEXTURE_COVERAGE
public static final int TEXTURE_COVERAGEThe terrain texture coverage based on the raster assets.- See Also:
-
GEOMETRY_COVERAGE
public static final int GEOMETRY_COVERAGEThe terrain geometry coverage based on the elevation assets.- See Also:
-
ELEVATION_COVERAGE
public static final int ELEVATION_COVERAGEThe terrain elevation coverage based on the elevation assets.- See Also:
-
NORMALMAP_COVERAGE
public static final int NORMALMAP_COVERAGEThe normal map coverage based on the elevation assets.- See Also:
-
LIGHTMAP_COVERAGE
public static final int LIGHTMAP_COVERAGEThe light map coverage based on the elevation assets and light parameters.- See Also:
-
BAKEDLIGHTMAP_COVERAGE
public static final int BAKEDLIGHTMAP_COVERAGEThe texture coverage blended with the lightmap coverage.- See Also:
-
-
Constructor Details
-
TLcdEarthMetadataTerrainTileSet
public TLcdEarthMetadataTerrainTileSet(ILcdBounds aBounds, int aLevels, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory) throws IOException Creates a metadata tileset with only a texture and geometry coverage.- Parameters:
aBounds
- The bounds of the tileset in the asset model's reference.aLevels
- The number of levels in the tileset.aAssetModel
- The raster and elevation data.aLayerFactory
- The layer factory to use for creating 2d layers from the assets.- Throws:
IOException
- When decoding of the metadata assets fails.
-
TLcdEarthMetadataTerrainTileSet
public TLcdEarthMetadataTerrainTileSet(ILcdBounds aBounds, int aLevels, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory, int aTextureOversamplingFactor) throws IOException Creates a metadata tileset with only a texture and geometry coverage.- Parameters:
aBounds
- The bounds of the tileset in the asset model's reference.aLevels
- The number of levels in the tileset.aAssetModel
- The raster and elevation data.aLayerFactory
- The layer factory to use for creating 2d layers from the assets.aTextureOversamplingFactor
- The oversampling factor for the raster data.- Throws:
IOException
- When decoding of the metadata assets fails.
-
TLcdEarthMetadataTerrainTileSet
public TLcdEarthMetadataTerrainTileSet(ILcdBounds aBounds, int aLevels, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory, int aTextureOversamplingFactor, int aCoverages) throws IOException Creates a metadata tileset with the specified coverages.- Parameters:
aBounds
- The bounds of the tileset in the asset model's reference.aLevels
- The number of levels in the tileset.aAssetModel
- The raster and elevation data.aLayerFactory
- The layer factory to use for creating 2d layers from the assets.aTextureOversamplingFactor
- The oversampling factor for the raster data.aCoverages
- The coverages that should be available.- Throws:
IOException
- When decoding of the metadata assets fails.
-
TLcdEarthMetadataTerrainTileSet
public TLcdEarthMetadataTerrainTileSet(ILcdBounds aBounds, int aLevels, int aLevel0Rows, int aLevel0Columns, ILcdModel aAssetModel, ILcdGXYLayerFactory aLayerFactory, int aTextureOversamplingFactor, int aCoverages, int aGeometryTileResolution, int aTextureTileResolution) throws IOException Creates a metadata tileset with the specified coverages..- Parameters:
aBounds
- The bounds of the tileset in the asset model's reference.aLevels
- The number of levels in the tileset.aLevel0Rows
- The number of rows in the tileset at level 0.aLevel0Columns
- The number of columns in the tileset at level 0.aAssetModel
- The raster and elevation data.aLayerFactory
- The layer factory to use for creating 2d layers from the assets.aTextureOversamplingFactor
- The oversampling factor for the raster data.aCoverages
- The coverages that should be available.aGeometryTileResolution
- The resolution (width and height in vertices) of the terrain geometry tiles.aTextureTileResolution
- The resolution (width and height in pixels) of the terrain texture tiles.- Throws:
IOException
- When decoding of the metadata assets fails.
-
-
Method Details
-
setModelDecoderFactory
Sets the model decoder factory to use for decoding the assets. When set, model decoders will be created through this factory, rather than retrieved from the assets themselves.- Parameters:
aModelDecoderFactory
- the model decoder factory
-
getElevationTileSet
The elevation tileset used to produce the geometry, elevation, normalmap and lightmap coverages. This can for example be used to set the light parameters for the lightmap coverages.- Returns:
- An elevation tileset.
- See Also:
-
getRasterTileSet
The raster tileset used to produce the texture coverages.- Returns:
- A raster tileset.
- See Also:
-
produceTile
public void produceTile(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aTileX, long aTileY, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, TLcdEarthTileOperationMode aMode, ILcdEarthTileSetCallback aCallback, Object aContext) Description copied from interface:ILcdEarthTileSet
Produces the requested tile, and invoke the supplied callback when done. The resulting tile is passed to the call back'stileAvailable()
method. If the tile cannot be produced for some reason, the methodtileNotAvailable()
should be called instead.If the tileset supports it and
aMode
isTLcdEarthTileOperationMode.PREFER_ASYNCHRONOUS
, the tile request may be executed asynchronously. However, the callback must be invoked at some point in time, unless thecancelTile()
method is used to cancel the tile request before it is executed. IfaMode
isTLcdEarthTileOperationMode.FORCE_SYNCHRONOUS
, the request must be executed synchronously and the callback must be invoked beforeproduceTile()
returns.Tiles may be requested in reference systems other than the native geo reference of the underlying data, provided that the
isGeoReferenceSupported()
method returns true for the requested reference. If this is not the case, the tileset should calltileNotAvailable()
. If the tileset callstileAvailable()
, the geo reference of the resulting tile must be equal toaGeoReference
, and the tile's bounds must likewise be expressed in this reference.Similarly, tiles may be requested in different data formats, as described by
TLcdEarthTileFormat
. The format determines the type of the data object that will be contained in the requested tile. To check if a format is supported, useisFormatSupported()
. If the specified format is not supported, the tileset should calltileNotAvailable()
.The context parameter may be used to pass application-specific data into the tileset. If it is not needed, its value may be
null
.- Specified by:
produceTile
in interfaceILcdEarthTileSet
- Parameters:
aCoverage
- the coverage from which the tile is requestedaLevel
- the level from which the tile is requestedaTileX
- the column index of the requested tileaTileY
- the row index of the requested tileaGeoReference
- the reference system in which the tile should be returnedaFormat
- the desired format of the tile's dataaMode
- controls the synchronous or asynchronous behaviour of the tilesetaCallback
- will be invoked when the tile is available to be usedaContext
- application-specific data to be used by the tileset, if any
-
cancelTile
public void cancelTile(int aLevel, long aTileX, long aTileY, ILcdEarthTileSetCoverage aCoverage, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, ILcdEarthTileSetCallback aCallback, Object aContext) Description copied from interface:ILcdEarthTileSet
Cancels any pending tile requests for the given parameters. This method is only meaningful in tilesets that support the asynchronous operation mode. IfcancelTile()
is called, the tileset is no longer required to invoke theILcdEarthTileSetCallback
for the tile in question. The tileset is not obligated to honor thecancelTile()
request, but ifcancelTile()
is not called, then it is required to invoke theILcdEarthTileSetCallback
at some point.- Specified by:
cancelTile
in interfaceILcdEarthTileSet
- Parameters:
aLevel
- the level from which the tile is requestedaTileX
- the column index of the requested tileaTileY
- the row index of the requested tileaCoverage
- the coverage from which the tile is requestedaGeoReference
- the reference system in which the tile is requestedaFormat
- the format in which the tile is requestedaCallback
- would be invoked when the tile would have been available to be usedaContext
- application-specific data to be used by the tileset, if any
-
containsTile
public boolean containsTile(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aX, long aY, Object aContext) Description copied from interface:ILcdEarthTileSet
Returns true if the repository contains the specified tile.- Specified by:
containsTile
in interfaceILcdEarthTileSet
- Parameters:
aCoverage
- the coverage from which to query a tileaLevel
- the detail level for which to query a tileaX
- the column index at which to query a tileaY
- the row index at which to query a tileaContext
- application-specific data to be used by the tileset, if any- Returns:
- true if the repository contains the requested tile
-
produceTile
public ALcdEarthTile produceTile(ILcdEarthTileSetCoverage aCoverage, int aLevel, long aX, long aY, ILcdGeoReference aGeoReference, TLcdEarthTileFormat aFormat, Object aContext) throws IOException Description copied from interface:ILcdEarthTileSet
Gets a tile from the repository.- Specified by:
produceTile
in interfaceILcdEarthTileSet
- Parameters:
aCoverage
- the coverage from which to query a tileaLevel
- the detail level for which to query a tileaX
- the column index at which to query a tileaY
- the row index at which to query a tileaGeoReference
- the georeference of the requested tileaFormat
- the format of the requested tileaContext
- application-specific data to be used by the tileset, if any- Returns:
- the requested tile, or null if the repository does not contain this tile
- Throws:
IOException
- if the tile cannot be produced
-
isGeoReferenceSupported
public boolean isGeoReferenceSupported(ILcdEarthTileSetCoverage aCoverage, ILcdGeoReference aGeoReference) Description copied from interface:ILcdEarthTileSet
Returns true if the tileset can produce tiles for the given coverage in the given reference system. Note that any reference other than the native reference may result in reduced performance.This method must always return true for the native reference of the coverage. If it returns true for any other georeference, then the tileset must be able to handle the georeference in question in its
produceTile()
method.- Specified by:
isGeoReferenceSupported
in interfaceILcdEarthTileSet
- Parameters:
aCoverage
- the coverage to check foraGeoReference
- the reference to check for- Returns:
- true if the given coverage can be queried with the given reference
-
isFormatSupported
Description copied from interface:ILcdEarthTileSet
Returns true if the tileset can produce tiles for the given coverage in the given format. Note that any format other than the native format may result in reduced performance.This method must always return true for the native format of the coverage. If it returns true for any other format, then the tileset must be able to handle the format in question in its
produceTile()
method.- Specified by:
isFormatSupported
in interfaceILcdEarthTileSet
- Parameters:
aCoverage
- the coverage to check foraFormat
- the format to check for- Returns:
- true if the given coverage can be queried with the given format
-
dispose
public void dispose()Description copied from interface:ILcdEarthTileSet
This method releases all resources held by the repository, such as file locks, threads or server connections.- Specified by:
dispose
in interfaceILcdDisposable
- Specified by:
dispose
in interfaceILcdEarthTileSet
-
getBounds
Description copied from interface:ILcdEarthTileSet
Returns the bounds of this tile set, expressed in the model reference of the model that contains this tile set.- Specified by:
getBounds
in interfaceILcdBounded
- Specified by:
getBounds
in interfaceILcdEarthTileSet
- Returns:
- the bounds of this tile set
- See Also:
-
getLevelCount
public int getLevelCount()Description copied from interface:ILcdEarthTileSet
Returns the number of available detail levels. Level 0 is the coarsest level.- Specified by:
getLevelCount
in interfaceILcdEarthTileSet
- Returns:
- the number of available detail levels
-
getTileRowCount
public long getTileRowCount(int aLevel) Description copied from interface:ILcdEarthTileSet
Returns the number of rows in the tile grid at the given level. Each level should have twice the number of rows of the previous one.- Specified by:
getTileRowCount
in interfaceILcdEarthTileSet
- Parameters:
aLevel
- the level to be queried- Returns:
- the number of tile rows on the specified level
-
getTileColumnCount
public long getTileColumnCount(int aLevel) Description copied from interface:ILcdEarthTileSet
Returns the number of columns in the tile grid at the given level. Each level should have twice the number of columns of the previous one.- Specified by:
getTileColumnCount
in interfaceILcdEarthTileSet
- Parameters:
aLevel
- the level to be queried- Returns:
- the number of tile columns on the specified level
-
getTileSetCoverageCount
public int getTileSetCoverageCount()Description copied from interface:ILcdEarthTileSet
Returns the number of coverages this tileset contains.- Specified by:
getTileSetCoverageCount
in interfaceILcdEarthTileSet
- Returns:
- the number of coverages this tileset contains
-
getTileSetCoverage
Description copied from interface:ILcdEarthTileSet
Returns the coverage at the specified index.- Specified by:
getTileSetCoverage
in interfaceILcdEarthTileSet
- Parameters:
aIndex
- the index of the coverage to return- Returns:
- the requested
ILcdEarthTileSetCoverage
-
getTileSetCoverage
Description copied from interface:ILcdEarthTileSet
Returns the tileset coverage with the specified name.- Specified by:
getTileSetCoverage
in interfaceILcdEarthTileSet
- Parameters:
aCoverageName
- the name of the coverage to look for- Returns:
- the tileset coverage with the specified name
-
containsTileSetCoverage
Description copied from interface:ILcdEarthTileSet
Returns true if the repository contains a coverage with the specified name.- Specified by:
containsTileSetCoverage
in interfaceILcdEarthTileSet
- Parameters:
aCoverageName
- the name of the coverage to look for- Returns:
- true if the repository contains a coverage with the specified name, false otherwise
-
updateTile
public void updateTile(ALcdEarthTile aTile, TLcdEarthTileOperationMode aMode, ILcdEarthTileSetCallback aCallback, Object aContext) Description copied from interface:ILcdEarthTileSet
Produces an updated version of the given tile, if necessary. Produces the same tile if the given tile is up to date.- Specified by:
updateTile
in interfaceILcdEarthTileSet
- Parameters:
aTile
- tile to checkaMode
- controls the synchronous or asynchronous behaviour of the tilesetaCallback
- will be invoked when the tile is available to be usedaContext
- application-specific data to be used by the tileset, if any
-
updateTile
Description copied from interface:ILcdEarthTileSet
Returns an updated version of the specified tile.- Specified by:
updateTile
in interfaceILcdEarthTileSet
- Parameters:
aEarthTile
- the tile to checkaContext
- application-specific data to be used by the tileset, if any- Returns:
- the tile itself or a new, updated version
- Throws:
IOException
- if the tile cannot be updated
-