api_get_modified_faces
List of: Functions
Subjects: History and Roll
Contents: Kernel

Action: Finds faces that have been deleted, created, or modified since a particular state.

Prototype: outcome api_get_modified_faces (


DELTA_STATE* ds,
// start state


ENTITY_LIST& deleted_faces, // deleted since





// start


ENTITY_LIST& created_faces, // created since





// start


ENTITY_LIST& modified_faces, // modified since





// start


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/bulletin/bulletin.hxx"

#include "kernel/kerndata/lists/lists.hxx"

#include "kernel/kernapi/api/acis_options.hxx"

Description: This routine is intended to find lists of faces that have been created, deleted, or modified between the (input) start state and the current state of the history stream that contains that state.


For the purposes of this API, a face is not considered modified if its associated attributes or bounding box changes, but it is considered modified if one of its "contained" entities is modified. These contained entities are its surface, loops, coedges, edges (and associated curves) and vertices (and associationed points).


The intended use of this API is to allow customers to avoid refaceting faces which can be determined (by examining the history stream) to be unchanged since the start state. Because of this, the algorithm to identify "modified" faces is conservative: whenever it is unclear whether a change recorded in the history stream actually affected a face in a manner which requires refaceting, that face is included in the "modified" list. This ensures that all faces which require refaceting will be included at one of the lists, at the expense of introducing occasional "false positives" into the "modified" list.


This API clears the deleted, created, and modified lists before writing to them (it overwrites them).

Errors: Roll back state not on history stream main branch.

Library: kernel

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

Effect: Read-only
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0064.HTM