Brief Index      Full Index      I.M. Reference

Show_One_Color_Map


Functions

void Show_One_Color_Map (int offset, char *color)
void Show_One_Color_Map_By_Value (int offset, char *color_space, float *a, float *b, float *c)
void QShow_One_Color_Map (const char *segment, int offset, char *color)
void QShow_One_Color_Map_By_Value (const char *segment, int offset, char *color_space, float *a, float *b, float *c)
void Show_One_Net_Color_Map (int offset, char *color)
void Show_One_Net_Color_Map_By_V (int offset, char *color_space, float *a, float *b, float *c)
void PShow_One_Net_Color_Map (int count, HC_KEY *keys, int offset, char *color)
void PShow_One_Net_Color_Map_By_V (int count, HC_KEY *keys, int offset, char *color_space, float *a, float *b, float *c)
void QShow_One_Net_Color_Map (const char *segment, int offset, char *color)
void QShow_One_Net_Color_Map_By_V (const char *segment, int offset, char *color_space, float *a, float *b, float *c)

Function Documentation

void Show_One_Color_Map ( int  offset,
char *  color 
)

Shows a single entry in the current virtual color map.

Parameters:
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color - A string which contains an English description of the desired color. Returned to caller. Passed by reference in all languages.

DETAILS

Show_One_Color_Map gives you back the value of a single color map entry. This may be more convenient than the regular Show_Color_Map routines, which return the entire color map at once.

NOTES

The names Show_One_Net_Color_Map_By_V and QShow_One_Net_Color_Map_By_V are not misprints---spelling out _By_Value unfortunately exceeds a 31 character limit on the length of subroutine names.

The color_space is returned to you, not passed in. In the present implementation, the color will be equivalent to the color you originally set, but it won't necessarily be written the same way. For example, if you set a color by RGB value, the system may, at its discretion, return an HLS color when asked to show that color. If you want a particular color space, use Compute_Color() on the return values.

RESTRICTIONS

See also:
Show_One_(Attribute), Set_Color_Map, Set_Color.

void Show_One_Color_Map_By_Value ( int  offset,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color_Map(), but returns the value of a single attribute in the currently open segment. Operates with a color values rather than names or map indices.

Parameters:
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color_space - Special constant---either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a - The location in the color space---hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b -
c -

DETAILS

No additional details. See Show_One_Color_Map()

void QShow_One_Color_Map ( const char *  segment,
int  offset,
char *  color 
)

Similar to Show_One_Color_Map(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Name of the segment to be examined.
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color - A string which contains an English description of the desired color. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_One_Color_Map()

void QShow_One_Color_Map_By_Value ( const char *  segment,
int  offset,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color_Map(), but returns the value of a single attribute in a given segment, rather than the currently open one. Operates with a color values rather than names or map indices.

Parameters:
segment - Name of the segment to be examined.
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color_space - Special constant---either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a - The location in the color space---hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b -
c -

DETAILS

No additional details. See Show_One_Color_Map()

void Show_One_Net_Color_Map ( int  offset,
char *  color 
)

Similar to Show_One_Color_Map(), but returns the net effective value of a single attribute in the currently open segment.

Parameters:
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color - A string which contains an English description of the desired color. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_One_Color_Map()

void Show_One_Net_Color_Map_By_V ( int  offset,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color_Map(), but returns the net effective value of a single attribute in the currently open segment. Operates with a color values rather than names or map indices.

Parameters:
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color_space - Special constant---either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a - The location in the color space---hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b -
c -

DETAILS

No additional details. See Show_One_Color_Map()

void PShow_One_Net_Color_Map ( int  count,
HC_KEY *  keys,
int  offset,
char *  color 
)

Similar to Show_One_Color_Map(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's.

Parameters:
count - The size of the keys array
keys - The list of keys starting with the owning segment and following
all the way back to the root segment or other desired segment.
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color - A string which contains an English description of the desired color. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_One_Color_Map()

void PShow_One_Net_Color_Map_By_V ( int  count,
HC_KEY *  keys,
int  offset,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color_Map(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. Operates with a color values rather than names or map indices.

Parameters:
count - The size of the keys array
keys - The list of keys starting with the owning segment and following
all the way back to the root segment or other desired segment.
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color_space - Special constant---either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a - The location in the color space---hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b -
c -

DETAILS

No additional details. See Show_One_Color_Map()

void QShow_One_Net_Color_Map ( const char *  segment,
int  offset,
char *  color 
)

Similar to Show_One_Color_Map(), but returns the net effective value of a single attribute in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be examined.
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color - A string which contains an English description of the desired color. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_One_Color_Map()

void QShow_One_Net_Color_Map_By_V ( const char *  segment,
int  offset,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color_Map(), but returns the net effective value of a single attribute in a given segment, rather than the currently open one. Operates with a color values rather than names or map indices.

Parameters:
segment - Name of the segment to be examined.
offset - Offset within the color that is to be shown. The very first entry in the color map is at offset zero.
color_space - Special constant---either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a - The location in the color space---hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b -
c -

DETAILS

No additional details. See Show_One_Color_Map()

Main Index
Brief Index      Full Index      I.M. Functions