FeatureTiles (geopackage-android 3.0.0 API)

java.lang.Object
- mil.nga.geopackage.tiles.features.FeatureTiles

Direct Known Subclasses:

DefaultFeatureTiles
```
public abstract class FeatureTiles
extends Object
```
Tiles drawn from or linked to features. Used to query features and optionally draw tiles from those features.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Bitmap.CompressFormat`	`compressFormat` Compress format
`protected Context`	`context` Context
`protected FeatureDao`	`featureDao` Tile data access object
`protected boolean`	`fillPolygon` Fill polygon flag
`protected float`	`heightOverlap` Height overlapping pixels between tile images
`protected FeatureIndexManager`	`indexManager` When not null, features are retrieved using a feature index
`protected Paint`	`linePaint` Line paint
`protected Integer`	`maxFeaturesPerTile` Optional max features per tile.
`protected CustomFeaturesTile`	`maxFeaturesTileDraw` When not null and the number of features is greater than the max features per tile, used to draw tiles for those tiles with more features than the max
`protected FeatureTilePointIcon`	`pointIcon` Optional point icon in place of a drawn circle
`protected Paint`	`pointPaint` Point paint
`protected float`	`pointRadius` Point radius
`protected Paint`	`polygonFillPaint` Polygon fill paint
`protected Paint`	`polygonPaint` Polygon paint
`protected mil.nga.sf.proj.Projection`	`projection` Feature DAO Projection
`protected boolean`	`simplifyGeometries` When true, geometries are simplified before being drawn.
`protected int`	`tileHeight` Tile height
`protected int`	`tileWidth` Tile height
`protected static mil.nga.sf.proj.Projection`	`WEB_MERCATOR_PROJECTION` Web Mercator Projection
`protected static mil.nga.sf.proj.Projection`	`WGS_84_PROJECTION` WGS84 Projection
`protected float`	`widthOverlap` Width overlapping pixels between tile images

Constructor Summary

Constructors
Constructor and Description

FeatureTiles(Context context, FeatureDao featureDao)
Constructor

Constructors
Constructor and Description
`FeatureTiles(Context context, FeatureDao featureDao)` Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`calculateDrawOverlap()` Call after making changes to the point icon, point radius, or paint stroke widths.
`void`	`close()` Close the feature tiles connection
`protected Bitmap`	`createNewBitmap()` Create a new empty Bitmap
`abstract Bitmap`	`drawTile(int zoom, BoundingBox webMercatorBoundingBox, FeatureCursor cursor)` Draw a tile bitmap from feature geometries in the provided cursor
`abstract Bitmap`	`drawTile(int zoom, BoundingBox webMercatorBoundingBox, FeatureIndexResults results)` Draw a tile bitmap from feature index results
`abstract Bitmap`	`drawTile(int zoom, BoundingBox webMercatorBoundingBox, List<FeatureRow> featureRow)` Draw a tile bitmap from the feature rows
`Bitmap`	`drawTile(int x, int y, int zoom)` Draw a tile bitmap from the x, y, and zoom level
`byte[]`	`drawTileBytes(int x, int y, int zoom)` Draw the tile and get the bytes from the x, y, and zoom level
`Bitmap`	`drawTileQueryAll(int x, int y, int zoom)` Draw a tile bitmap from the x, y, and zoom level by querying all features.
`Bitmap`	`drawTileQueryIndex(int x, int y, int zoom)` Draw a tile bitmap from the x, y, and zoom level by querying features in the tile location
`protected BoundingBox`	`expandBoundingBox(BoundingBox webMercatorBoundingBox)` Create an expanded bounding box to handle features outside the tile that overlap
`Bitmap.CompressFormat`	`getCompressFormat()` Get the compress format
`FeatureDao`	`getFeatureDao()` Get the feature DAO
`float`	`getHeightDrawOverlap()` Get the height draw overlap
`FeatureIndexManager`	`getIndexManager()` Get the index manager
`Paint`	`getLinePaint()` Get the line paint
`Integer`	`getMaxFeaturesPerTile()` Get the max features per tile
`CustomFeaturesTile`	`getMaxFeaturesTileDraw()` Get the max features tile draw, the custom tile drawing implementation for tiles with more features than the max at #getMaxFeaturesPerTile
`FeatureTilePointIcon`	`getPointIcon()` Get the point icon
`Paint`	`getPointPaint()` Get point paint
`float`	`getPointRadius()` Get the point radius
`Paint`	`getPolygonFillPaint()` Get the polygon fill paint
`Paint`	`getPolygonPaint()` Get the polygon paint
`protected mil.nga.sf.proj.ProjectionTransform`	`getProjectionToWebMercatorTransform(mil.nga.sf.proj.Projection projection)` Create a projection transformation from provided projection to Web Mercator
`int`	`getTileHeight()` Get the tile height
`int`	`getTileWidth()` Get the tile width
`protected mil.nga.sf.proj.ProjectionTransform`	`getWgs84ToWebMercatorTransform()` Create a projection transformation from WGS84 to Web Mercator
`float`	`getWidthDrawOverlap()` Get the width draw overlap
`boolean`	`isFillPolygon()` Is fill polygon
`boolean`	`isIndexQuery()` Is index query
`boolean`	`isSimplifyGeometries()` Is the simplify geometries flag set? Default is true
`FeatureIndexResults`	`queryIndexedFeatures(BoundingBox webMercatorBoundingBox)` Query for feature results in the x, y, and zoom level by querying features in the tile location
`long`	`queryIndexedFeaturesCount(int x, int y, int zoom)` Draw a tile bitmap from the x, y, and zoom level by querying features in the tile location
`void`	`setCompressFormat(Bitmap.CompressFormat compressFormat)` Set the compress format
`void`	`setDrawOverlap(float pixels)` Manually set the width and height draw overlap
`void`	`setFillPolygon(boolean fillPolygon)` Set the fill polygon
`void`	`setHeightDrawOverlap(float pixels)` Manually set the height draw overlap
`void`	`setIndexManager(FeatureIndexManager indexManager)` Set the index
`void`	`setLinePaint(Paint linePaint)` Set the line paint
`void`	`setMaxFeaturesPerTile(Integer maxFeaturesPerTile)` Set the max features per tile.
`void`	`setMaxFeaturesTileDraw(CustomFeaturesTile maxFeaturesTileDraw)` Set the max features tile draw, used to draw tiles when more features for a single tile than the max at #getMaxFeaturesPerTile exist
`void`	`setPointIcon(FeatureTilePointIcon pointIcon)` Set the point icon
`void`	`setPointPaint(Paint pointPaint)` Set the point paint
`void`	`setPointRadius(float pointRadius)` Set the point radius
`void`	`setPolygonFillPaint(Paint polygonFillPaint)` Set the polygon fill paint
`void`	`setPolygonPaint(Paint polygonPaint)` Set the polygon paint
`void`	`setSimplifyGeometries(boolean simplifyGeometries)` Set the simplify geometries flag
`void`	`setTileHeight(int tileHeight)` Set the tile height
`void`	`setTileWidth(int tileWidth)` Set the tile width
`void`	`setWidthDrawOverlap(float pixels)` Manually set the width draw overlap
`protected List<mil.nga.sf.Point>`	`simplifyPoints(double simplifyTolerance, List<mil.nga.sf.Point> points)` When the simplify tolerance is set, simplify the points to a similar curve with fewer points.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WGS_84_PROJECTION
```
protected static final mil.nga.sf.proj.Projection WGS_84_PROJECTION
```
    WGS84 Projection
  - WEB_MERCATOR_PROJECTION
```
protected static final mil.nga.sf.proj.Projection WEB_MERCATOR_PROJECTION
```
    Web Mercator Projection
  - context
```
protected final Context context
```
    Context
  - featureDao
```
protected final FeatureDao featureDao
```
    Tile data access object
  - projection
```
protected mil.nga.sf.proj.Projection projection
```
    Feature DAO Projection
  - indexManager
```
protected FeatureIndexManager indexManager
```
    When not null, features are retrieved using a feature index
  - tileWidth
```
protected int tileWidth
```
    Tile height
  - tileHeight
```
protected int tileHeight
```
    Tile height
  - compressFormat
```
protected Bitmap.CompressFormat compressFormat
```
    Compress format
  - pointRadius
```
protected float pointRadius
```
    Point radius
  - pointPaint
```
protected Paint pointPaint
```
    Point paint
  - pointIcon
```
protected FeatureTilePointIcon pointIcon
```
    Optional point icon in place of a drawn circle
  - linePaint
```
protected Paint linePaint
```
    Line paint
  - polygonPaint
```
protected Paint polygonPaint
```
    Polygon paint
  - fillPolygon
```
protected boolean fillPolygon
```
    Fill polygon flag
  - polygonFillPaint
```
protected Paint polygonFillPaint
```
    Polygon fill paint
  - heightOverlap
```
protected float heightOverlap
```
    Height overlapping pixels between tile images
  - widthOverlap
```
protected float widthOverlap
```
    Width overlapping pixels between tile images
  - maxFeaturesPerTile
```
protected Integer maxFeaturesPerTile
```
    Optional max features per tile. When more features than this value exist for creating a single tile, the tile is not created
  - maxFeaturesTileDraw
```
protected CustomFeaturesTile maxFeaturesTileDraw
```
    When not null and the number of features is greater than the max features per tile, used to draw tiles for those tiles with more features than the max
    
    See Also:
    
    CustomFeaturesTile, custom features tile implementation
  - simplifyGeometries
```
protected boolean simplifyGeometries
```
    When true, geometries are simplified before being drawn. Default is true
- Constructor Detail
  - FeatureTiles
```
public FeatureTiles(Context context,
                    FeatureDao featureDao)
