Luciad.Models.Rasters.QuadTreeRasterModelBuilder Class Reference

This builder class allows to create a multi-level tiled raster model using a quad-tree structure. More...

Inheritance diagram for Luciad.Models.Rasters.QuadTreeRasterModelBuilder:

Public Member Functions
	QuadTreeRasterModelBuilder (Luciad.Models.Rasters.QuadTreeRasterModelBuilder other)
	Copy constructor.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	AttributionProvider (Luciad.Models.Rasters.IMultilevelTiledAttributionProvider attributionProvider)
	Sets the attribution provider for this model.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	Bounds (Luciad.Geometries.Bounds bounds)
	Defines the extent of the raster data structure.
Luciad.Models.Rasters.IRasterModel	Build ()
	Creates the raster model.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	DataBounds (Luciad.Geometries.Bounds bounds)
	Defines the extent of where actual data is a available.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	DataRetriever (Luciad.Models.Rasters.IMultilevelTiledRasterDataRetriever dataRetriever)
	Defines the implementation to be used to retrieve the raster tile data.
void	Dispose ()
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	Elevation ()
	Marks this model as an elevation model.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	ElevationNoDataValue (float noDataValue)
	Sets a no-data value for elevation data.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	EnableInvalidation ()
	Allows to create a raster model which can be invalidated.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	Level0ColumnCount (uint colCount)
	Defines the number of columns at the least detailed level.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	Level0RowCount (uint rowCount)
	Defines the number of row at the least detailed level.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	LevelCount (uint levelCount)
	Defines the number of detail levels.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	ModelMetadata (Luciad.Models.ModelMetadata modelMetadata)
	Defines the model metadata.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	Reference (Luciad.Geodesy.CoordinateReference modelReference)
	Defines the reference in which the raster data is defined.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	SamplingMode (Luciad.Rasters.RasterSamplingMode samplingMode)
	Defines the sampling mode of the data.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	TileHeightPixels (uint tileHeightPixels)
	Defines the height in pixels for a single tile.
Luciad.Models.Rasters.QuadTreeRasterModelBuilder	TileWidthPixels (uint tileWidthPixels)
	Defines the width in pixels for a single tile.

Static Public Member Functions
static Luciad.Models.Rasters.QuadTreeRasterModelBuilder	NewBuilder ()
	Creates the builder class to create a raster model.

Detailed Description

This builder class allows to create a multi-level tiled raster model using a quad-tree structure.

The multi-level tile structure is defined by a reference and a number of levels where each level has a bounds and a number of columns and rows. The structure of the tiles is organized as follows:

• Level 0 is the least detailed level.
• All levels have the same extent and top-left corner.
• The tile coordinate (N,0,0) on level N is the top-left tile.
• Each tile on level N corresponds to a block of 2x2 tiles on level N+1.

The IMultilevelTiledRasterDataRetriever interface allows to load the tile data and it also allows to indicate that there is no data available for a tile. This allows to create low resolution overlays on high resolution data.

The following figure shows how such a multi-level tile structure looks like. Note that you can also define multi-level tiled structures that are not a quad-tree structure when using a MultilevelTiledRasterModelBuilder.

Multi-level tile structure.

This builder supports either imagery (RGBA) data or elevation data. The latter can be enabled by calling QuadTreeRasterModelBuilder.Elevation.

This article gives an example of how to use this class.

Since

2022.1

Constructor & Destructor Documentation

QuadTreeRasterModelBuilder()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder.QuadTreeRasterModelBuilder ( Luciad.Models.Rasters.QuadTreeRasterModelBuilder other )

inline

Copy constructor.

Parameters

other

the builder to copy.

Member Function Documentation

AttributionProvider()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.AttributionProvider ( Luciad.Models.Rasters.IMultilevelTiledAttributionProvider attributionProvider )

inline

Sets the attribution provider for this model.

By default, no attribution provider is set.

Parameters

attributionProvider

the attribution provider for the model. Can be null.

Returns

this builder.

Since

2024.0

Bounds()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Bounds ( Luciad.Geometries.Bounds bounds )

inline

Defines the extent of the raster data structure.

This information is mandatory.

Parameters

bounds

the extent of the raster data structure.

Returns

this builder.

Build()

Luciad.Models.Rasters.IRasterModel Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Build ( )

inline

Creates the raster model.

Mandatory information:

• the reference of the raster data
• the number of columns and rows at the least detail level
• the number of detail levels
• model metadata
• data retriever

