struct PK_section_2_r_s
{
PK_section_result_t result; --- result of sectioning operation
int n_front_bodies; --- number of front bodies
PK_BODY_t *front_bodies; --- bodies in front of section
int n_back_bodies; --- number of back bodies
PK_BODY_t *back_bodies; --- bodies behind section
int n_front_faces; --- number of front faces
PK_FACE_t *front_faces; --- faces in front of section
int n_back_faces; --- number of back faces
PK_FACE_t *back_faces; --- faces behind section
int n_reports; --- number of reports
PK_section_report_r_t *reports; --- array of report structures
};
typedef struct PK_section_2_r_s PK_section_2_r_t;
This structure contains the results of a section operation for bodies
or faces.
The arrays of entities are returned under the control of the fence
field of an options structure, and will be set to (NULL, 0) if not
requested, or empty (length of zero).
Description of fields:
result This status field indicates the overall state of
the sectioning operation. Permitted values are :
PK_section_result_success_c
PK_section_result_no_clash_c
PK_section_result_no_effect_c
PK_section_result_failed_c
n_front_bodies The number of bodies in the front_bodies array.
front_bodies The array of resultant bodies in front of the
sectioning tool. If the result field is set
to PK_section_result_failed_c, the array will
be set to null.
n_back_bodies The number of bodies in the back_bodies array.
back_bodies The array of resultant bodies behind the
sectioning tool. If the result field is set
to PK_section_result_failed_c, the array will
be set to null.
n_front_faces The number of faces in the front_faces array.
front_faces The array of new faces of the resultant bodies
in front of the sectioning tool. If the result
field is set to PK_section_result_failed_c, the
array will be set to null.
n_back_faces The number of faces in the back_faces array.
back_faces The array of new faces of the resultant bodies
behind the sectioning tool. If the result field
is set to PK_section_result_failed_c, the array
will be set to null.
n_reports The number of sectioning reports in the reports
array.
reports This array may contain supplementary information
regarding the outcome of the sectioning operation.
For example, if the operation failed, the reports
may contain topology related to the failure.
Destroying the returned data structure
When the application wishes to free the memory associated
with the results structure, the function PK_section_2_r_f
must be used.