Luciad.Layers.Styles.RasterStyle.Builder Class Reference

Builder for raster styles. More...

Inheritance diagram for Luciad.Layers.Styles.RasterStyle.Builder:

Public Member Functions
	Builder (Luciad.Layers.Styles.RasterStyle.Builder other)
Luciad.Layers.Styles.RasterStyle.Builder	Brightness (double brightness)
	Sets the brightness. More...
Luciad.Layers.Styles.RasterStyle	Build ()
	Returns a newly created raster style, based on the properties set on this builder. More...
Luciad.Layers.Styles.RasterStyle.Builder	Contrast (double contrast)
	Sets the contrast. More...
void	Dispose ()
Luciad.Layers.Styles.RasterStyle.Builder	ModulationColor (System.Drawing.Color color)
	Sets the color that is modulated with the raster. More...
Luciad.Layers.Styles.RasterStyle.Builder	Opacity (double opacity)
	Sets the opacity of the raster. More...

Detailed Description

Builder for raster styles.

The default raster style has a white modulation color, with brightness, contrast and transparency values all equal to 1. Example usage:

2023.1

Warning

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

Constructor & Destructor Documentation

Builder()

Luciad.Layers.Styles.RasterStyle.Builder.Builder ( Luciad.Layers.Styles.RasterStyle.Builder  other )

inline

Member Function Documentation

Brightness()

Luciad.Layers.Styles.RasterStyle.Builder Luciad.Layers.Styles.RasterStyle.Builder.Brightness ( double  brightness )

inline

Sets the brightness.

The brightness is a value in [0, 2]. A value of 1 (the default) leaves the brightness unchanged. Values larger than 1 makes the colors brighter, while a value smaller than 1 makes the colors less bright. This parameter is optional. If not set, default is 1.

brightness

the brightness

this builder.

luciad::InvalidArgumentException

when brightness < 0 or brightness > 2.

Warning

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

Build()

Luciad.Layers.Styles.RasterStyle Luciad.Layers.Styles.RasterStyle.Builder.Build ( )

inline

Returns a newly created raster style, based on the properties set on this builder.

a newly created raster style, based on the properties set on this builder.

Warning

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

Contrast()

Luciad.Layers.Styles.RasterStyle.Builder Luciad.Layers.Styles.RasterStyle.Builder.Contrast ( double  contrast )

inline

Sets the contrast.

The contrast is a value in [0, 2]. A value of 1 (the default) leaves the contrast unchanged. A value larger than 1 enhances the contrast of dark colors by making them brighter, while a value smaller than 1 enhances the contrast of bright colors by making them darker. This parameter is optional. If not set, default is 1.

contrast

the contrast

this builder.

luciad::InvalidArgumentException

when contrast < 0 or contrast > 2.

Warning

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

Dispose()

void Luciad.Layers.Styles.RasterStyle.Builder.Dispose ( )

inline

ModulationColor()

Luciad.Layers.Styles.RasterStyle.Builder Luciad.Layers.Styles.RasterStyle.Builder.ModulationColor ( System.Drawing.Color  color )

inline

Sets the color that is modulated with the raster.

For example using a raster with gray-scale colors and a red modulation color will result in a resulting painted raster with red hues. Using a white color has no effect. This parameter is optional. If not set, default is white.

color

the modulation color

this builder.

Warning

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

Opacity()

Luciad.Layers.Styles.RasterStyle.Builder Luciad.Layers.Styles.RasterStyle.Builder.Opacity ( double  opacity )

inline

Sets the opacity of the raster.

This can also be achieved by setting a modulation color with opacity directly. When both opacity and a modulation color are set, the opacity set using this method takes precedence over that of the modulation color. This parameter is optional. If not set, default is 1.

opacity

the alpha value. Must be contained in the [0, 1] interval (0 is fully transparent, 1 is fully opaque).

this builder.

luciad::InvalidArgumentException

when opacity < 0 or opacity > 1.

Warning

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