```
    Constructor
    
    Parameters:
    
    context -
    
    featureDao -
- Method Detail
  - close
```
public void close()
```
    Close the feature tiles connection
    
    Since:
    
    1.2.7
  - calculateDrawOverlap
```
public void calculateDrawOverlap()
```
    Call after making changes to the point icon, point radius, or paint stroke widths. Determines the pixel overlap between tiles
  - setDrawOverlap
```
public void setDrawOverlap(float pixels)
```
    Manually set the width and height draw overlap
    
    Parameters:
    
    pixels -
  - getWidthDrawOverlap
```
public float getWidthDrawOverlap()
```
    Get the width draw overlap
    
    Returns:
  - setWidthDrawOverlap
```
public void setWidthDrawOverlap(float pixels)
```
    Manually set the width draw overlap
    
    Parameters:
    
    pixels -
  - getHeightDrawOverlap
```
public float getHeightDrawOverlap()
```
    Get the height draw overlap
    
    Returns:
  - setHeightDrawOverlap
```
public void setHeightDrawOverlap(float pixels)
```
    Manually set the height draw overlap
    
    Parameters:
    
    pixels -
  - getFeatureDao
```
public FeatureDao getFeatureDao()
```
    Get the feature DAO
    
    Returns:
  - isIndexQuery
```
public boolean isIndexQuery()
```
    Is index query
    
    Returns:
    
    true if an index query
  - getIndexManager
```
public FeatureIndexManager getIndexManager()
```
    Get the index manager
    
    Returns:
    
    index manager or null
    
    Since:
    
    1.1.0
  - setIndexManager
```
public void setIndexManager(FeatureIndexManager indexManager)
```
    Set the index
    
    Parameters:
    
    indexManager -
    
    Since:
    
    1.1.0
  - getTileWidth
```
public int getTileWidth()
```
    Get the tile width
    
    Returns:
  - setTileWidth
```
public void setTileWidth(int tileWidth)
```
    Set the tile width
    
    Parameters:
    
    tileWidth -
  - getTileHeight
```
public int getTileHeight()
```
    Get the tile height
    
    Returns:
  - setTileHeight
```
public void setTileHeight(int tileHeight)
```
    Set the tile height
    
    Parameters:
    
    tileHeight -
  - getCompressFormat
```
public Bitmap.CompressFormat getCompressFormat()
```
    Get the compress format
    
    Returns:
  - setCompressFormat
```
public void setCompressFormat(Bitmap.CompressFormat compressFormat)
```
    Set the compress format
    
    Parameters:
    
    compressFormat -
  - getPointRadius
```
public float getPointRadius()
```
    Get the point radius
    
    Returns:
  - setPointRadius
```
public void setPointRadius(float pointRadius)
```
    Set the point radius
    
    Parameters:
    
    pointRadius -
  - getPointPaint
```
public Paint getPointPaint()
```
    Get point paint
    
    Returns:
  - setPointPaint
```
public void setPointPaint(Paint pointPaint)
```
    Set the point paint
    
    Parameters:
    
    pointPaint -
  - getPointIcon
```
public FeatureTilePointIcon getPointIcon()
```
    Get the point icon
    
    Returns:
  - setPointIcon
```
public void setPointIcon(FeatureTilePointIcon pointIcon)
```
    Set the point icon
    
    Parameters:
    
    pointIcon -
  - getLinePaint
```
public Paint getLinePaint()
```
    Get the line paint
    
    Returns:
  - setLinePaint
```
public void setLinePaint(Paint linePaint)
```
    Set the line paint
    
    Parameters:
    
    linePaint -
  - getPolygonPaint
```
public Paint getPolygonPaint()
```
    Get the polygon paint
    
    Returns:
  - setPolygonPaint
```
public void setPolygonPaint(Paint polygonPaint)
```
    Set the polygon paint
    
    Parameters:
    
    polygonPaint -
  - isFillPolygon
```
public boolean isFillPolygon()
```
    Is fill polygon
    
    Returns:
  - setFillPolygon
```
public void setFillPolygon(boolean fillPolygon)
```
    Set the fill polygon
    
    Parameters:
    
    fillPolygon -
  - getPolygonFillPaint
```
public Paint getPolygonFillPaint()
```
    Get the polygon fill paint
    
    Returns:
  - setPolygonFillPaint
```
public void setPolygonFillPaint(Paint polygonFillPaint)
```
    Set the polygon fill paint
    
    Parameters:
    
    polygonFillPaint -
  - getMaxFeaturesPerTile
```
public Integer getMaxFeaturesPerTile()
```
    Get the max features per tile
    
    Returns:
    
    max features per tile or null
    
    Since:
    
    1.1.0
  - setMaxFeaturesPerTile
```
public void setMaxFeaturesPerTile(Integer maxFeaturesPerTile)
```
    Set the max features per tile. When more features are returned in a query to create a single tile, the tile is not created.
    
    Parameters:
    
    maxFeaturesPerTile -
    
    Since:
    
    1.1.0
  - getMaxFeaturesTileDraw
```
public CustomFeaturesTile getMaxFeaturesTileDraw()
```
    Get the max features tile draw, the custom tile drawing implementation for tiles with more features than the max at #getMaxFeaturesPerTile
    
    Returns:
    
    max features tile draw or null
    
    Since:
    
    1.1.0
    
    See Also:
    
    CustomFeaturesTile, custom features tile implementation
  - setMaxFeaturesTileDraw
```
public void setMaxFeaturesTileDraw(CustomFeaturesTile maxFeaturesTileDraw)
```
    Set the max features tile draw, used to draw tiles when more features for a single tile than the max at #getMaxFeaturesPerTile exist
    
    Parameters:
    
    maxFeaturesTileDraw -
    
    Since:
    
    1.1.0
    
    See Also:
    
    CustomFeaturesTile, custom features tile implementation
  - isSimplifyGeometries
```
public boolean isSimplifyGeometries()
```
    Is the simplify geometries flag set? Default is true
    
    Returns:
    
    simplify geometries flag
    
    Since:
    
    2.0.0
  - setSimplifyGeometries
```
public void setSimplifyGeometries(boolean simplifyGeometries)
```
    Set the simplify geometries flag
    
    Parameters:
    
    simplifyGeometries - simplify geometries flag
    
    Since:
    
    2.0.0
  - drawTileBytes
```
public byte[] drawTileBytes(int x,
                            int y,
                            int zoom)
