 |
PK_ENTITY_range_o_t |
|
struct PK_ENTITY_range_o_s
{
int o_t_version; --- version number of option
--- structure
PK_range_bound_t bound; --- bounds on min/max separation
PK_range_type_t range_type; --- whether to find the global min
--- or the global max distance
--- (PK_range_type_minimum_c) [NF]
PK_range_param_entity_t param_entity; --- option to return a vector and
--- parameter on the sub-entity
--- (if applicable). Also controls
--- whether a fin can be returned
--- as the sub_entity.
--- (PK_range_param_entity_topol_c)
int n_guesses_1; --- number of guesses for the
--- first entity array (0)
const PK_range_guess_t *guesses_1; --- guesses for the first entity
--- array (NULL) [NF]
int n_guesses_2; --- number of guesses for the
--- second entity array (0)
const PK_range_guess_t *guesses_2; --- guesses for the second entity
--- array (NULL) [NF]
int n_param_bounds_1;
--- number of parameter bounds for
--- the first array of geometrical
--- entities (0)
const PK_range_param_bound_t
*param_bounds_1; --- parameter bounds for the first
--- array of geometrical entities
--- (NULL) [PF]
int n_param_bounds_2;
--- number of parameter bounds for
--- the second array of geometrical
--- entities (0)
const PK_range_param_bound_t
*param_bounds_2; --- parameter bounds for the second
--- array of geometrical entities
--- (NULL) [PF]
};
typedef struct PK_ENTITY_range_o_s PK_ENTITY_range_o_t;
Holds optional controls for finding the global minimum/maximum separation
between two arrays of entities.
Used in:
PK_ENTITY_range
'bound' : structure consisting of:
'have_upper_bound': whether an upper bound is supplied.
'upper_bound' : an upper bound on the minimum/maximum
distance to be computed.
If supplied, when finding the minimum
distance, the minimum distance
achieved will only be returned if
it is less than the upper bound.
If supplied, when finding the maximum
distance, the maximum distance
achieved will only be returned if it
is less than or equal to the upper
bound.
'have_lower_bound': whether a lower bound is supplied.
'lower_bound' : a lower bound on the minimum/maximum
distance to be computed.
If supplied, when finding the minimum
distance, the minimum distance
achieved will only be returned if it
is greater than or equal to the lower
bound.
If supplied, when finding the maximum
distance, the maximum distance
achieved will only be returned if it
is greater than the lower bound.
'range_type' : an option for specifying whether to find the global
minimum or the global maximum distance.
'param_entity' : option to return a vector and parameter on the sub-entity
if applicable. The option is not supported currently.
It should be left at the default value.
(PK_range_param_entity_topol_c)
'n_guesses_1' : value indicating the length of the array estimate
structures for the first entity array.
If the length is non-zero, it must take the
value of 'n_entities_1'.
`guesses_1 : an array of estimate structures, for the first
entity array, of the form:
'type' : form of guess, either:
PK_range_guess_no_c : no guess
PK_range_guess_param_c : parametric guess
PK_range_guess_vector_c : position guess
'parameters': an array of up to 2 parameters
'vector' : end position vector.
Guesses are only allowed for entity arrays of length 1
(i.e. 'n_entities_1' == 1 and 'n_entities_2' == 1 ).
For an edge, a curve parameter estimate may be supplied.
For a face, surface parameter estimates may be supplied.
For an edge or face, a position vector estimate
may be supplied. Such an estimate is expected to
be on or close to the entity.
Note that either a position vector estimate or a parameter
estimate may be specified, but not both.
'n_guesses_2' : value indicating the length of the array estimate
structures for the second entity array.
If the length is non-zero, it must take the
value of 'n_entities_2'.
'guesses_2' : an array of estimate structures for the second
entity array. See details at description of 'guesses_1'.
'n_param_bounds_1' : integer indicating the lengths of the arrays of
'param_bounds_1' structures. If the length is
non-zero, it must take the value of 'n_entities_1'.
'param_bounds_1' : an array of structures for supplying the parameter range
information for the first entity array.
If no parameter range is supplied for the first
entity array the 'param_bounds_1' can be NULL.
Note that supplying parameter range information is for
geometrical inputs only. Supplying parameter bounds for
surfaces of class PK_CLASS_mesh is not supported.
'n_param_bounds_2' : integer indicating the lengths of the arrays of
'param_bounds_2' structures. If the length is
non-zero, it must take the value of 'n_entities_2'.
'param_bounds_2' : an array of structures for supplying the parameter range
information for the second entity array.
If no parameter range is supplied for the second
entity array the 'param_bounds_2' can be NULL.
Note that supplying parameter range information is for
geometrical inputs only. Supplying parameter bounds for
surfaces of class PK_CLASS_mesh is not supported.