Functions | |
void | Begin_Highlight_Search (int count, const HC_KEY *keys, const char *list) |
Searches for all highlights. More... | |
void | Determine_Highlight_Status (int count, HC_KEY const *keys, int *results, char const *options) |
Determines if a particular key path invokes highlights. More... | |
void | End_Highlight_Search () |
Discards any remaining results from this search. More... | |
bool | Find_Highlight (int *count, HC_KEY *keys, char *options) |
Returns the next highlight that was collected. More... | |
void | Show_Highlight_Count (int *count, int *max_keys) |
Returns the number of distinct highlights collected, and the maximum number of keys that will be returned in the results to Find_Highlight(). More... | |
void Begin_Highlight_Search | ( | int | count, |
const HC_KEY * | keys, | ||
const char * | list | ||
) |
Searches for all highlights.
count | Length of 'keys' array in parameter 2. Set count to zero if no path filtering is desired; otherwise the specified key path will be used to filter the results. |
keys | An array of HC_KEYs defining an unambiguous path to the highlighted object. Set keys to zero if count is zero and no path filtering is desired. |
list | list of styles, drawing mode, or passive/active highlight. See DETAILS section below. |
Using the list
parameter, the following filters can be applied to the highlight search:
void Determine_Highlight_Status | ( | int | count, |
HC_KEY const * | keys, | ||
int * | results, | ||
char const * | options | ||
) |
Determines if a particular key path invokes highlights.
count | Length of 'keys' array in parameter 2 |
keys | An array of HC_KEYs defining an unambiguous path to the highlighted object |
results | Returns a bit-encoded integer for each of the input keys. See below for specific values. |
options | Options to control the behavior of the function, can filter highlights in the same manner as in Begin_Highlight_Search() |
The parameter results
will be populated with a bit-encoded integer for each of the input keys, or a combination of these bitwise OR'd together:
void End_Highlight_Search | ( | ) |
bool Find_Highlight | ( | int * | count, |
HC_KEY * | keys, | ||
char * | options | ||
) |
Returns the next highlight that was collected.
count | - count of distinct highlights collected. The count returned is the number of keys filled in for the highlight path. |
keys | - keys returned. |
options | - Options used to filter results. Can use "style=style name", "passive" to find only passive highlights, and "geometry" if Define_Geometry_Highlight() was used to specify highlighting of parts of a shell or mesh. |
void Show_Highlight_Count | ( | int * | count, |
int * | max_keys | ||
) |
Returns the number of distinct highlights collected, and the maximum number of keys that will be returned in the results to Find_Highlight().
count | - count of distinct highlights collected. |
max_keys | - maximum number of keys that will be returned in the results from a call to Find_Highlight(). |
No additional details.