|
Action:
|
Deletes an entity and subentities, which are entities below the given entity in the topological hierarchy.
|
|
|
Prototype:
|
outcome api_delent (
|
|
|
ENTITY* given_entity,
|
// entity to be deleted
|
|
|
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/kernapi/api/acis_options.hxx"
|
|
|
Description:
|
This API deletes an entity and all entities below it in the topological hierarchy.
|
|
|
Errors:
|
Pointer to entity is
NULL or not to topology (BODY,
LUMP,
WIRE, etc.).
|
|
|
Limitations:
|
Pointers above the deleted entity in the topological hierarchy are not guaranteed to be set to
NULL. For example, when a lump is deleted, the body pointer to the lump may or may not be set to
NULL. This function loses the given topological entity, all lower-level topological entities comprising the given entity, and reduces the use count. It could possibly remove any associated geometry. It does not affect any pointers that were pointing to any of the objects. When using this API, pointers that used to point to the entity need to be fixed, or the item could be unhooked and then deleted.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Changes model
|