|
Action:
|
Gets all faces related to an entity.
|
|
|
Prototype:
|
outcome api_get_faces (
|
|
|
ENTITY* ent,
|
// entity to examine
|
|
|
ENTITY_LIST& face_list,
|
// faces related to
|
|
|
|
|
// entity
|
|
|
PAT_NEXT_TYPE include_pat// how to treat
|
|
|
|
= PAT_CAN_CREATE,
|
// patterned faces
|
|
|
AcisOptions* ao = NULL
|
// acis options
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/data/entity.hxx"
|
|
#include "kernel/kerndata/lists/lists.hxx"
|
|
#include "kernel/kernapi/api/acis_options.hxx"
|
|
#include "kernel/kernutil/law/pattern_enum.hxx"
|
|
|
Description:
|
If the input entity (ent) is a
BODY,
LUMP, or
SHELL, this API returns all
FACEs of that entity. If the input entity is an
EDGE,
LOOP, or
VERTEX, this API returns all
FACEs that share the
EDGE,
LOOP, or
VERTEX.
|
|
|
By default, patterned objects are included in the list of entities. In general, however, the parameter include_pat determines how this function deals with such objects. The user may specify any one of the following through this argument:
|
|
|
PAT_CAN_CREATE - patterned objects are created if they do not already exist, and are included in the list.
|
|
PAT_NO_CREATE - only those patterned objects that have already been created are included in the list.
|
|
PAT_IGNORE - no patterned objects besides seed pattern objects are included in the list.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|