de.javagl.colors.maps.indexed

Interface IndexedColorMap1D

public interface IndexedColorMap1D

Interface for a simple, indexed, 1D color map.

Method Summary

Modifier and Type	Method and Description
Color	getColor(int index) Returns the color at the given index.
int	getSize() Returns the size (number of colors) of this color map

Method Detail

getSize

int getSize()

Returns the size (number of colors) of this color map

Returns:

The size

getColor

Color getColor(int index)

Returns the color at the given index.

This interface does not require a particular behavior for indices that are negative or not smaller than the size of this map, meaning that the behavior in these cases is implementation dependent.

The IndexedColorMaps.clamping(IndexedColorMap1D) and IndexedColorMaps.wrapping(IndexedColorMap1D) methods may be used to create instances that will never throw an IndexOutOfBoundsException.

Parameters:

index - The index

Returns:

The color

Throws:

IndexOutOfBoundsException - May be thrown if the index is negative or not smaller than the size