Package net.nullved.pmweatherapi.util

Class ColorMap.Builder

java.lang.Object

net.nullved.pmweatherapi.util.ColorMap.Builder

Enclosing class:

ColorMap

public static class ColorMap.Builder
extends Object

A Builder pattern for creating a ColorMap

Since:

0.14.15.6

Method Summary

Modifier and Type	Method	Description
ColorMap.Builder	addPoint(Color color, float threshold)	Adds a point to lerp between.
ColorMap	build(Color finalColor, float finalThreshold)	Builds this ColorMap.Builder into a proper ColorMap
static ColorMap.Builder	of(Color base)	Creates a new ColorMap.Builder with the given Color as the base
ColorMap.Builder	override(Color color, float threshold)	Adds an override point.
ColorMap.Builder	overrideModeGreater()	Use in cases where you want overrides to only apply when the value is greater, but not equal to the threshold.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

public static ColorMap.Builder of(Color base)

Creates a new ColorMap.Builder with the given Color as the base

Parameters:

base - The base Color

Returns:

The created ColorMap.Builder

Since:

0.14.15.6

overrideModeGreater

public ColorMap.Builder overrideModeGreater()

Use in cases where you want overrides to only apply when the value is greater, but not equal to the threshold. Used in ColorMaps.POSITIVE_VELOCITY and ColorMaps.NEGATIVE_VELOCITY

Returns:

This ColorMap.Builder

Since:

0.14.15.6

addPoint

public ColorMap.Builder addPoint(Color color,
 float threshold)

Adds a point to lerp between.

Parameters:

color - The color at the end of the last ColorMap.LerpSegment and the start of this ColorMap.LerpSegment

threshold - The threshold value

Returns:

This ColorMap.Builder

Since:

0.14.15.6

override

public ColorMap.Builder override(Color color,
 float threshold)

Adds an override point. The final Color will get overwritten once it reaches the threshold value specified

Parameters:

color - The Color to override the final Color with

threshold - The threshold value

Returns:

This ColorMap.Builder

Since:

0.14.15.6

build

public ColorMap build(Color finalColor,
 float finalThreshold)

Builds this ColorMap.Builder into a proper ColorMap

Parameters:

finalColor - The max Color

finalThreshold - The max threshold value

Returns:

A completed ColorMap

Since:

0.14.15.6