api_del_entity
List of: Functions
Subjects: Model Topology
Contents: Kernel

Action: Deletes the given entity.

Prototype: outcome api_del_entity (


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 its associated entities. This loses all entities that are connected to the given entity. It will lose multiple bodies if they are connected by attributes. It does not affect any pointers that were pointing to any of the objects. This allows you to delete an entire entity from anywhere in the entity's topological hierarchy without having to traverse to the top of the topology chain.

Errors: Pointer to entity is NULL.

Limitations: Deletes entities above as well as below the specified entity in the hierarchy.

Library: kernel

Filename: kern/kernel/kernapi/api/kernapi.hxx

Effect: Changes model
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0034.HTM