Package noaa.coastwatch.render

Class ColorArrowSymbol

java.lang.Object

jahuwaldt.plot.PlotSymbol

noaa.coastwatch.render.PointFeatureSymbol

noaa.coastwatch.render.DirectionSymbol

noaa.coastwatch.render.ArrowSymbol

noaa.coastwatch.render.ColorArrowSymbol

All Implemented Interfaces:

Serializable, Cloneable, ColorEnhanced

public class ColorArrowSymbol
extends ArrowSymbol
implements ColorEnhanced

A ColorArrowSymbol is similar to a normal arrow but it has the additional feature that arrows are colored according to a color enhancement scheme based on the vector magnitude.

Since:

3.2.0

Author:

Peter Hollemans

See Also:

• Serialized Form

Field Summary

Fields inherited from class noaa.coastwatch.render.ArrowSymbol

componentAtts, isMagDir

Fields inherited from class noaa.coastwatch.render.PointFeatureSymbol

feature

Constructor Summary

Constructors

Constructor	Description
ColorArrowSymbol(int uComponentAtt, int vComponentAtt, Palette pal, EnhancementFunction func)	Creates a new color arrow symbol based on U and V components.
ColorArrowSymbol(int magnitudeAtt, int directionAtt, EarthTransform2D trans, Palette pal, EnhancementFunction func)	Creates a new color arrow symbol based on magnitude and direction components.

Method Summary

Modifier and Type	Method	Description
void	draw(Graphics gc, int x, int y)
EnhancementFunction	getFunction()	Gets the enhancement function.
Color	getMissingColor()	Gets the missing value color.
Palette	getPalette()	Gets the enhancement color palette.
void	setFunction(EnhancementFunction func)	Sets the enhancement function.
void	setMissingColor(Color color)	Sets the missing value color.
void	setPalette(Palette pal)	Sets the enhancement color palette.

Methods inherited from class noaa.coastwatch.render.ArrowSymbol

drawVector, getDirection, getMagnitude, main

Methods inherited from class noaa.coastwatch.render.DirectionSymbol

convertAngle, getDirectionIsFrom, setDirectionIsFrom

Methods inherited from class noaa.coastwatch.render.PointFeatureSymbol

setFeature

Methods inherited from class jahuwaldt.plot.PlotSymbol

clone, getBorderColor, getFillColor, getSize, setBorderColor, setFillColor, setSize

Methods inherited from class java.lang.Object

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

Constructor Details

ColorArrowSymbol

public ColorArrowSymbol(int uComponentAtt,
 int vComponentAtt,
 Palette pal,
 EnhancementFunction func)

Creates a new color arrow symbol based on U and V components.

Parameters:

uComponentAtt - the feature attribute for U component.

vComponentAtt - the feature attribute for V component.

pal - the color palette for color enhancement.

func - the enhancement function.

ColorArrowSymbol

public ColorArrowSymbol(int magnitudeAtt,
 int directionAtt,
 EarthTransform2D trans,
 Palette pal,
 EnhancementFunction func)

Creates a new color arrow symbol based on magnitude and direction components.

Parameters:

magnitudeAtt - the feature attribute for vector magnitude.

directionAtt - the feature attribute for vector direction.

trans - the earth transform used for converting directions.

pal - the color palette for color enhancement.

func - the enhancement function.

Method Details

getPalette

public Palette getPalette()

Gets the enhancement color palette.

Specified by:

getPalette in interface ColorEnhanced

setPalette

public void setPalette(Palette pal)

Sets the enhancement color palette.

Specified by:

setPalette in interface ColorEnhanced

getFunction

public EnhancementFunction getFunction()

Gets the enhancement function.

Specified by:

getFunction in interface ColorEnhanced

setFunction

public void setFunction(EnhancementFunction func)

Sets the enhancement function.

Specified by:

setFunction in interface ColorEnhanced

getMissingColor

public Color getMissingColor()

Gets the missing value color.

Specified by:

getMissingColor in interface ColorEnhanced

setMissingColor

public void setMissingColor(Color color)

Sets the missing value color.

Specified by:

setMissingColor in interface ColorEnhanced

draw

public void draw(Graphics gc,
 int x,
 int y)

Overrides:

draw in class DirectionSymbol