 |
PK_BODY_enlarge_r_t |
|
struct PK_BODY_enlarge_r_s
{
int r_t_version; --- version number of return
--- structure
int n_bodies; --- number of bodies
PK_BODY_t *bodies; --- enlarged bodies
PK_ENTITY_track_r_t tracking; --- tracking information
PK_TOPOL_local_r_t results; --- status information
};
typedef struct PK_BODY_enlarge_r_s PK_BODY_enlarge_r_t;
A structure packaging the result from PK_BODY_enlarge.
Used in:
PK_BODY_enlarge
PK_BODY_enlarge_r_f
The structure has the following fields:
'n_bodies' The number of enlarged bodies.
'bodies' The enlarged bodies.
'tracking' Mapping between the original and enlarged entities. This is
controlled by the options structure on a class-by-class basis.
A record of type PK_TOPOL_track_create_c will be created for each
entity of a requested class, and can result in one or more
product entities.
When the enlarged body is trimmed to the size box or the supplied
trimming box, Parasolid will indicate the bounding plane used
to trim by returning tracking with negative original entities.
Each bounding plane returned will have a corresponding original
class of type PK_CLASS_plane, and are defined by:
------------------------------------
| Bounding Plane | Original Entity |
------------------------------------
| Minimum X | -1 |
| Minimum Y | -2 |
| Minimum Z | -3 |
| Maximum X | -4 |
| Maximum Y | -5 |
| Maximum Z | -6 |
------------------------------------
New trimming faces, created to bound solid regions of the
enlarged body, will have a single bounding plane as the original
entity.
New edges and vertices created by trimming can have both entities
from the input 'body' and bounding planes as original entities.
'results' 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.
The function PK_BODY_enlarge_r_f may be used to free associated memory.