com.esri.arcgis.display
Interface IHsvColor

All Superinterfaces:

IColor, Serializable

All Known Implementing Classes:

HsvColor

public interface IHsvColor
extends IColor, Serializable

Provides access to members that control the HSV color values.

Description

IHsvColor maintains information about a Color by using the HSV (Hue, Saturation, and Value) color model. Colors are defined by three read-write properties: Hue, Saturation, and Value. The Hue property may be set to a number between 0 and 360, indicating in degrees where the hue lies on the color wheel. The Saturation property is a number between 0 and 100 indicating the saturation, or purity, of the color, and the Value property is a number between 0 and 100 indicating the value, or brightness, of a color. All of the properties have a default value of 0; therefore, the default HSVColor is black.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

IHsvColor, IHlsColor

Method Summary

int	getHue() The hue component of an IhsvColor (0-360).
int	getSaturation() The saturation component of an IhsvColor (0-100).
int	getValue() The value component of an IhsvColor (0-100).
void	setHue(int hue) The hue component of an IhsvColor (0-360).
void	setSaturation(int saturation) The saturation component of an IhsvColor (0-100).
void	setValue(int value) The value component of an IhsvColor (0-100).

Methods inherited from interface com.esri.arcgis.display.IColor

getCIELAB, getCMYK, getRGB, getTransparency, isNullColor, isUseWindowsDithering, setCIELAB, setCMYK, setNullColor, setRGB, setTransparency, setUseWindowsDithering

Method Detail

setHue

void setHue(int hue)
            throws IOException,
                   AutomationException

The hue component of an IhsvColor (0-360).

Description

Hue is the value of the hue component of a HsvColor object. The valid value range is 0-360.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

hue - The hue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHue

int getHue()
           throws IOException,
                  AutomationException

The hue component of an IhsvColor (0-360).

Description

Hue is the value of the hue component of a HsvColor object. The valid value range is 0-360.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The hue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaturation

void setSaturation(int saturation)
                   throws IOException,
                          AutomationException

The saturation component of an IhsvColor (0-100).

Description

Saturation is the value of the saturation component of a HsvColor object. The valid value range is 0-100.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

saturation - The saturation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaturation

int getSaturation()
                  throws IOException,
                         AutomationException

The saturation component of an IhsvColor (0-100).

Description

Saturation is the value of the saturation component of a HsvColor object. The valid value range is 0-100.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The saturation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(int value)
              throws IOException,
                     AutomationException

The value component of an IhsvColor (0-100).

Description

Value is the value of the value component of a HsvColor object. The valid value range is 0-100.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

int getValue()
             throws IOException,
                    AutomationException

The value component of an IhsvColor (0-100).

Description

Value is the value of the value component of a HsvColor object. The valid value range is 0-100.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.