Luciad.Layers.Rasters.RasterLayer.Builder Class Reference

Builder for creating a luciad::RasterLayer for a luciad::IRasterModel. More...

Inheritance diagram for Luciad.Layers.Rasters.RasterLayer.Builder:

Public Member Functions
	Builder (Luciad.Layers.Rasters.RasterLayer.Builder other)
Luciad.Layers.Rasters.RasterLayer	Build ()
	Returns a new layer, based on the properties set on this builder. More...
Luciad.Layers.Rasters.RasterLayer.Builder	DetailFactor (double factor)
	Sets the detail factor to use. More...
void	Dispose ()
Luciad.Layers.Rasters.RasterLayer.Builder	FillStyle (Luciad.Layers.Styles.FillStyle fillStyle)
	Sets the fill style used when the raster data extent is shown when zoomed out far. More...
Luciad.Layers.Rasters.RasterLayer.Builder	LineStyle (Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle lineStyle)
	Sets the line style used when the raster data extent is shown when zoomed out far. More...
Luciad.Layers.Rasters.RasterLayer.Builder	LineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Sets the line style used when the raster data extent is shown when zoomed out far. More...
Luciad.Layers.Rasters.RasterLayer.Builder	Model (Luciad.Models.Rasters.IRasterModel model)
	Sets the raster model of the layer. More...
Luciad.Layers.Rasters.RasterLayer.Builder	RasterStyle (Luciad.Layers.Styles.RasterStyle rasterStyle)
	Sets the style for this raster. More...
Luciad.Layers.Rasters.RasterLayer.Builder	Title (string title)
	Sets the title to use for the layer. More...
Luciad.Layers.Rasters.RasterLayer.Builder	Visible (bool visible)
	Sets whether the layer should be visible initially. More...

Detailed Description

Builder for creating a luciad::RasterLayer for a luciad::IRasterModel.

Styling color data

By default, color data is visualized using the image's own color model. The raster values are only painted if the pixel density of the raster is not too high. Otherwise the bounds of the raster is painted instead. The style for painting the bounds of the raster data can be customized. You can find an example within this related article on basic raster styling.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder.

Constructor & Destructor Documentation

Builder()

Luciad.Layers.Rasters.RasterLayer.Builder.Builder ( Luciad.Layers.Rasters.RasterLayer.Builder  other )

inline

Member Function Documentation

Build()

Luciad.Layers.Rasters.RasterLayer Luciad.Layers.Rasters.RasterLayer.Builder.Build ( )

inline

Returns a new layer, based on the properties set on this builder.

a new layer, based on the properties set on this builder.

luciad::InvalidArgumentException

when the raster tile set structure is not supported.

luciad::LogicException

If not all mandatory parameters are set.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::build.

DetailFactor()

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.DetailFactor ( double  factor )

inline

Sets the detail factor to use.

The detail factor modifies the quality/detail of the loaded data.

factor

The factor to apply. A factor 1 means no change (default value). A factor > 1 means more detail. A factor < 1 means less detail.

this builder.

InvalidArgumentException

if the factor is not strictly positive.

2020.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::detailFactor.

Dispose()

void Luciad.Layers.Rasters.RasterLayer.Builder.Dispose ( )

inline

FillStyle()

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.FillStyle ( Luciad.Layers.Styles.FillStyle  fillStyle )

inline

Sets the fill style used when the raster data extent is shown when zoomed out far.

fillStyle

a fill style created with luciad::FillStyle::newBuilder.

this builder.

2020.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::fillStyle.

LineStyle() [1/2]

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.LineStyle ( Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle  lineStyle )

inline

Sets the line style used when the raster data extent is shown when zoomed out far.

Only one line style can be set, if this function is called when a LineStyle has already been set, it will be overwritten.

lineStyle

a complex stroke line style created with luciad::ComplexStrokeLineStyle::newBuilder.

this builder.

2023.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::lineStyle.

LineStyle() [2/2]

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.LineStyle ( Luciad.Layers.Styles.LineStyle  lineStyle )

inline

Sets the line style used when the raster data extent is shown when zoomed out far.

Only one line style can be set, if this function is called when a ComplexStrokeLineStyle has already been set, it will be overwritten.

lineStyle

a line style created with luciad::LineStyle::newBuilder.

this builder.

2020.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::lineStyle.

Model()

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.Model ( Luciad.Models.Rasters.IRasterModel  model )

inline

Sets the raster model of the layer.

Calling this function is mandatory.

model

the raster model of the layer.

this builder.

NullArgumentException

if model is nullptr.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::model.

RasterStyle()

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.RasterStyle ( Luciad.Layers.Styles.RasterStyle  rasterStyle )

inline

Sets the style for this raster.

rasterStyle

the raster style to apply.

this builder.

2023.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::rasterStyle.

Title()

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.Title ( string  title )

inline

Sets the title to use for the layer.

If not set, the title from the ModelMetadata is used.

title

the title for the layer.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::title.

Visible()

Luciad.Layers.Rasters.RasterLayer.Builder Luciad.Layers.Rasters.RasterLayer.Builder.Visible ( bool  visible )

inline

Sets whether the layer should be visible initially.

Default is true.

visible

the visibility.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RasterLayer::Builder::visible.