Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

Implements

Index

Constructors

constructor

Accessors

aboveRangeColor

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.

belowRangeColor

belowRangeColor: Color4Like

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

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

Readonly rangeMaximum

rangeMaximum: number

The maximum range of the mapper

Readonly rangeMinimum

rangeMinimum: number

The minimum range of the mapper

undefinedColor

undefinedColor: Color4Like

The color used for undefined values.

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

Methods

createTexture

  • Creates and returns texture for this scalar mapper

    Returns Texture

domainValue

  • domainValue(normalizedPosition: number): number
  • Map normalized value (0 -> 1) into a domain value (range_min -> range_max)

    Parameters

    • normalizedPosition: number

    Returns number

mapToColor

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

    Parameters

    • scalarValue: number

    Returns Color4Like

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

normalizedValue

  • normalizedValue(domainValue: number): number
  • Map domain value (range_min -> range_max) into a normalized value (0 -> 1)

    Parameters

    • domainValue: number

    Returns number

setup

  • setup(colorsFromToArray: ArrayLike<Color4Like>, tickValuesArray: ArrayLike<number>): 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<Color4Like>
    • tickValuesArray: ArrayLike<number>

    Returns void

tickValuesHint

  • tickValuesHint(): ArrayLike<number>
  • Returns ArrayLike<number>

version

  • version(): number
  • Returns number

Generated using TypeDoc