PK_FACE_replace_with_sheet

PK_ERROR_code_t                       PK_FACE_replace_with_sheet
(
--- received arguments ---
int                                   n_faces,   --- number of faces
const PK_FACE_t                       faces[],   --- target faces to replace
const PK_BODY_t                       sheet,     --- replacement sheet
const PK_FACE_replace_with_sheet_o_t *options,   --- options

--- returned arguments ---
PK_TOPOL_track_r_t             *const tracking,  --- tracking information
PK_TOPOL_local_r_t             *const results    --- status information
)


This function replaces a set of faces on a target body with a
set of faces from a sheet body.



Specific Errors:
    PK_ERROR_bad_tolerance         (MILD) proposed edge tolerance is too small
    PK_ERROR_unsuitable_entity     (MILD) body is not a sheet or solid body
    PK_ERROR_wrong_entity_in_array (MILD) given topols are not from same body
    PK_ERROR_not_in_same_partition (MILD) faces and sheet not in same partition
    PK_ERROR_laminar_edge          (MILD) face to be replaced has a laminar
                                          edge and isn't part of patch data
    PK_ERROR_not_on_surface        (MILD) geometry of given edges is not
                                          coincident with geometry of faces




INTRODUCTION
The specified 'faces' in the target body are replaced by faces from the
sheet tool body, 'sheet'.

Topology in the target body which intersects the tool faces, but which is
not explicitly identified as a target face, will be preserved.

The tool body is destroyed by the replace operation.

See Replacing faces with a sheet body for more information.

RECALCULATING EDGE AND VERTEX GEOMETRY
Edge and vertex geometry will be recalculated if necessary.

RESTRICTIONS AND LIMITATIONS
The following restrictions and limitations apply to this function :

  o The supplied sheet body must be sufficiently large to
    completely cover the faces being replaced without extension.

  o The supplied sheet body must be sufficiently close
    to the faces being replaced so that, if necessary, the underlying
    geometry of the target faces may be extended to find intersections
    without causing the faces of the target body to become
    self-intersecting.

  o The supplied sheet body must be correctly orientated such that
    resulting face normals of the patched regions will be consistent
    with other faces in the target body.

  o The supplied faces must have no laminar edges, unless those faces form
    part of the patch data.

TRACKING INFORMATION
The PK_TOPOL_track_t structure contains topology tracking information on
the operation. In the case of this function, only tracking information
records of the type PK_TOPOL_track_create_c may be returned.


ERROR HANDLING
If this function returns PK_ERROR_no_errors, the result of the operation
will be indicated by the value of the 'status' field of the 'results'
structure. When this value is not PK_local_status_ok_c or
PK_local_status_nocheck_c, it indicates an operation failure and an array
of entities involved in this failure is returned through the field
'error_entities' of the 'results' structure, when possible.
For more information regarding the failure status code and the error_entities,
refer to the PK documentation of the PK_TOPOL_local_r_t structure.