Functions | |
HC_BOOLEAN | PShow_One_Net_Color_Map (int count, const 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. More... | |
HC_BOOLEAN | PShow_One_Net_Color_Map_By_V (int count, const HC_KEY *keys, int offset, char *color_space, float *x, float *y, float *z) |
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. More... | |
void | Show_One_Color_Map (int offset, char *color) |
Shows a single entry in the current virtual color map. More... | |
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. More... | |
Detailed Description
Function Documentation
◆ PShow_One_Net_Color_Map()
HC_BOOLEAN PShow_One_Net_Color_Map | ( | int | count, |
const 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
By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key. For additional details, see Show_One_Color_Map().
◆ PShow_One_Net_Color_Map_By_V()
HC_BOOLEAN PShow_One_Net_Color_Map_By_V | ( | int | count, |
const HC_KEY * | keys, | ||
int | offset, | ||
char * | color_space, | ||
float * | x, | ||
float * | y, | ||
float * | z | ||
) |
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. x - 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. y - z -
DETAILS
By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key. For additional details, see Show_One_Color_Map().
◆ Show_One_Color_Map()
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 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.
◆ Show_One_Color_Map_By_Value()
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()