PK_BODY_imprint_body

PK_ERROR_code_t PK_BODY_imprint_body
(
--- received arguments ---
PK_BODY_t                    target,      --- target body
PK_BODY_t                    tool,        --- tool body
const PK_BODY_imprint_o_t   *options,     --- imprint options [PF]

--- returned arguments ---
PK_imprint_r_t        *const results      --- imprint results
)


This function imprints edges on the given target and tool bodies.

This function offers partial support for facet geometry [PF]


Specific Errors:
    PK_ERROR_cant_do_imprint          imprint failure (SERIOUS)
    PK_ERROR_wire_body                target or tool body is wire body
                                      or face of wire body (MILD)
    PK_ERROR_missing_geom             target or tool has incomplete geometry
                                      (MILD)
    PK_ERROR_same_tool_and_target     target and tool are the same body
                                      (MILD)
    PK_ERROR_unsupported_operation    target or tool body is not a sheet body
                                      and general topology is not enabled
                                      when completing imprint (MILD)
    PK_ERROR_bad_tolerance            proposed tolerance is too small (MILD)
    PK_ERROR_cant_complete_imprint    unable to complete the imprint
                                      (SERIOUS)
    PK_ERROR_ambiguous_imprint        completion of the imprint is
                                      ambiguous (SERIOUS)
    PK_ERROR_bad_combination          a mixture of facet and classic geometry
                                      has been supplied (MILD)
    PK_ERROR_not_in_same_partition    target in a different partition to tool
                                      (MILD)



Introduction

The function takes the target and tool bodies and adds edges and
vertices where the faces intersect (except where they already
exist). The corresponding imprinted (or original) edges and vertices
are returned in matching arrays contained within the results
structure. Vertices are returned only where they are isolated points
of contact between the target and tool faces.

The target and tool bodies can each be a solid or sheet body although solid
bodies are not supported for all combinations of imprint completion, please see
documentation of imprint completion options for details.

See Imprinting for more information.

Imprint Options

The option structure passed to this function provides the application
programmer with the following controls:

 o Restrict imprint to the target body only
 o Imprint boundaries of overlapping areas
 o Complete partial imprints on target and tool bodies

Refer to the PK_BODY_imprint_o_t documentation for more detailed
information about the options within this structure.


Returned Arguments

Refer to the PK_imprint_r_t documentation for information
about the arrays returned in the 'results' structure.


Error Reporting

When an error occurs the function will, where possible, make extra
information related to the error available to the application via the
standard form of the error. This information will consist of either a
single or a group of topological or geometric entities.

This mechanism is identical to that of the PK boolean functions.
Refer to PK_BODY_boolean for a more detailed description of
the error reporting mechanism.