Function Index Class Index

Show_Line_XXX

Functions

HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Line_Color (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Line_Contrast_Color (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Line_Color_Blue (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Line_Color_Green (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Line_Color_Red (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Line_Contrast_Color_Blue (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Line_Contrast_Color_Green (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Line_Contrast_Color_Red (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API char HIC_Show_Line_Pattern (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API const char * HIC_Show_Line_Style (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API int HIC_Show_Line_Weight (HIC_Rendition const *nr)
 

Detailed Description

Function Documentation

HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Line_Color ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A HIC_Integer32.

This function returns the internal representation of the line color.

HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Line_Contrast_Color ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
An HIC_Integer32.

This function returns the internal represantation of the line contrast color.

HC_EXTERNAL HIC_API float HIC_Show_Line_Color_Blue ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A float.

This function returns the blue component of the line color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Line_Color_Green ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A float.

This function returns the green component of the line color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Line_Color_Red ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A float.

This function returns the red component of the line color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Line_Contrast_Color_Blue ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A float.

This function returns the blue component of the line contrast color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Line_Contrast_Color_Green ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A float.

This function returns the green component of the line contrast color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Line_Contrast_Color_Red ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A float.

This function returns the red component of the line contrast color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API char HIC_Show_Line_Pattern ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A char.

This function returns the line pattern as a string.

HC_EXTERNAL HIC_API const char* HIC_Show_Line_Style ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A pointer to a const char.

This function returns the line style name as a string which is either a user-defined line style or line pattern such as "dashdot".

HC_EXTERNAL HIC_API int HIC_Show_Line_Weight ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
An int.

This function returns line weight as an int.