Functions | |
void | Show_Color_Map (char *colors) |
void | PShow_Net_Color_Map (int key_count, const HC_KEY *path_keys, char *colors) |
void Show_Color_Map | ( | char * | colors | ) |
Returns the color map that has been set on the currently open segment by a previous call to Set_Color_Map().
colors | A long string that contains English descriptions of the desired colors, separated by commas within the string. Note that the "by value" routines below are the ones most people use. Passed by reference. Returned to user. |
When the value being passed back is a string, be sure you've declared your string variable to be long enough.
In C, "passed by reference" means that you have to allocate an appropriate variable, either statically or off the stack, and pass a pointer to that variable to the HOOPS routine. To generate a pointer to a variable C, you prefix the variable with a "&". In other languages you normally don't have to do anything different from usual.
The Show_Color_Map() routines will complain if they're called and the attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.
void PShow_Net_Color_Map | ( | int | key_count, | |
const HC_KEY * | path_keys, | |||
char * | colors | |||
) |
Similar to Show_Color_Map(), but returns the net effective setting along a discrete segment path.
key_count | The size of pathkeys | |
path_keys | An array of HC_KEY's delineating a path of segments. | |
colors | A long string that contains English descriptions of the desired colors, separated by commas within the string. Note that the "by value" routines below are the ones most people use. Passed by reference. Returned to user. |
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 other details, see Show_Color_Map()