Functions | |
void | Begin_Open_Item_Search (void) |
void | Show_Open_Item_Count (int *count) |
HC_BOOLEAN | Find_Open_Item (HC_KEY key, char *type, int *offset1, int *offset2) |
void | End_Open_Item_Search (void) |
void Begin_Open_Item_Search | ( | void | ) |
Returns the keys to all currently open segments or geometric primitives.
If the open item is an edge, offset1 and offset2 will contain the vertex indices at either end of the edge. If the open item is a vertex, face, LOD, region, or trim, offset1 will contain the appropriate index.
Show_Open_Item_Count() is only valid between Begin_Open_Item_Search() and End_Open_Item_Search(). It will always return the total number of open items, not the remaining number of open items.
void Show_Open_Item_Count | ( | int * | count | ) |
Finds out how many items will be returned. This is useful for determining the size of a data structure needed to store incoming items.
count | - The total number of open items returned by Find_Open_Item(). Returned to user. Passed by reference always. |
HC_BOOLEAN Find_Open_Item | ( | HC_KEY | key, | |
char * | type, | |||
int * | offset1, | |||
int * | offset2 | |||
) |
Retrieves the open items in a segment tree, one at a time. The function returns false when all items have been returned.
key | - Unique numeric identifier for an open item. Returned to user. Passed by reference always. | |
type | - A string that indicates the type of object represented by key. Returned to user. Passed by reference always. | |
offset1 | - If the open item is sub-geometry (an edge, vertex, face, LOD, region, trim, etc.) this will contain information about that object. Returned to user. Passed by reference always. | |
offset2 | - If the open item is an edge, this will contain the index of the second vertex of the edge. Returned to user. Passed by reference always. |
void End_Open_Item_Search | ( | void | ) |
Terminates the open item search sequence, and frees any involved memory.