```
    Draw the tile and get the bytes from the x, y, and zoom level
    
    Parameters:
    
    x -
    
    y -
    
    zoom -
    
    Returns:
    
    tile bytes, or null
  - drawTile
```
public Bitmap drawTile(int x,
                       int y,
                       int zoom)
```
    Draw a tile bitmap from the x, y, and zoom level
    
    Parameters:
    
    x -
    
    y -
    
    zoom -
    
    Returns:
    
    tile bitmap, or null
  - drawTileQueryIndex
```
public Bitmap drawTileQueryIndex(int x,
                                 int y,
                                 int zoom)
```
    Draw a tile bitmap from the x, y, and zoom level by querying features in the tile location
    
    Parameters:
    
    x -
    
    y -
    
    zoom -
    
    Returns:
    
    drawn bitmap, or null
  - queryIndexedFeaturesCount
```
public long queryIndexedFeaturesCount(int x,
                                      int y,
                                      int zoom)
```
    Draw a tile bitmap from the x, y, and zoom level by querying features in the tile location
    
    Parameters:
    
    x -
    
    y -
    
    zoom -
    
    Returns:
    
    feature count
    
    Since:
    
    1.1.0
  - queryIndexedFeatures
```
public FeatureIndexResults queryIndexedFeatures(BoundingBox webMercatorBoundingBox)
```
    Query for feature results in the x, y, and zoom level by querying features in the tile location
    
    Parameters:
    
    webMercatorBoundingBox -
    
    Returns:
    
    feature index results
    
    Since:
    
    1.1.0
  - expandBoundingBox
```
protected BoundingBox expandBoundingBox(BoundingBox webMercatorBoundingBox)
```
    Create an expanded bounding box to handle features outside the tile that overlap
    
    Parameters:
    
    webMercatorBoundingBox -
    
    Returns:
  - drawTileQueryAll
```
public Bitmap drawTileQueryAll(int x,
                               int y,
                               int zoom)
