org.cesiumjs.cs.core

Class TileAvailability

java.lang.Object

org.cesiumjs.cs.core.TileAvailability

@JsType(isNative=true,
        namespace="Cesium",
        name="TileAvailability")
public class TileAvailability
extends Object

Reports the availability of tiles in a TilingScheme.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
TileAvailability(TilingScheme tilingScheme, int maximumLevel) Reports the availability of tiles in a TilingScheme.

Method Summary

Modifier and Type	Method and Description
void	addAvailableTileRange(int level, int startX, int startY, int endX, int endY) Marks a rectangular range of tiles in a particular level as being available.
int	computeBestAvailableLevelOverRectangle(Rectangle rectangle) Finds the most detailed level that is available _everywhere_ within a given rectangle.
int	computeChildMaskForTile(int level, int x, int y) Computes a bit mask indicating which of a tile's four children exist.
int	computeMaximumLevelAtPosition(Cartographic position) Determines the level of the most detailed tile covering the position.
boolean	isTileAvailable(int level, int x, int y) Determines if a particular tile is available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TileAvailability

@JsConstructor
public TileAvailability(TilingScheme tilingScheme,
                                       int maximumLevel)

Reports the availability of tiles in a TilingScheme.

Parameters:

tilingScheme - The tiling scheme in which to report availability.

maximumLevel - The maximum tile level that is potentially available.

Method Detail

addAvailableTileRange

@JsMethod
public void addAvailableTileRange(int level,
                                            int startX,
                                            int startY,
                                            int endX,
                                            int endY)

Marks a rectangular range of tiles in a particular level as being available. For best performance, add your ranges in order of increasing level.

Parameters:

level - The level.

startX - The X coordinate of the first available tiles at the level.

startY - The Y coordinate of the first available tiles at the level.

endX - The X coordinate of the last available tiles at the level.

endY - The Y coordinate of the last available tiles at the level.

computeBestAvailableLevelOverRectangle

@JsMethod
public int computeBestAvailableLevelOverRectangle(Rectangle rectangle)

Finds the most detailed level that is available _everywhere_ within a given rectangle. More detailed tiles may be available in parts of the rectangle, but not the whole thing. The return value of this function may be safely passed to sampleTerrain for any position within the rectangle. This function usually completes in time logarithmic to the number of rectangles added with TileAvailability#addAvailableTileRange.

Parameters:

rectangle - The rectangle.

Returns:

The best available level for the entire rectangle.

computeChildMaskForTile

@JsMethod
public int computeChildMaskForTile(int level,
                                             int x,
                                             int y)

Computes a bit mask indicating which of a tile's four children exist. If a child's bit is set, a tile is available for that child. If it is cleared, the tile is not available. The bit values are as follows:

     
         Bit Position	Bit Value	Child Tile
         0	        1       	Southwest
         1	        2	        Southeast
         2	        4	        Northwest
         3	        8	        Northeast
     
 

Parameters:

level - The level of the parent tile.

x - The X coordinate of the parent tile.

y - The Y coordinate of the parent tile.

Returns:

The bit mask indicating child availability.

computeMaximumLevelAtPosition

@JsMethod
public int computeMaximumLevelAtPosition(Cartographic position)

Determines the level of the most detailed tile covering the position. This function usually completes in time logarithmic to the number of rectangles added with TileAvailability#addAvailableTileRange.

Parameters:

position - The position for which to determine the maximum available level. The height component is ignored.

Returns:

The level of the most detailed tile covering the position.

isTileAvailable

@JsMethod
public boolean isTileAvailable(int level,
                                         int x,
                                         int y)

Determines if a particular tile is available.

Parameters:

level - The tile level to check.

x - The X coordinate of the tile to check.

y - The Y coordinate of the tile to check.

Returns:

True if the tile is available; otherwise, false.