1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
/*
WARNING: This file was generated by dkct.
Changes you make here will be lost if dkct is run again!
You should modify the original source and run dkct on it.
Original source: dk3xsp.ctr
*/
/*
Copyright (C) 2012-2017, Dirk Krause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/** @file dk3xsp.h Header file for the dk3xsp module.
*/
#ifndef DK3XSP_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3XSP_H_INCLUDED 1
#line 8 "dk3xsp.ctr"
#include "dk3all.h"
#ifdef __cplusplus
extern "C" {
#endif
/** Reset spline segment data.
All components - including cb - are reset.
@param pseg Spline segment data to reset.
*/
void
dk3xsp_reset(dk3_xspline_segment_t *pseg);
/** Set compatility bug flag.
@param pseg Spline segment data to modify.
@param v New flag value (1 or 0).
*/
void
dk3xsp_set_cb(dk3_xspline_segment_t *pseg, int v);
/** Set control points.
@param pseg Spline segment data to modify.
@param a Control point A (may be NULL).
@param b Control point B.
@param c Control point C.
@param d Control point D (may be NULL).
*/
void
dk3xsp_set(
dk3_xspline_segment_t *pseg,
dk3_fig_spline_point_t const *a,
dk3_fig_spline_point_t const *b,
dk3_fig_spline_point_t const *c,
dk3_fig_spline_point_t const *d
);
/** Run calculation for a given t.
@param pseg Spline segment.
@param t The t parameter.
@param fder Flag: Calculate derivatives (1=yes, 0=no).
@return 1 on success, 0 on error.
*/
int
dk3xsp_calculate(
dk3_xspline_segment_t *pseg,
double t,
int fder
);
/** Retrieve calculation result.
@param pseg Spline segment.
@return Calculation result: x value.
*/
double
dk3xsp_get_x(dk3_xspline_segment_t const *pseg);
/** Retrieve calculation result.
@param pseg Spline segment.
@return Calculation result: y value.
*/
double
dk3xsp_get_y(dk3_xspline_segment_t const *pseg);
/** Retrieve calculation result.
@param pseg Spline segment.
@return Calculation result: dx/dt value.
*/
double
dk3xsp_get_dxdt(dk3_xspline_segment_t const *pseg);
/** Retrieve calculation result.
@param pseg Spline segment.
@return Calculation result: dy/dt value.
*/
double
dk3xsp_get_dydt(dk3_xspline_segment_t const *pseg);
/** Calculate X-spline segment interval length.
@param pseg Segment to calculate the length for.
@param prec Precision.
@param ec Pointer to error code variable, may be NULL.
@return Length (positive value) on success, negative value on error.
*/
double
dk3xsp_segment_length(
dk3_xspline_segment_t *pseg,
double prec,
int *ec
);
/** Calculate X-spline partial segment length.
@param pseg Segment to calculate the length for.
@param tstart Parameter t for start.
@param dir Direction (0=forward t to 1, 1=backward 0 to t).
@param prec Precision.
@param ec Pointer to error code variable, may be NULL.
@return Length (positive value) on success, negative value on error.
*/
double
dk3xsp_segment_partial_length(
dk3_xspline_segment_t *pseg,
double tstart,
int dir,
double prec,
int *ec
);
/** Check whether an s value is very close to 0.
@param s Value to check.
@return 1 if s==0, 0 otherwise.
*/
int
dk3xsp_is_null(double s);
/** Calculate length of open X-spline.
@param points Array of spline points.
@param np Number of points in array.
@param prec Numeric precision.
@param fslc Full segment length cache (np - 1) elements.
@param cb Flag: Compatibility bug.
@param ec Pointer to error code variable, may be NULL.
@return Length (positive value) on success, negative value on error.
*/
double
dk3xsp_open_spline_length(
dk3_fig_spline_point_t const *points,
size_t np,
double prec,
double *fslc,
int cb,
int *ec
);
/** Calculate length of open X-spline.
@param points Array of spline points.
@param np Number of points in array.
@param prec Numeric precision.
@param tstart Start/end t parameter.
@param fslc Full segment length cache, (np-1) elements.
@param dir Direction (0=forward t to 1, 1=backward 0 to t).
@param cb Flag: Compatibility bug.
@param ec Pointer to error code variable, may be NULL.
@return Length (positive value) on success, negative value on error.
*/
double
dk3xsp_open_spline_partial_length(
dk3_fig_spline_point_t const *points,
size_t np,
double prec,
double tstart,
double *fslc,
int dir,
int cb,
int *ec
);
/** Calculate t value for given distance to end point.
@param points X-spline points.
@param np Number of x-spline points.
@param dist Distance to endpoint.
@param prec Precision.
@param fslc Cache for full segment lengths.
@param dir End-point type: 0=end of spline, 1=start of spline.
@param cb Flag: Compatibility with spline bug.
@param ec Pointer to error code variable.
@return Non-negative value on success, negative value on error.
*/
double
dk3xsp_get_t_for_distance(
dk3_fig_spline_point_t const *points,
size_t np,
double dist,
double prec,
double *fslc,
int dir,
int cb,
int *ec
);
/** Run calculations for a given t value in the range 0<=t<=(np-1).
@param pseg Segment to use for calculation.
@param points Spline points.
@param np Number of points.
@param t Parameter t.
@param cb Flag: Compatibility for spline bug.
@param der Flag: Calculate derivatives dx/dt and dy/dt too.
@param ec Pointer to error code variable.
@return 1 on success, 0 on error.
*/
int
dk3xsp_calculate_position(
dk3_xspline_segment_t *pseg,
dk3_fig_spline_point_t const *points,
size_t np,
double t,
int cb,
int der,
int *ec
);
/** Find movement direction for a specified t value.
@param points X-spline points.
@param np Number of points.
@param t The t parameter 0<=t<=(np-1).
@param cb Flag: Compatibility for spline bug.
@param ec Pointer to error code variable.
@return Non-negative value 0<=res<=2*pi on success,
negative value on error.
*/
double
dk3xsp_direction(
dk3_fig_spline_point_t const *points,
size_t np,
double t,
int cb,
int *ec
);
/** Find position and movement direction for a specified t value.
@param xpos Pointer to variable for x position.
@param ypos Pointer to variable for y position.
@param points X-spline points.
@param np Number of points.
@param t The t parameter 0<=t<=(np-1).
@param cb Flag: Compatibility for spline bug.
@param ec Pointer to error code variable.
@return Non-negative value 0<=res<=2*pi on success,
negative value on error.
*/
double
dk3xsp_direction_and_position(
double *xpos,
double *ypos,
dk3_fig_spline_point_t const *points,
size_t np,
double t,
int cb,
int *ec
);
#ifdef __cplusplus
}
#endif
#ifndef DK3XSP_MAX_ITERATION_SEGMENTS
/** Maximum number of sub-segments in segment length iteration.
*/
#define DK3XSP_MAX_ITERATION_SEGMENTS 1073741824L
#endif
#endif
|
