PK_FACE_find_outer_loop

PK_ERROR_code_t                    PK_FACE_find_outer_loop
(
--- received arguments ---
PK_FACE_t                          face,       --- face to find outer loop
const PK_FACE_find_outer_loop_o_t *options,    --- provided options

--- returned arguments ---
PK_LOOP_t *const                   outer_loop  --- the outer loop returned
)


The function returns the outer loop of the given face.


Specific Errors:
    PK_ERROR_missing_geom         Face does not have geometry. (MILD)
    PK_ERROR_failure              The function has failed to find the outer
                                  loop, e.g. due to a failure in finding loop
                                  types. (MILD)
    PK_ERROR_loop_is_sliver       Sliver loop (long thin loop without
                                  interior) has been found. (MILD)


Where one of the face loops can be readily interpreted as defining the overall
extent of the face on the surface with the remaining loops subtracting regions
from it, PK_FACE_find_outer_loop will return that loop.

The types of loops on a given face (see loop types in documentation of
PK_LOOP_ask_type) depend on the behaviour of the underlying surface of the
face which requires that the face has a surface attached. Attempting to find
the outer loop of a face with no surface geometry will result in the error
PK_ERROR_missing_geom.

If the face has no loops, for example, a whole face on a sphere, then
PK_ENTITY_null will be returned.

If the outer loop cannot be determined because a parameter seam is not
imprinted, then PK_ENTITY_null will be returned.

If the face has facet geometry, PK_ENTITY_null will be returned.