Show_Marker_XXX

Detailed Description

group Show_Marker_XXX

Function Documentation

char HIC_Show_Marker_Symbol(HIC_Rendition const *nr)

This function returns the marker symbol as a char.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A char.
const char *HIC_Show_Marker_Name(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A pointer to a const char.
float HIC_Show_Marker_Size(HIC_Rendition const *nr)

This function returns the marker size as a float value.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Marker_Color_Red(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Marker_Color_Green(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Marker_Color_Blue(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Marker_Color_Alpha(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
HIC_Integer32 HIC_Show_Internal_Marker_Color(HIC_Rendition const *nr)
Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A HIC_Integer32.
float HIC_Show_Marker_Contrast_Color_Red(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Marker_Contrast_Color_Green(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Marker_Contrast_Color_Blue(HIC_Rendition const *nr)

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

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
HIC_Integer32 HIC_Show_Internal_Marker_Contrast_Color(HIC_Rendition const *nr)

This function returns the internal representation of the marker contrast color.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A HIC_Integer32.
HIC_Point const *HIC_Show_Marker_Position(HIC_Marker const *marker)

This function gets the position of a given marker.

Parameters:marker – A pointer to a const HIC_Marker.
Returns:A pointer to a const HIC_Point, given with respect to object coordinates.
int HIC_Show_Marker_X_Size(HIC_Rendition const *nr)

This function gets the marker x size;

Parameters:marker – A pointer to a const HIC_Rendition.
Returns:An int.
int HIC_Show_Marker_Y_Size(HIC_Rendition const *nr)

This function gets the marker y size;

Parameters:marker – A pointer to a const HIC_Rendition.
Returns:An int.