com.esri.arcgis.display
Interface IHlsColor
- All Superinterfaces:
- IColor, Serializable
- All Known Implementing Classes:
- HlsColor
public interface IHlsColor
- extends IColor, Serializable
Provides access to members that control the HLS color model.
Description
IHlsColor maintains information about a Color by using the HLS (Hue, Saturation, Lightness) color model. This color model is similar to the HSV color model, however, HLS colors use Lightness instead of 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 Lightness property is a number between 0 and 100 indicating the lightness, or paleness, of a color. Regardless of other properties, a lightness of 0 is always black, and a lightness of 100 is always white. All of the properties have a default of 0; therefore, the default HLSColor 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 IHlsColor (0-360). |
int |
getLightness()
The lightness component of an IHlsColor (0-100). |
int |
getSaturation()
The saturation component of an HlslColor (0-100). |
void |
setHue(int hue)
The hue component of an IHlsColor (0-360). |
void |
setLightness(int lightness)
The lightness component of an IHlsColor (0-100). |
void |
setSaturation(int saturation)
The saturation component of an HlslColor (0-100). |
Methods inherited from interface com.esri.arcgis.display.IColor |
getCIELAB, getCMYK, getRGB, getTransparency, isNullColor, isUseWindowsDithering, setCIELAB, setCMYK, setNullColor, setRGB, setTransparency, setUseWindowsDithering |
setHue
void setHue(int hue)
throws IOException,
AutomationException
- The hue component of an IHlsColor (0-360).
Description
Hue is the value of the hue component of a HlsColor 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 IHlsColor (0-360).
Description
Hue is the value of the hue component of a HlsColor 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.
setLightness
void setLightness(int lightness)
throws IOException,
AutomationException
- The lightness component of an IHlsColor (0-100).
Description
Lightness is the value of the lightness component of a HlsColor 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:
lightness
- The lightness (in)
- Throws:
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
getLightness
int getLightness()
throws IOException,
AutomationException
- The lightness component of an IHlsColor (0-100).
Description
Lightness is the value of the lightness component of a HlsColor 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 lightness
- 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 HlslColor (0-100).
Description
Saturation is the value of the saturation component of a HlsColor 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 HlslColor (0-100).
Description
Saturation is the value of the saturation component of a HlsColor 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.