LuciadCPillar 2024.0.02
luciad::RasterStyle Class Referencefinal

Style for rasters. More...

#include <luciad/layers/styles/RasterStyle.h>

Classes

class  Builder
 Builder for raster styles. More...
 

Public Member Functions

RasterStyle::Builder asBuilder () const
 Creates a new builder initialized with all the properties of this style. More...
 
double getBrightness () const
 Returns the brightness. More...
 
double getContrast () const
 Returns the contrast. More...
 
Color getModulationColor () const
 Returns the color that is modulated with the raster. More...
 
bool operator!= (const RasterStyle &other) const
 
bool operator== (const RasterStyle &other) const
 

Static Public Member Functions

static Builder newBuilder ()
 Creates a new builder with the default values. More...
 

Detailed Description

Style for rasters.

Construction of a raster style is done through the Builder design pattern mechanism.

Since
2023.1

Member Function Documentation

◆ asBuilder()

RasterStyle::Builder luciad::RasterStyle::asBuilder ( ) const

Creates a new builder initialized with all the properties of this style.

Returns
the new builder.

◆ getBrightness()

double luciad::RasterStyle::getBrightness ( ) const

Returns 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.

Returns
the brightness.

◆ getContrast()

double luciad::RasterStyle::getContrast ( ) const

Returns 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.

Returns
the contrast.

◆ getModulationColor()

Color luciad::RasterStyle::getModulationColor ( ) const

Returns 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.

Returns
the modulation color.

◆ newBuilder()

static Builder luciad::RasterStyle::newBuilder ( )
static

Creates a new builder with the default values.

Returns
the new builder.

◆ operator!=()

bool luciad::RasterStyle::operator!= ( const RasterStyle other) const

◆ operator==()

bool luciad::RasterStyle::operator== ( const RasterStyle other) const