ScalarMapperContinuousPiecewise

class cee.ScalarMapperContinuousPiecewise()

Maps scalar values to texture coordinates/colors using a continuous/gradient style color map with multiple segments of independent gradients.

This scalar mapper is configured much in the same way as the ScalarMapperFilledContours, but here you are allowed to specify a bottom and top color for each level/segment.

Constructors

cee.ScalarMapperContinuousPiecewise.constructor()
ScalarMapperContinuousPiecewise(): ScalarMapperContinuousPiecewise

Returns: ScalarMapperContinuousPiecewise

Accessors

cee.ScalarMapperContinuousPiecewise.aboveRangeColor()

inherited

get aboveRangeColor(): Color4Like

The color to assign values that are above the given range.

Default is undefined, which indicates that the last color in the color array will be used.

Returns: Color4Like

set aboveRangeColor(color: Color4Like): void

Parameters

color: Color4Like

Returns: void

cee.ScalarMapperContinuousPiecewise.belowRangeColor()

inherited

get belowRangeColor(): Color4Like

The color to assign values that are below the given range.

Default is null, which indicates that the first color in the color array will be used.

Returns: Color4Like

set belowRangeColor(color: Color4Like): void

Parameters

color: Color4Like

Returns: void

cee.ScalarMapperContinuousPiecewise.rangeMaximum()
get rangeMaximum(): number

The maximum range of the mapper

Returns: number

cee.ScalarMapperContinuousPiecewise.rangeMinimum()
get rangeMinimum(): number

The minimum range of the mapper

Returns: number

cee.ScalarMapperContinuousPiecewise.undefinedColor()

inherited

get undefinedColor(): Color4Like

The color used for undefined values.

Returns: Color4Like

set undefinedColor(color: Color4Like): void

Parameters

color: Color4Like

Returns: void

Methods

cee.ScalarMapperContinuousPiecewise.createTexture()
createTexture(): Texture

Creates and returns texture for this scalar mapper

Returns: Texture

cee.ScalarMapperContinuousPiecewise.domainValue()
domainValue(normalizedPosition: number): number

Map normalized value (0 -> 1) into a domain value (range_min -> range_max)

Parameters

normalizedPosition: number

Returns: number

cee.ScalarMapperContinuousPiecewise.mapToColor()
mapToColor(scalarValue: number): Color4Like

Maps the given domain value to a color using the current range and color array.

Parameters

scalarValue: number

Returns: Color4Like

cee.ScalarMapperContinuousPiecewise.mapToTextureCoordinate()
mapToTextureCoordinate(scalarValue: number): Vec2Like

Maps the given domain value to a color using the current range and color array.

Parameters

scalarValue: number

Returns: Vec2Like

cee.ScalarMapperContinuousPiecewise.normalizedValue()
normalizedValue(domainValue: number): number

Map domain value (range_min -> range_max) into a normalized value (0 -> 1)

Parameters

domainValue: number

Returns: number

cee.ScalarMapperContinuousPiecewise.setup()
setup(colorsFromToArray: ArrayLike, tickValuesArray: ArrayLike): void

Sets the scalar mapper from the given tick values array and colors from/to

The tickValuesArray will contain the values separating each segment of the scalar mapper. The first value in tickValuesArray will be the min value of the scalar mapper, the last value will be the max value of the scalar mapper.

The colorsFromToArray contains bottom and top colors for each of the segments. colorsFromToArray[0] is the bottom of the first segment, colorsFromToArray[1] is the top of the first segment.

The colorsFromToArray.size must be 2*(tickValuesArray.length - 1)

Parameters

colorsFromToArray: ArrayLike

tickValuesArray: ArrayLike

Returns: void

cee.ScalarMapperContinuousPiecewise.tickValuesHint()
tickValuesHint(): ArrayLike

Returns: ArrayLike

cee.ScalarMapperContinuousPiecewise.version()
version(): number

Returns: number