HC_Flush_By_Key

void HC_Flush_By_Key(Key key)
void HC_Flush_By_Key(Key key)

Throws away the contents of a geometric primitive or a segment but leaves the structure intact.

If key refers to a polyline, polygon, or shell, all the points (and all of the faces) within the primitive are removed. New points, if desired, can be added with Edit_Polyline() , Edit_Polygon() , or Edit_Shell_Faces() .

If key refers to text, all the characters are removed. New characters can be added with Edit_Text() or via user input with Enable_String_Events() .

Flush_By_Key() is a quick method of making sure all the contents of a piece of geometry are gone. The “Edit” routines take more work and only remove some of the contents.

Lastly, if key refers to a segment, this call becomes a call to Flush_Geometry() on the segment. If the key refers to a Style or an Include, nothing happens.

HC_Flush_Contents, HC_Delete_By_Key, HC_Edit_Polygon, HC_Edit_Polyline, HC_Edit_Shell_Faces, HC_Edit_Text.

Parameters

key: Key returned by a previously called routine.