```
    Draw a tile bitmap from the x, y, and zoom level by querying all features. This could be very slow if there are a lot of features
    
    Parameters:
    
    x -
    
    y -
    
    zoom -
    
    Returns:
    
    drawn bitmap, or null
  - createNewBitmap
```
protected Bitmap createNewBitmap()
```
    Create a new empty Bitmap
    
    Returns:
    
    bitmap
  - getWgs84ToWebMercatorTransform
```
protected mil.nga.sf.proj.ProjectionTransform getWgs84ToWebMercatorTransform()
```
    Create a projection transformation from WGS84 to Web Mercator
    
    Returns:
    
    transform
  - getProjectionToWebMercatorTransform
```
protected mil.nga.sf.proj.ProjectionTransform getProjectionToWebMercatorTransform(mil.nga.sf.proj.Projection projection)
```
    Create a projection transformation from provided projection to Web Mercator
    
    Parameters:
    
    projection - projection from
    
    Returns:
    
    transform
  - simplifyPoints
```
protected List<mil.nga.sf.Point> simplifyPoints(double simplifyTolerance,
                                                List<mil.nga.sf.Point> points)
```
    When the simplify tolerance is set, simplify the points to a similar curve with fewer points.
    
    Parameters:
    
    simplifyTolerance - simplify tolerance in meters
    
    points - ordered points
    
    Returns:
    
    simplified points
    
    Since:
    
    2.0.0
  - drawTile
```
public abstract Bitmap drawTile(int zoom,
                                BoundingBox webMercatorBoundingBox,
                                FeatureIndexResults results)
