 |
PK_CURVE_find_vectors |
|
PK_ERROR_code_t PK_CURVE_find_vectors
(
--- received arguments ---
PK_CURVE_t curve, --- curve
PK_INTERVAL_t t_int, --- interval
double tolerance, --- tolerance
const PK_CURVE_find_vectors_o_t *options, --- options
--- returned arguments ---
PK_CURVE_find_vectors_r_t *const found_vectors --- result
)
This function returns position vectors on the supplied curve given measurements
in 3-space.
Specific Errors:
PK_ERROR_cant_get_vectors (MILD) The operation failed. Returned only
on request.
PK_ERROR_bad_chord (MILD) Chord measurements have been supplied
in 'options' but the start and end
point of the curve are not distinct
(up to 'tolerance').
PK_ERROR_not_implemented (MILD) Returned if 'curve' is a 2D BCURVE.
PK_ERROR_bad_tolerance (MILD) The given 'tolerance' has to be larger
than 1.0e-8.
PK_ERROR_interval_exceed_period (MILD) The given 'curve' is periodic and the
supplied interval 't_int' is longer
than the period of 'curve'.
PK_ERROR_bad_interval (MILD) The 'curve' could not be evaluated
at either (or both) ends of the
interval.
PK_ERROR_no_measurements (MILD) No 'measurements' have been supplied
via 'options'.
The required part of the curve is bounded by the given interval 't_int'. The
function will return position vectors on the required part of the curve. The
returned position vectors satisfy (up to 'tolerance') the conditions imposed
by the 'measurements' supplied in 'options'. The 'measurements' are either
distances in 3-space or ratios of distances in 3-space. See the documentation
of the option structure PK_CURVE_find_vectors_o_t for the details on how
the 'measurements' are defined.
The position vectors are returned in the return structure 'found_vectors' of
type PK_CURVE_find_vectors_r_t. Note that for some 'measurement_methods'
the position vectors on the curve may not be unique. In these cases all
position vectors on the required part of the curve will be returned. Each
position vector will be matched to its corresponding entry in 'measurements'
through an index. If a certain value in 'measurements' corresponds to several
position vectors the index of this value will appear multiple times. The return
structure also holds status information about the position vectors. See the
documentation of the return structure for more details.
The error PK_ERROR_cant_get_vectors is only returned if requested via the
option structure. See its documentation for details.