Altus Mapping Engine JavaScript API Reference - v2.0.ut.2153.g60764257e - Tuesday May 16, 2022 SDK Documentation | Builds | BA3 Home
AltusUnified::ColorBar Class Reference

Public Member Functions

 ColorBar ()
 Creates an empty ColorBar. More...
 
double getMinHeight ()
 Gets the minimum height. More...
 
double getMaxHeight ()
 Gets the maximum height. More...
 
void addColor (double height, Color color)
 Adds a Color to this ColorBar. More...
 
void setWaterColor (Color color)
 Sets the water color. More...
 
Color getWaterColor ()
 Gets the water color. More...
 
Color getColor (double height)
 Gets the nearest Color greater than the given height, or the Color with the maximum height of this ColorBar. If the ColorBar is empty, a zeroed out Color is returned. More...
 
Color getColorBlended (double height)
 Gets a smoothly blended Color between closest matching entries to height More...
 
void setColor (double height, Color color)
 Sets the Color for a given height. More...
 
VectorColor toArray (int resolution)
 Gets a vector of colors from this ColorBar, given a resolution. More...
 
VectorByte toArrayRGB (int resolution)
 Gets a vector of RGB colors as ubyte's from this ColorBar, given a resolution. More...
 
VectorByte toArrayRGBA (int resolution)
 Gets a vector of RGBA colors as ubyte's from this ColorBar, given a resolution. More...
 
VectorByte toArrayNearestRGBA (int resolution)
 Gets a vector of nearest RGBA colors as ubyte's from this ColorBar, given a resolution. More...
 
ColorMap getColorMap ()
 Gets a the ColorMap backing this ColorBar More...
 

Constructor & Destructor Documentation

AltusUnified::ColorBar::ColorBar ( )

Creates an empty ColorBar.

Member Function Documentation

void AltusUnified::ColorBar::addColor ( double  height,
Color  color 
)

Adds a Color to this ColorBar.

Color AltusUnified::ColorBar::getColor ( double  height)

Gets the nearest Color greater than the given height, or the Color with the maximum height of this ColorBar. If the ColorBar is empty, a zeroed out Color is returned.

Color AltusUnified::ColorBar::getColorBlended ( double  height)

Gets a smoothly blended Color between closest matching entries to height

ColorMap AltusUnified::ColorBar::getColorMap ( )

Gets a the ColorMap backing this ColorBar

double AltusUnified::ColorBar::getMaxHeight ( )

Gets the maximum height.

double AltusUnified::ColorBar::getMinHeight ( )

Gets the minimum height.

Color AltusUnified::ColorBar::getWaterColor ( )

Gets the water color.

void AltusUnified::ColorBar::setColor ( double  height,
Color  color 
)

Sets the Color for a given height.

void AltusUnified::ColorBar::setWaterColor ( Color  color)

Sets the water color.

VectorColor AltusUnified::ColorBar::toArray ( int  resolution)

Gets a vector of colors from this ColorBar, given a resolution.

VectorByte AltusUnified::ColorBar::toArrayNearestRGBA ( int  resolution)

Gets a vector of nearest RGBA colors as ubyte's from this ColorBar, given a resolution.

Parameters
resolutionThe number of colors to return
VectorByte AltusUnified::ColorBar::toArrayRGB ( int  resolution)

Gets a vector of RGB colors as ubyte's from this ColorBar, given a resolution.

Parameters
resolutionThe number of colors to return
VectorByte AltusUnified::ColorBar::toArrayRGBA ( int  resolution)

Gets a vector of RGBA colors as ubyte's from this ColorBar, given a resolution.

Parameters
resolutionThe number of colors to return