|
Action:
|
Finds all annotation entities of a given type.
|
|
|
Prototype:
|
outcome api_find_annotations (
|
|
|
ENTITY_LIST&,
|
// list of annotation
|
|
|
|
|
// entities
|
|
|
is_fun
|
// test for specific
|
|
|
|
= is_ANNOTATION,
|
// type of annotation
|
|
|
BULLETIN_BOARD* bb
|
// obsolete, ignored
|
|
|
|
= NULL,
|
|
|
AcisOptions* = NULL
|
// acis options
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/bulletin/bulletin.hxx"
|
|
#include "kernel/kerndata/lists/lists.hxx"
|
|
#include "kernel/kernapi/api/acis_options.hxx"
|
|
|
Description:
|
When the annotations option is turned on, certain modeling operations like blending or sweeping produce
ANNOTATION class instances in internal
ENTITY_LIST. The
api_find_annotations function can be used to acquire a list of those annotations for user-defined processing. Generally, annotations are cleared manually from the list by using
api_clear_annotations before the next modeling operation.
|
|
|
The flag for
is_fun defaults to
is_ANNOTATION. However, any
is_ function for a class can be used. So, for example, to get the top vertex annotations from a sweep operation, this function can be passed
is_SWEEP_ANNO_VERTEX_TOP as an argument.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|