PK_TOPOL_range_vector_o_t

struct PK_TOPOL_range_vector_o_s
    {
    int                     o_t_version;    --- version number of option
                                            --- structure
    PK_LOGICAL_t            have_tolerance; --- (PK_LOGICAL_false)
    double                  tolerance;      --- tolerance
    PK_range_bound_t        bound;          --- bounds on min separation
    PK_range_guess_t        guess;          --- guess for end on 'topol' [PF]
    PK_range_opt_t          opt_level;      --- the level of analysis
                                            --- (PK_range_opt_performance_c)
    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)
   };

typedef struct PK_TOPOL_range_vector_o_s PK_TOPOL_range_vector_o_t;



Holds optional controls for finding the global minimum separation between a
topological entity and a position.

Used in:

PK_TOPOL_range_vector

'have_tolerance'   : whether a tolerance value is provided.

'tolerance'        : a tolerance on the accuracy of the minimum distance
                     measurement. This will allow slacker computation of
                     minimum distance, when default accuracy is not required.
                     The default accuracy will be the linear precision
                     of the modeller.

'bound'            : option structure consisting of:
                     'have_upper_bound': whether an upper bound is supplied.
                     `upper_bound      : an upper bound on the minimum
                                         distance to be computed.
                                         If supplied, the minimum distance
                                         achieved will only be identified
                                         if it is less than the bound.
                     'have_lower_bound': whether a lower bound is supplied.
                     `lower_bound      : a lower bound on the minimum distance.
                                         For this option, if the closest
                                         approach between entities is found
                                         to be less than this bound, no
                                         solution will be determined.

'guess'            : An estimate structure, for the end of the separation
                     on the entity, 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.

                     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.
                     Both parameter and position vector estimates cannot
                     be supplied.
                     Note that for a face with a surface of class
                     PK_CLASS_mesh, providing an estimate is not supported.

'opt_level'        : an option to control the level of analysis that is
                     undertaken to resolve closely separated local minima.
                     (PK_range_opt_performance_c)

'param_entity'     : option to return a vector and parameter on the sub-entity
                     if applicable. This will always be the case for bodies.
                     Additionally, this option controls whether a fin can be
                     returned as the 'sub_entity'
                     (PK_range_param_entity_topol_c)


See here for more information about the options available.