All Frameworks  Class Hierarchy  This Framework  Indexes

SPAkern Global Function api_find_annotations

outcome api_find_annotations(	ENTITY_LIST&	`list_annotation`,
	is_fun	`anno`	`= is_ANNOTATION`,
	BULLETIN_BOARD*	`bb`	`= NULL`,
	AcisOptions*	`ao`	`= NULL`)

Finds all annotation entities of a given type.

Role: 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.

Effect: Read-only

Journal: Not Available

Parameters:

list_annotation: list of annotation entities.
annno: test for specific type of annotation.
bb: obsolete, ignored.
ao: acis options.

This object is included in the file: kernapi.hxx