|
Action:
|
Finds all active entities associated with a history stream.
|
|
|
Prototype:
|
outcome api_get_active_entities (
|
|
|
HISTORY_STREAM const* hs,
|
// stream to search
|
|
|
ENTITY_LIST& ents,
|
// list into which active
|
|
|
|
|
// entities are placed
|
|
|
logical unowned_only
|
// filter flag
|
|
|
|
= FALSE,
|
|
|
AcisOptions* ao = NULL
|
// acis options
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "baseutil/logical.h"
|
|
#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:
|
This API finds all of the "active" entities associated with a history stream (i.e. created and not yet deleted in the main line). These entities are added to the entity list
ents. Note that
ents is not cleared by this routine, since this routine has "append to" syntax.
|
|
|
A
TRUEunowned_only flag indicates that the user is only interested in a minimal set of highest level entities, typically a list of bodies. It filters out any entities which are not top-level, as well any points, curves, surfaces, transforms, annotations, or attributes found by scanning the remaining entities with a
SCAN_DISTRIBUTE flag. (It ignores any entities which are owned.)
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|