|
Action:
|
Clears annotation entities from the currently active bulletin board.
|
|
|
Prototype:
|
outcome api_clear_annotations (
|
|
|
AcisOptions* ao = NULL
|
// acis options
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kernapi/api/acis_options.hxx"
|
|
|
Description:
|
Searches the global list of annotations and loses them. This should be called at some point after a modeling operation, such as sweeping or blending. Once the annotation information has been handled, it must be cleared from the active bulletin board using
api_clear_annotations before the next modeling operation. Ideally, the operation to be annotated should be wrapped in an
API_BEGIN/END block so the call to
api_clear_annotations will restore the bulletin board to a state as if annotations had never been created.
|
|
|
Not calling
api_clear_annotations can lead to a bloated bulletin board as well as incorrect links between separate modeling operations when option
unhook_annotations is
FALSE.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
System routine
|