PK_TOPOL_range_o_t

struct PK_TOPOL_range_o_s
    {
    int                 o_t_version;    --- version number of option structure
    PK_LOGICAL_t        have_tolerance; --- whether tolerance value is provided
                                        --- (PK_LOGICAL_false)
    double              tolerance;      --- tolerance on accuracy of distance
                                        --- measurement
                                        --- (session precision)
    PK_range_bound_t    bound;          --- bounds on the minimum/maximum
                                        --- distance
    PK_range_guess_t    guesses[2];     --- guesses for each end [NF]
    PK_range_type_t     range_type;     --- whether to find the global minimum
                                        --- or the global maximum distance
                                        --- (PK_range_type_minimum_c) [NF]
    PK_range_opt_t      opt_level;      --- the level of analysis
                                        --- (PK_range_opt_performance_c)
    };

typedef struct PK_TOPOL_range_o_s PK_TOPOL_range_o_t;



Holds optional controls for finding the global minimum/maximum distance
between two topological entities.

Used in:

PK_TOPOL_range

'have_tolerance'   : whether a tolerance value is provided.

'tolerance'        : a tolerance on the accuracy of the minimum/maximum
                     distance measurement. This will allow slacker computation
                     of minimum/maximum 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/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.

'guesses'          : An array of two estimate structures, one for each end
                     of the separation, 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.

'range_type'       : an option for specifying whether to find the global
                     minimum or the global maximum distance.

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

See here for more information about the options available.