Functions
Show_Marker_XXX

Functions

HC_EXTERNAL HIC_API char HIC_Show_Marker_Symbol (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API const char * HIC_Show_Marker_Name (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Size (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Color_Red (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Color_Green (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Color_Blue (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Marker_Color (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Contrast_Color_Red (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Contrast_Color_Green (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API float HIC_Show_Marker_Contrast_Color_Blue (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Marker_Contrast_Color (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_Marker_Position (HIC_Marker const *marker)
 
HC_EXTERNAL HIC_API int HIC_Show_Marker_X_Size (HIC_Rendition const *nr)
 
HC_EXTERNAL HIC_API int HIC_Show_Marker_Y_Size (HIC_Rendition const *nr)
 

Detailed Description

Function Documentation

HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Marker_Color ( HIC_Rendition const *  nr)
Parameters
nrA pointer to a const HIC_Rendition.
Returns
A HIC_Integer32.
HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Marker_Contrast_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 marker contrast color.

HC_EXTERNAL HIC_API float HIC_Show_Marker_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 marker color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Marker_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 marker color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Marker_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 marker color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Marker_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 marker contrast color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Marker_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 marker contrast color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Marker_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 marker contrast color as a float value with a range 0 to 1.

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

This function returns the marker glyph name or symbol as a string.

See also
HIC_Show_Marker_Symbol
HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Marker_Position ( HIC_Marker const *  marker)
Parameters
markerA pointer to a const HIC_Marker.
Returns
A pointer to a const HIC_Point, given with respect to object coordinates.

This function gets the position of a given marker.

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

This function returns the marker size as a float value.

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

This function returns the marker symbol as a char.

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

This function gets the marker x size;

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

This function gets the marker y size;