Returns

the raster model, or a System.InvalidOperationException when the conditions to build the raster model are not met.

DataBounds()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.DataBounds ( Luciad.Geometries.Bounds bounds )

inline

Defines the extent of where actual data is a available.

This information is optional. If not defined the extent of the data is assumed to be based the entire structure.

Parameters

bounds

the extent of the 'actual' data.

Returns

this builder.

DataRetriever()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.DataRetriever ( Luciad.Models.Rasters.IMultilevelTiledRasterDataRetriever dataRetriever )

inline

Defines the implementation to be used to retrieve the raster tile data.

This information is mandatory. A user implementation must be provided.

Parameters

dataRetriever

the interface that is called to retrieve the raster tile data. Cannot be null.

Returns

this builder.

Dispose()

void Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Dispose ( )

inline

Elevation()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Elevation ( )

inline

Marks this model as an elevation model.

If this method is called, the configured IMultilevelTiledRasterDataRetriever must return elevation data as well. See IMultilevelTiledRasterDataRetrieverCallback.OnDataAvailable and IMultilevelTiledRasterDataRetrieverCallback.OnImageAvailable for more information.

Returns

this builder

ElevationNoDataValue()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.ElevationNoDataValue ( float noDataValue )

inline

Sets a no-data value for elevation data.

When the provided elevation data in IMultilevelTiledRasterDataRetrieverCallback contains this value, it is interpreted as a no-data value. This means that consumers of the data will have information that no data is available at that location, and that they can choose an appropriate fallback. For example when terrain is visualized, it can decide to fall back on other elevation data when it encounters a no-data elevation value.

This method is optional.

This method must only be called when the Elevation method is also called. If not, the Build method will throw an exception.

Parameters

noDataValue

the no-data value to use for elevation

Returns

this builder

Since

2023.0

EnableInvalidation()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.EnableInvalidation ( )

inline

Allows to create a raster model which can be invalidated.

By default raster models are created without invalidation.

Call this method when you need a raster model for which the content can change. Then a IRasterModel is created that returns true for IRasterModel.CanInvalidate and for which you can call the method IRasterModel.Invalidate to indicate the content of the raster model has changed.

Returns

this builder.

Level0ColumnCount()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Level0ColumnCount ( uint colCount )

inline

Defines the number of columns at the least detailed level.

This information is mandatory.

Parameters

colCount

the number of tiles on the column of the least detailed level.

Returns

this builder.

Level0RowCount()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Level0RowCount ( uint rowCount )

inline

Defines the number of row at the least detailed level.

This information is mandatory.

Parameters

rowCount

the number of tiles on the row of the least detailed level.

Returns

this builder.

LevelCount()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.LevelCount ( uint levelCount )

inline

Defines the number of detail levels.

This information is mandatory.

Parameters

levelCount

the number of detail levels.

Returns

this builder.

ModelMetadata()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.ModelMetadata ( Luciad.Models.ModelMetadata modelMetadata )

inline

Defines the model metadata.

This information is mandatory.

Parameters

modelMetadata

the model metadata.

Returns

this builder.

NewBuilder()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.NewBuilder ( )

inlinestatic

Creates the builder class to create a raster model.

Returns

the builder class for creation of a 'basic' IRasterModel.

Reference()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.Reference ( Luciad.Geodesy.CoordinateReference modelReference )

inline

Defines the reference in which the raster data is defined.

This information is mandatory.

Parameters

modelReference

the reference for the raster data. Cannot be null.

Returns

this builder.

SamplingMode()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.SamplingMode ( Luciad.Rasters.RasterSamplingMode samplingMode )

inline

Defines the sampling mode of the data.

This information is optional. The default value is Area.

Parameters

samplingMode

the sampling mode of the data.

Returns

this builder.

TileHeightPixels()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.TileHeightPixels ( uint tileHeightPixels )

inline

Defines the height in pixels for a single tile.

This information is mandatory.

Parameters

tileHeightPixels

the height, in pixels, for a tile within the tiled structure.

Returns

this builder.

TileWidthPixels()

Luciad.Models.Rasters.QuadTreeRasterModelBuilder Luciad.Models.Rasters.QuadTreeRasterModelBuilder.TileWidthPixels ( uint tileWidthPixels )

inline

Defines the width in pixels for a single tile.

This information is mandatory.

Parameters

tileWidthPixels

the width, in pixels, for a tile within the tiled structure.

Returns

this builder.