```
    Draw a tile bitmap from feature index results
    
    Parameters:
    
    zoom - zoom level
    
    webMercatorBoundingBox -
    
    results -
    
    Returns:
    
    tile
    
    Since:
    
    2.0.0
  - drawTile
```
public abstract Bitmap drawTile(int zoom,
                                BoundingBox webMercatorBoundingBox,
                                FeatureCursor cursor)
```
    Draw a tile bitmap from feature geometries in the provided cursor
    
    Parameters:
    
    zoom - zoom level
    
    webMercatorBoundingBox -
    
    cursor -
    
    Returns:
    
    tile
    
    Since:
    
    2.0.0
  - drawTile
```
public abstract Bitmap drawTile(int zoom,
                                BoundingBox webMercatorBoundingBox,
                                List<FeatureRow> featureRow)
```
    Draw a tile bitmap from the feature rows
    
    Parameters:
    
    zoom - zoom level
    
    webMercatorBoundingBox -
    
    featureRow -
    
    Returns:
    
    tile
    
    Since:
    
    2.0.0

Class FeatureTiles

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WGS_84_PROJECTION

WEB_MERCATOR_PROJECTION

context

featureDao

projection

indexManager

tileWidth

tileHeight

compressFormat

pointRadius

pointPaint

pointIcon

linePaint

polygonPaint

fillPolygon

polygonFillPaint

heightOverlap

widthOverlap

maxFeaturesPerTile

maxFeaturesTileDraw

simplifyGeometries

Constructor Detail

FeatureTiles

Method Detail

close

calculateDrawOverlap

setDrawOverlap

getWidthDrawOverlap

setWidthDrawOverlap

getHeightDrawOverlap

setHeightDrawOverlap

getFeatureDao

isIndexQuery

getIndexManager

setIndexManager

getTileWidth

setTileWidth

getTileHeight

setTileHeight

getCompressFormat

setCompressFormat

getPointRadius

setPointRadius

getPointPaint

setPointPaint

getPointIcon

setPointIcon

getLinePaint

setLinePaint

getPolygonPaint

setPolygonPaint

isFillPolygon

setFillPolygon

getPolygonFillPaint

setPolygonFillPaint

getMaxFeaturesPerTile

setMaxFeaturesPerTile

getMaxFeaturesTileDraw

setMaxFeaturesTileDraw

isSimplifyGeometries

setSimplifyGeometries

drawTileBytes

drawTile

drawTileQueryIndex

queryIndexedFeaturesCount

queryIndexedFeatures

expandBoundingBox

drawTileQueryAll

createNewBitmap

getWgs84ToWebMercatorTransform

getProjectionToWebMercatorTransform

simplifyPoints

drawTile

drawTile