Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSurfaceTools.h
1 /// @cond (Gocator_2x00 || Gocator_3x00)
2 /**
3 * @file GoSurfaceTools.h
4 * @brief Declares all surface tools and their related classes.
5 *
6 * @internal
7 * Copyright (C) 2015 by LMI Technologies Inc.
8 * Licensed under the MIT License.
9 * Redistributed files must retain the above copyright notice.
10 */
11
12 #ifndef GO_SURFACE_TOOLS_H
13 #define GO_SURFACE_TOOLS_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/Tools/GoTool.h>
17 #include <GoSdk/Tools/GoSurfaceToolUtils.h>
18 #include <GoSdk/GoUtils.h>
19
20 kBeginHeader()
21
22 /**
23 * @class GoSurfaceTool
24 * @extends GoTool
25 * @ingroup GoSdk-SurfaceTools
26 * @brief Represents a base surface tool.
27 */
28 typedef GoTool GoSurfaceTool;
29
30 /**
31 * Sets the data source. Note that source validation will only occur if tool
32 * is in the tool options list.
33 *
34 * @public @memberof GoSurfaceTool
35 * @version Introduced in firmware 4.0.10.27
36 * @param tool GoSurfaceTool object.
37 * @param source GoDataSource object.
38 * @return Operation status.
39 * @see GoTools_ToolOptionCount, GoTools_ToolOptionAt
40 */
41 GoFx(kStatus) GoSurfaceTool_SetSource(GoSurfaceTool tool, GoDataSource source);
42
43 /**
44 * Gets the data source.
45 *
46 * @public @memberof GoSurfaceTool
47 * @version Introduced in firmware 4.0.10.27
48 * @param tool GoSurfaceTool object.
49 * @return The data source.
50 */
51 GoFx(GoDataSource) GoSurfaceTool_Source(GoSurfaceTool tool);
52
53 /**
54 * Gets the data source option list count.
55 *
56 * @public @memberof GoSurfaceTool
57 * @version Introduced in firmware 4.0.10.27
58 * @param tool GoSurfaceTool object.
59 * @return The current tool data source option list count.
60 */
61 GoFx(kSize) GoSurfaceTool_SourceOptionCount(GoSurfaceTool tool);
62
63 /**
64 * Gets the data source option at the given index.
65 *
66 * @public @memberof GoSurfaceTool
67 * @version Introduced in firmware 4.0.10.27
68 * @param tool GoSurfaceTool object.
69 * @param index The index of the option list to access.
70 * @return The tool data source option at the given index, or k32U_MAX if an invalid index is given.
71 */
72
73 GoFx(k32u) GoSurfaceTool_SourceOptionAt(GoSurfaceTool tool, kSize index);
74
75 /**
76 * Gets the X-anchoring option list count.
77 *
78 * @public @memberof GoSurfaceTool
79 * @version Introduced in firmware 4.0.10.27
80 * @param tool GoSurfaceTool object.
81 * @return The X-anchoring option list count.
82 */
83 GoFx(kSize) GoSurfaceTool_XAnchorOptionCount(GoSurfaceTool tool);
84
85 /**
86 * Gets the X-anchoring option at the given index.
87 *
88 * @public @memberof GoSurfaceTool
89 * @version Introduced in firmware 4.0.10.27
90 * @param tool GoSurfaceTool object.
91 * @param index The index of the option list to access.
92 * @return The X-anchoring option at the given index or k32U_MAX if invalid.
93 */
94 GoFx(k32u) GoSurfaceTool_XAnchorOptionAt(GoSurfaceTool tool, kSize index);
95
96 /**
97 * Gets the current X-anchoring source.
98 *
99 * @public @memberof GoSurfaceTool
100 * @version Introduced in firmware 4.0.10.27
101 * @param tool GoSurfaceTool object.
102 * @return The X-anchoring source or -1 if no source is currently set.
103 */
104 GoFx(k32s) GoSurfaceTool_XAnchor(GoSurfaceTool tool);
105
106 /**
107 * Sets the X-anchoring source.
108 *
109 * @public @memberof GoSurfaceTool
110 * @version Introduced in firmware 4.0.10.27
111 * @param tool GoSurfaceTool object.
112 * @param id The measurement ID of a valid X-anchoring source.
113 * @return Operation status.
114 */
115 GoFx(kStatus) GoSurfaceTool_SetXAnchor(GoSurfaceTool tool, k32s id);
116
117 /**
118 * Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
119 *
120 * @public @memberof GoSurfaceTool
121 * @version Introduced in firmware 4.0.10.27
122 * @param tool GoSurfaceTool object.
123 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
124 */
125 GoFx(kBool) GoSurfaceTool_XAnchorEnabled(GoSurfaceTool tool);
126
127 /**
128 * Gets the Y-anchoring option list count.
129 *
130 * @public @memberof GoSurfaceTool
131 * @version Introduced in firmware 4.0.10.27
132 * @param tool GoSurfaceTool object.
133 * @return The Y-anchoring option list count.
134 */
135 GoFx(kSize) GoSurfaceTool_YAnchorOptionCount(GoSurfaceTool tool);
136
137 /**
138 * Gets the Y-anchoring option at the given index.
139 *
140 * @public @memberof GoSurfaceTool
141 * @version Introduced in firmware 4.0.10.27
142 * @param tool GoSurfaceTool object.
143 * @param index The index of the option list to access.
144 * @return The Y-anchoring option at the given index or k32U_MAX if invalid.
145 */
146 GoFx(k32u) GoSurfaceTool_YAnchorOptionAt(GoSurfaceTool tool, kSize index);
147
148 /**
149 * Gets the current Y-anchoring source.
150 *
151 * @public @memberof GoSurfaceTool
152 * @version Introduced in firmware 4.0.10.27
153 * @param tool GoSurfaceTool object.
154 * @return The Y-anchoring source or -1 if no source is currently set.
155 */
156 GoFx(k32s) GoSurfaceTool_YAnchor(GoSurfaceTool tool);
157
158 /**
159 * Sets the Y-anchoring source.
160 *
161 * @public @memberof GoSurfaceTool
162 * @version Introduced in firmware 4.0.10.27
163 * @param tool GoSurfaceTool object.
164 * @param id The measurement ID of a valid Y-anchoring source.
165 * @return Operation status.
166 */
167 GoFx(kStatus) GoSurfaceTool_SetYAnchor(GoSurfaceTool tool, k32s id);
168
169 /**
170 * Returns a boolean value representing whether or not a valid Y-anchoring source has been set for Y-anchoring.
171 *
172 * @public @memberof GoSurfaceTool
173 * @version Introduced in firmware 4.0.10.27
174 * @param tool GoSurfaceTool object.
175 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
176 */
177 GoFx(kBool) GoSurfaceTool_YAnchorEnabled(GoSurfaceTool tool);
178
179 /**
180 * Gets the Z-anchoring option list count.
181 *
182 * @public @memberof GoSurfaceTool
183 * @version Introduced in firmware 4.0.10.27
184 * @param tool GoSurfaceTool object.
185 * @return The X-anchoring option list count.
186 */
187 GoFx(kSize) GoSurfaceTool_ZAnchorOptionCount(GoSurfaceTool tool);
188
189 /**
190 * Gets the Z-anchoring option at the given index.
191 *
192 * @public @memberof GoSurfaceTool
193 * @version Introduced in firmware 4.0.10.27
194 * @param tool GoSurfaceTool object.
195 * @param index The index of the option list to access.
196 * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
197 */
198 GoFx(k32u) GoSurfaceTool_ZAnchorOptionAt(GoSurfaceTool tool, kSize index);
199
200 /**
201 * Gets the current Z-anchoring source.
202 *
203 * @public @memberof GoSurfaceTool
204 * @version Introduced in firmware 4.0.10.27
205 * @param tool GoSurfaceTool object.
206 * @return The Z-anchoring source or -1 if no source is currently set.
207 */
208 GoFx(k32s) GoSurfaceTool_ZAnchor(GoSurfaceTool tool);
209
210 /**
211 * Sets the Z-anchoring source.
212 *
213 * @public @memberof GoSurfaceTool
214 * @version Introduced in firmware 4.0.10.27
215 * @param tool GoSurfaceTool object.
216 * @param id The measurement ID of a valid Z-anchoring source.
217 * @return Operation status.
218 */
219 GoFx(kStatus) GoSurfaceTool_SetZAnchor(GoSurfaceTool tool, k32s id);
220
221 /**
222 * Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
223 *
224 * @public @memberof GoSurfaceTool
225 * @version Introduced in firmware 4.0.10.27
226 * @param tool GoSurfaceTool object.
227 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
228 */
229 GoFx(kBool) GoSurfaceTool_ZAnchorEnabled(GoSurfaceTool tool);
230
231
232 /**
233 * @class GoSurfaceBox
234 * @extends GoSurfaceTool
235 * @ingroup GoSdk-SurfaceTools
236 * @brief Represents a surface bounding box tool.
237 */
238 typedef GoSurfaceTool GoSurfaceBox;
239
240 /**
241 * Returns the enabled state of Z-rotation.
242 *
243 * @public @memberof GoSurfaceBox
244 * @version Introduced in firmware 4.0.10.27
245 * @param tool GoSurfaceBox object.
246 * @return kTRUE if enabled and kFALSE if disabled.
247 */
248 GoFx(kBool) GoSurfaceBox_ZRotationEnabled(GoSurfaceBox tool);
249
250 /**
251 * Enables or disables Z-rotation.
252 *
253 * @public @memberof GoSurfaceBox
254 * @version Introduced in firmware 4.0.10.27
255 * @param tool GoSurfaceBox object.
256 * @param enable kTRUE to enable Z-rotation, kFALSE to disable it.
257 * @return Operation status.
258 */
259 GoFx(kStatus) GoSurfaceBox_EnableZRotation(GoSurfaceBox tool, kBool enable);
260
261 /**
262 * Returns the enabled state of the tool region.
263 *
264 * @public @memberof GoSurfaceBox
265 * @version Introduced in firmware 4.0.10.27
266 * @param tool GoSurfaceBox object.
267 * @return kTRUE if enabled and kFALSE if disabled.
268 */
269 GoFx(kBool) GoSurfaceBox_RegionEnabled(GoSurfaceBox tool);
270
271 /**
272 * Enables or disables the tool region.
273 *
274 * @public @memberof GoSurfaceBox
275 * @version Introduced in firmware 4.0.10.27
276 * @param tool GoSurfaceBox object.
277 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
278 * @return Operation status.
279 */
280 GoFx(kStatus) GoSurfaceBox_EnableRegion(GoSurfaceBox tool, kBool enable);
281
282 /**
283 * Gets the surface bounding box region.
284 *
285 * @public @memberof GoSurfaceBox
286 * @version Introduced in firmware 4.0.10.27
287 * @param tool GoSurfaceBox object.
288 * @return A GoRegion3d object.
289 */
290 GoFx(GoRegion3d) GoSurfaceBox_Region(GoSurfaceBox tool);
291
292 /**
293 * Returns a GoSurfaceBox X measurement object.
294 *
295 * @public @memberof GoSurfaceBox
296 * @version Introduced in firmware 4.0.10.27
297 * @param tool GoSurfaceBox object.
298 * @return A GoSurfaceBox X measurement.
299 */
300 GoFx(GoSurfaceBoxX) GoSurfaceBox_XMeasurement(GoSurfaceBox tool);
301
302 /**
303 * Returns a GoSurfaceBox Y measurement object.
304 *
305 * @public @memberof GoSurfaceBox
306 * @version Introduced in firmware 4.0.10.27
307 * @param tool GoSurfaceBox object.
308 * @return A GoSurfaceBox Y measurement.
309 */
310 GoFx(GoSurfaceBoxY) GoSurfaceBox_YMeasurement(GoSurfaceBox tool);
311
312 /**
313 * Returns a GoSurfaceBox Z measurement object.
314 *
315 * @public @memberof GoSurfaceBox
316 * @version Introduced in firmware 4.0.10.27
317 * @param tool GoSurfaceBox object.
318 * @return A GoSurfaceBox Z measurement.
319 */
320 GoFx(GoSurfaceBoxZ) GoSurfaceBox_ZMeasurement(GoSurfaceBox tool);
321
322 /**
323 * Returns a GoSurfaceBox Width measurement object.
324 *
325 * @public @memberof GoSurfaceBox
326 * @version Introduced in firmware 4.0.10.27
327 * @param tool GoSurfaceBox object.
328 * @return A GoSurfaceBox Width measurement.
329 */
330 GoFx(GoSurfaceBoxWidth) GoSurfaceBox_WidthMeasurement(GoSurfaceBox tool);
331
332 /**
333 * Returns a GoSurfaceBox Length measurement object.
334 *
335 * @public @memberof GoSurfaceBox
336 * @version Introduced in firmware 4.0.10.27
337 * @param tool GoSurfaceBox object.
338 * @return A GoSurfaceBox Length measurement.
339 */
340 GoFx(GoSurfaceBoxLength) GoSurfaceBox_LengthMeasurement(GoSurfaceBox tool);
341
342 /**
343 * Returns a GoSurfaceBox Height measurement object.
344 *
345 * @public @memberof GoSurfaceBox
346 * @version Introduced in firmware 4.0.10.27
347 * @param tool GoSurfaceBox object.
348 * @return A GoSurfaceBox Height measurement.
349 */
350 GoFx(GoSurfaceBoxHeight) GoSurfaceBox_HeightMeasurement(GoSurfaceBox tool);
351
352 /**
353 * Returns a GoSurfaceBox Z Angle measurement object.
354 *
355 * @public @memberof GoSurfaceBox
356 * @version Introduced in firmware 4.0.10.27
357 * @param tool GoSurfaceBox object.
358 * @return A GoSurfaceBox Z Angle measurement.
359 */
360 GoFx(GoSurfaceBoxZAngle) GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool);
361
362 /**
363 * Returns a GoSurfaceBox global X measurement object.
364 *
365 * @public @memberof GoSurfaceBox
366 * @version Introduced in firmware 4.0.10.27
367 * @param tool GoSurfaceBox object.
368 * @return A GoSurfaceBox global X measurement.
369 */
370 GoFx(GoSurfaceBoxGlobalX) GoSurfaceBox_GlobalXMeasurement(GoSurfaceBox tool);
371
372 /**
373 * Returns a GoSurfaceBox global Y measurement object.
374 *
375 * @public @memberof GoSurfaceBox
376 * @version Introduced in firmware 4.0.10.27
377 * @param tool GoSurfaceBox object.
378 * @return A GoSurfaceBox global Y measurement.
379 */
380 GoFx(GoSurfaceBoxGlobalY) GoSurfaceBox_GlobalYMeasurement(GoSurfaceBox tool);
381
382 /**
383 * Returns a GoSurfaceBox global Z Angle measurement object.
384 *
385 * @public @memberof GoSurfaceBox
386 * @version Introduced in firmware 4.2.4.7
387 * @param tool GoSurfaceBox object.
388 * @return A GoSurfaceBox global Z angle measurement.
389 */
390 GoFx(GoSurfaceBoxGlobalZAngle) GoSurfaceBox_GlobalZAngleMeasurement(GoSurfaceBox tool);
391
392
393 /**
394 * @class GoSurfaceCountersunkHole
395 * @extends GoSurfaceTool
396 * @ingroup GoSdk-SurfaceTools
397 * @brief Represents a Surface Counter Sunk Hole tool.
398 */
399 typedef GoSurfaceTool GoSurfaceCountersunkHole;
400
401 /**
402 * Sets the nominal bevel angle.
403 *
404 * @public @memberof GoSurfaceCountersunkHole
405 * @version Introduced in firmware 4.0.10.27
406 * @param tool GoSurfaceCountersunkHole object.
407 * @param value The value to set.
408 * @return Operation status.
409 */
410 GoFx(kStatus) GoSurfaceCountersunkHole_SetNominalBevelAngle(GoSurfaceCountersunkHole tool, k64f value);
411
412 /**
413 * Returns the nominal bevel angle.
414 *
415 * @public @memberof GoSurfaceCountersunkHole
416 * @version Introduced in firmware 4.0.10.27
417 * @param tool GoSurfaceCountersunkHole object.
418 * @return The nominal bevel angle.
419 */
420 GoFx(k64f) GoSurfaceCountersunkHole_NominalBevelAngle(GoSurfaceCountersunkHole tool);
421
422 /**
423 * Sets the bevel angle tolerance.
424 *
425 * @public @memberof GoSurfaceCountersunkHole
426 * @version Introduced in firmware 4.0.10.27
427 * @param tool GoSurfaceCountersunkHole object.
428 * @param value The value to set.
429 * @return Operation status.
430 */
431 GoFx(kStatus) GoSurfaceCountersunkHole_SetBevelAngleTolerance(GoSurfaceCountersunkHole tool, k64f value);
432
433 /**
434 * Returns the bevel angle tolerance.
435 *
436 * @public @memberof GoSurfaceCountersunkHole
437 * @version Introduced in firmware 4.0.10.27
438 * @param tool GoSurfaceCountersunkHole object.
439 * @return The bevel angle tolerance.
440 */
441 GoFx(k64f) GoSurfaceCountersunkHole_BevelAngleTolerance(GoSurfaceCountersunkHole tool);
442
443 /**
444 * Sets the nominal outer radius.
445 *
446 * @public @memberof GoSurfaceCountersunkHole
447 * @version Introduced in firmware 4.0.10.27
448 * @param tool GoSurfaceCountersunkHole object.
449 * @param value The value to set.
450 * @return Operation status.
451 */
452 GoFx(kStatus) GoSurfaceCountersunkHole_SetNominalOuterRadius(GoSurfaceCountersunkHole tool, k64f value);
453
454 /**
455 * Returns the nominal outer radius.
456 *
457 * @public @memberof GoSurfaceCountersunkHole
458 * @version Introduced in firmware 4.0.10.27
459 * @param tool GoSurfaceCountersunkHole object.
460 * @return The nominal outer radius.
461 */
462 GoFx(k64f) GoSurfaceCountersunkHole_NominalOuterRadius(GoSurfaceCountersunkHole tool);
463
464 /**
465 * Sets the outer radius tolerance.
466 *
467 * @public @memberof GoSurfaceCountersunkHole
468 * @version Introduced in firmware 4.0.10.27
469 * @param tool GoSurfaceCountersunkHole object.
470 * @param value The value to set.
471 * @return Operation status.
472 */
473 GoFx(kStatus) GoSurfaceCountersunkHole_SetOuterRadiusTolerance(GoSurfaceCountersunkHole tool, k64f value);
474
475 /**
476 * Returns the outer radius tolerance.
477 *
478 * @public @memberof GoSurfaceCountersunkHole
479 * @version Introduced in firmware 4.0.10.27
480 * @param tool GoSurfaceCountersunkHole object.
481 * @return The outer radius tolerance.
482 */
483 GoFx(k64f) GoSurfaceCountersunkHole_OuterRadiusTolerance(GoSurfaceCountersunkHole tool);
484
485 /**
486 * Sets the nominal inner radius.
487 *
488 * @public @memberof GoSurfaceCountersunkHole
489 * @version Introduced in firmware 4.0.10.27
490 * @param tool GoSurfaceCountersunkHole object.
491 * @param value The value to set.
492 * @return Operation status.
493 */
494 GoFx(kStatus) GoSurfaceCountersunkHole_SetNominalInnerRadius(GoSurfaceCountersunkHole tool, k64f value);
495
496 /**
497 * Returns the nominal inner radius.
498 *
499 * @public @memberof GoSurfaceCountersunkHole
500 * @version Introduced in firmware 4.0.10.27
501 * @param tool GoSurfaceCountersunkHole object.
502 * @return The nominal inner radius.
503 */
504 GoFx(k64f) GoSurfaceCountersunkHole_NominalInnerRadius(GoSurfaceCountersunkHole tool);
505
506 /**
507 * Sets the inner radius tolerance.
508 *
509 * @public @memberof GoSurfaceCountersunkHole
510 * @version Introduced in firmware 4.0.10.27
511 * @param tool GoSurfaceCountersunkHole object.
512 * @param value The value to set.
513 * @return Operation status.
514 */
515 GoFx(kStatus) GoSurfaceCountersunkHole_SetInnerRadiusTolerance(GoSurfaceCountersunkHole tool, k64f value);
516
517 /**
518 * Returns the inner radius tolerance.
519 *
520 * @public @memberof GoSurfaceCountersunkHole
521 * @version Introduced in firmware 4.0.10.27
522 * @param tool GoSurfaceCountersunkHole object.
523 * @return The inner radius tolerance.
524 */
525 GoFx(k64f) GoSurfaceCountersunkHole_InnerRadiusTolerance(GoSurfaceCountersunkHole tool);
526
527 /**
528 * Sets the bevel radius offset.
529 *
530 * @public @memberof GoSurfaceCountersunkHole
531 * @version Introduced in firmware 4.0.10.27
532 * @param tool GoSurfaceCountersunkHole object.
533 * @param value The value to set.
534 * @return Operation status.
535 */
536 GoFx(kStatus) GoSurfaceCountersunkHole_SetBevelRadiusOffset(GoSurfaceCountersunkHole tool, k64f value);
537
538 /**
539 * Returns the bevel radius offset.
540 *
541 * @public @memberof GoSurfaceCountersunkHole
542 * @version Introduced in firmware 4.0.10.27
543 * @param tool GoSurfaceCountersunkHole object.
544 * @return The bevel radius offset.
545 */
546 GoFx(k64f) GoSurfaceCountersunkHole_BevelRadiusOffset(GoSurfaceCountersunkHole tool);
547
548 /**
549 * Enables or disables partial counter sunk hole detection.
550 *
551 * @public @memberof GoSurfaceCountersunkHole
552 * @version Introduced in firmware 4.0.10.27
553 * @param tool GoSurfaceCountersunkHole object.
554 * @param enable kTRUE to enable partial detection and kFALSE to disable it.
555 * @return Operation status.
556 */
557 GoFx(kStatus) GoSurfaceCountersunkHole_EnablePartialDetection(GoSurfaceCountersunkHole tool, kBool enable);
558
559 /**
560 * Returns the state of partial detection.
561 *
562 * @public @memberof GoSurfaceCountersunkHole
563 * @version Introduced in firmware 4.0.10.27
564 * @param tool GoSurfaceCountersunkHole object.
565 * @return kTRUE if partial detection is enabled. kFALSE otherwise.
566 */
567 GoFx(kBool) GoSurfaceCountersunkHole_PartialDetectionEnabled(GoSurfaceCountersunkHole tool);
568
569 /**
570 * Enables or disables the tool region.
571 *
572 * @public @memberof GoSurfaceCountersunkHole
573 * @version Introduced in firmware 4.0.10.27
574 * @param tool GoSurfaceCountersunkHole object.
575 * @param enable kTRUE to enable the tool region and kFALSE to disable it.
576 * @return Operation status.
577 */
578 GoFx(kStatus) GoSurfaceCountersunkHole_EnableRegion(GoSurfaceCountersunkHole tool, kBool enable);
579
580 /**
581 * Returns the state of the tool region.
582 *
583 * @public @memberof GoSurfaceCountersunkHole
584 * @version Introduced in firmware 4.0.10.27
585 * @param tool GoSurfaceCountersunkHole object.
586 * @return kTRUE if the tool region is enabled. kFALSE otherwise.
587 */
588 GoFx(kBool) GoSurfaceCountersunkHole_RegionEnabled(GoSurfaceCountersunkHole tool);
589
590 /**
591 * Returns the tool region.
592 *
593 * @public @memberof GoSurfaceCountersunkHole
594 * @version Introduced in firmware 4.0.10.27
595 * @param tool GoSurfaceCountersunkHole object.
596 * @return The tool region.
597 */
598 GoFx(GoRegion3d) GoSurfaceCountersunkHole_Region(GoSurfaceCountersunkHole tool);
599
600 /**
601 * Enables or disables reference regions.
602 *
603 * @public @memberof GoSurfaceCountersunkHole
604 * @version Introduced in firmware 4.0.10.27
605 * @param tool GoSurfaceCountersunkHole object.
606 * @param enable kTRUE to enable reference regions and kFALSE to disable them.
607 * @return Operation status.
608 */
609 GoFx(kStatus) GoSurfaceCountersunkHole_EnableRefRegions(GoSurfaceCountersunkHole tool, kBool enable);
610
611 /**
612 * Returns the state of the tool reference regions.
613 *
614 * @public @memberof GoSurfaceCountersunkHole
615 * @version Introduced in firmware 4.0.10.27
616 * @param tool GoSurfaceCountersunkHole object.
617 * @return kTRUE if refrence regions are enabled. kFALSE otherwise.
618 */
619 GoFx(kBool) GoSurfaceCountersunkHole_RefRegionsEnabled(GoSurfaceCountersunkHole tool);
620
621 /**
622 * Sets the reference region count.
623 *
624 * @public @memberof GoSurfaceCountersunkHole
625 * @version Introduced in firmware 4.0.10.27
626 * @param tool GoSurfaceCountersunkHole object.
627 * @param count The number of references regions to use when enabled.
628 * @return Reference region count.
629 * @see GO_SURFACE_COUNTERSUNK_HOLE_MAX_REF_REGIONS
630
631 */
632 GoFx(kStatus) GoSurfaceCountersunkHole_SetRefRegionCount(GoSurfaceCountersunkHole tool, kSize count);
633
634 /**
635 * Returns the reference region count.
636 *
637 * @public @memberof GoSurfaceCountersunkHole
638 * @version Introduced in firmware 4.0.10.27
639 * @param tool GoSurfaceCountersunkHole object.
640 * @return Reference region count.
641 */
642 GoFx(kSize) GoSurfaceCountersunkHole_RefRegionCount(GoSurfaceCountersunkHole tool);
643
644 /**
645 * Returns the reference region at the given index.
646 *
647 * @public @memberof GoSurfaceCountersunkHole
648 * @version Introduced in firmware 4.0.10.27
649 * @param tool GoSurfaceCountersunkHole object.
650 * @param index The index of the reference region to retrieve.
651 * @return A reference region.
652 */
653 GoFx(GoSurfaceRegion2d) GoSurfaceCountersunkHole_RefRegionAt(GoSurfaceCountersunkHole tool, kSize index);
654
655 /**
656 * Enables or disables automatic tilt.
657 *
658 * @public @memberof GoSurfaceCountersunkHole
659 * @version Introduced in firmware 4.0.10.27
660 * @param tool GoSurfaceCountersunkHole object.
661 * @param enable kTRUE to enable auto tilt and kFALSE to disable it.
662 * @return Operation status.
663 */
664 GoFx(kStatus) GoSurfaceCountersunkHole_EnableAutoTilt(GoSurfaceCountersunkHole tool, kBool enable);
665
666 /**
667 * Returns the state of auto tilt.
668 *
669 * @public @memberof GoSurfaceCountersunkHole
670 * @version Introduced in firmware 4.0.10.27
671 * @param tool GoSurfaceCountersunkHole object.
672 * @return kTRUE if auto tilt is enabled. kFALSE otherwise.
673 */
674 GoFx(kBool) GoSurfaceCountersunkHole_AutoTiltEnabled(GoSurfaceCountersunkHole tool);
675
676 /**
677 * Sets the tilt X angle.
678 *
679 * @public @memberof GoSurfaceCountersunkHole
680 * @version Introduced in firmware 4.0.10.27
681 * @param tool GoSurfaceCountersunkHole object.
682 * @param value The value to set.
683 * @return Operation status.
684 */
685 GoFx(kStatus) GoSurfaceCountersunkHole_SetTiltXAngle(GoSurfaceCountersunkHole tool, k64f value);
686
687 /**
688 * Returns the tilt X angle value.
689 *
690 * @public @memberof GoSurfaceCountersunkHole
691 * @version Introduced in firmware 4.0.10.27
692 * @param tool GoSurfaceCountersunkHole object.
693 * @return Tilt X angle value.
694 */
695 GoFx(k64f) GoSurfaceCountersunkHole_TiltXAngle(GoSurfaceCountersunkHole tool);
696
697 /**
698 * Sets the tilt Y angle.
699 *
700 * @public @memberof GoSurfaceCountersunkHole
701 * @version Introduced in firmware 4.0.10.27
702 * @param tool GoSurfaceCountersunkHole object.
703 * @param value The value to set.
704 * @return Operation status.
705 */
706 GoFx(kStatus) GoSurfaceCountersunkHole_SetTiltYAngle(GoSurfaceCountersunkHole tool, k64f value);
707
708 /**
709 * Returns the tilt Y angle value.
710 *
711 * @public @memberof GoSurfaceCountersunkHole
712 * @version Introduced in firmware 4.0.10.27
713 * @param tool GoSurfaceCountersunkHole object.
714 * @return Tilt Y angle value.
715 */
716 GoFx(k64f) GoSurfaceCountersunkHole_TiltYAngle(GoSurfaceCountersunkHole tool);
717
718 /**
719 * Enables or disables curve fitting.
720 *
721 * @public @memberof GoSurfaceCountersunkHole
722 * @version Introduced in firmware 4.1.3.106
723 * @param tool GoSurfaceCountersunkHole object.
724 * @param enable kTRUE to enable curve fitting and kFALSE to disable it.
725 * @return Operation status.
726 */
727 GoFx(kStatus) GoSurfaceCountersunkHole_EnableCurveFit(GoSurfaceCountersunkHole tool, kBool enable);
728
729
730 /**
731 * Returns the state of auto tilt.
732 *
733 * @public @memberof GoSurfaceCountersunkHole
734 * @version Introduced in firmware 4.1.3.106
735 * @param tool GoSurfaceCountersunkHole object.
736 * @return kTRUE if curve fitting is enabled. kFALSE otherwise.
737 */
738 GoFx(kBool) GoSurfaceCountersunkHole_CurveFitEnabled(GoSurfaceCountersunkHole tool);
739
740 /**
741 * Sets the curve orientation angle.
742 *
743 * @public @memberof GoSurfaceCountersunkHole
744 * @version Introduced in firmware 4.1.3.106
745 * @param tool GoSurfaceCountersunkHole object.
746 * @param value The value to set.
747 * @return Operation status.
748 */
749 GoFx(kStatus) GoSurfaceCountersunkHole_SetCurveOrientation(GoSurfaceCountersunkHole tool, k64f value);
750
751 /**
752 * Returns the curve orientation angle value.
753 *
754 * @public @memberof GoSurfaceCountersunkHole
755 * @version Introduced in firmware 4.1.3.106
756 * @param tool GoSurfaceCountersunkHole object.
757 * @return Curve orientation angle value.
758 */
759 GoFx(k64f) GoSurfaceCountersunkHole_CurveOrientation(GoSurfaceCountersunkHole tool);
760
761 /**
762 * Returns a GoSurfaceCountersunkHole tool X position measurement object.
763 *
764 * @public @memberof GoSurfaceCountersunkHole
765 * @version Introduced in firmware 4.0.10.27
766 * @param tool GoSurfaceCountersunkHole object.
767 * @return A GoSurfaceCountersunkHole X position measurement.
768 */
769 GoFx(GoSurfaceCountersunkHoleX) GoSurfaceCountersunkHole_XMeasurement(GoSurfaceCountersunkHole tool);
770
771 /**
772 * Returns a GoSurfaceCountersunkHole tool Y position measurement object.
773 *
774 * @public @memberof GoSurfaceCountersunkHole
775 * @version Introduced in firmware 4.0.10.27
776 * @param tool GoSurfaceCountersunkHole object.
777 * @return A GoSurfaceCountersunkHole Y position measurement.
778 */
779 GoFx(GoSurfaceCountersunkHoleY) GoSurfaceCountersunkHole_YMeasurement(GoSurfaceCountersunkHole tool);
780
781 /**
782 * Returns a GoSurfaceCountersunkHole tool Z position measurement object.
783 *
784 * @public @memberof GoSurfaceCountersunkHole
785 * @version Introduced in firmware 4.0.10.27
786 * @param tool GoSurfaceCountersunkHole object.
787 * @return A GoSurfaceCountersunkHole Z position measurement.
788 */
789 GoFx(GoSurfaceCountersunkHoleZ) GoSurfaceCountersunkHole_ZMeasurement(GoSurfaceCountersunkHole tool);
790
791 /**
792 * Returns a GoSurfaceCountersunkHole tool Outer Radius measurement object.
793 *
794 * @public @memberof GoSurfaceCountersunkHole
795 * @version Introduced in firmware 4.0.10.27
796 * @param tool GoSurfaceCountersunkHole object.
797 * @return A GoSurfaceCountersunkHole Outer Radius measurement.
798 */
799 GoFx(GoSurfaceCountersunkHoleOuterRadius) GoSurfaceCountersunkHole_OuterRadiusMeasurement(GoSurfaceCountersunkHole tool);
800
801 /**
802 * Returns a GoSurfaceCountersunkHole tool Depth measurement object.
803 *
804 * @public @memberof GoSurfaceCountersunkHole
805 * @version Introduced in firmware 4.0.10.27
806 * @param tool GoSurfaceCountersunkHole object.
807 * @return A GoSurfaceCountersunkHole Depth measurement.
808 */
809 GoFx(GoSurfaceCountersunkHoleDepth) GoSurfaceCountersunkHole_DepthMeasurement(GoSurfaceCountersunkHole tool);
810
811 /**
812 * Returns a GoSurfaceCountersunkHole tool Bevel Radius measurement object.
813 *
814 * @public @memberof GoSurfaceCountersunkHole
815 * @version Introduced in firmware 4.0.10.27
816 * @param tool GoSurfaceCountersunkHole object.
817 * @return A GoSurfaceCountersunkHole Bevel Radius measurement.
818 */
819 GoFx(GoSurfaceCountersunkHoleBevelRadius) GoSurfaceCountersunkHole_BevelRadiusMeasurement(GoSurfaceCountersunkHole tool);
820
821 /**
822 * Returns a GoSurfaceCountersunkHole tool Bevel Angle measurement object.
823 *
824 * @public @memberof GoSurfaceCountersunkHole
825 * @version Introduced in firmware 4.0.10.27
826 * @param tool GoSurfaceCountersunkHole object.
827 * @return A GoSurfaceCountersunkHole Bevel Angle measurement.
828 */
829 GoFx(GoSurfaceCountersunkHoleBevelAngle) GoSurfaceCountersunkHole_BevelAngleMeasurement(GoSurfaceCountersunkHole tool);
830
831 /**
832 * Returns a GoSurfaceCountersunkHole tool X Angle measurement object.
833 *
834 * @public @memberof GoSurfaceCountersunkHole
835 * @version Introduced in firmware 4.0.10.27
836 * @param tool GoSurfaceCountersunkHole object.
837 * @return A GoSurfaceCountersunkHole X angle measurement.
838 */
839 GoFx(GoSurfaceCountersunkHoleXAngle) GoSurfaceCountersunkHole_XAngleMeasurement(GoSurfaceCountersunkHole tool);
840
841 /**
842 * Returns a GoSurfaceCountersunkHole tool Y Angle measurement object.
843 *
844 * @public @memberof GoSurfaceCountersunkHole
845 * @version Introduced in firmware 4.0.10.27
846 * @param tool GoSurfaceCountersunkHole object.
847 * @return A GoSurfaceCountersunkHole Y angle measurement.
848 */
849 GoFx(GoSurfaceCountersunkHoleYAngle) GoSurfaceCountersunkHole_YAngleMeasurement(GoSurfaceCountersunkHole tool);
850
851
852 /**
853 * @class GoSurfaceEllipse
854 * @extends GoSurfaceTool
855 * @ingroup GoSdk-SurfaceTools
856 * @brief Represents a surface ellipse tool.
857 */
858 typedef GoSurfaceTool GoSurfaceEllipse;
859
860 /**
861 * Enables or disables the tool region.
862 *
863 * @public @memberof GoSurfaceEllipse
864 * @version Introduced in firmware 4.0.10.27
865 * @param tool GoSurfaceEllipse object.
866 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
867 * @return Operation status.
868 */
869 GoFx(kStatus) GoSurfaceEllipse_EnableRegion(GoSurfaceEllipse tool, kBool enable);
870
871 /**
872 * Returns the enabled state of the tool region.
873 *
874 * @public @memberof GoSurfaceEllipse
875 * @version Introduced in firmware 4.0.10.27
876 * @param tool GoSurfaceEllipse object.
877 * @return kTRUE if enabled and kFALSE if disabled.
878 */
879 GoFx(kBool) GoSurfaceEllipse_RegionEnabled(GoSurfaceEllipse tool);
880
881 /**
882 * Gets the tool region.
883 *
884 * @public @memberof GoSurfaceEllipse
885 * @version Introduced in firmware 4.0.10.27
886 * @param tool GoSurfaceEllipse object.
887 * @return A GoRegion3d object.
888 */
889 GoFx(GoRegion3d) GoSurfaceEllipse_Region(GoSurfaceEllipse tool);
890
891 /**
892 * Returns a GoSurfaceEllipse Major measurement object.
893 *
894 * @public @memberof GoSurfaceEllipse
895 * @version Introduced in firmware 4.0.10.27
896 * @param tool GoSurfaceEllipse object.
897 * @return A GoSurfaceEllipse Major measurement.
898 */
899 GoFx(GoSurfaceEllipseMajor) GoSurfaceEllipse_MajorMeasurement(GoSurfaceEllipse tool);
900
901 /**
902 * Returns a GoSurfaceEllipse Minor measurement object.
903 *
904 * @public @memberof GoSurfaceEllipse
905 * @version Introduced in firmware 4.0.10.27
906 * @param tool GoSurfaceEllipse object.
907 * @return A GoSurfaceEllipse Minor measurement.
908 */
909 GoFx(GoSurfaceEllipseMinor) GoSurfaceEllipse_MinorMeasurement(GoSurfaceEllipse tool);
910
911 /**
912 * Returns a GoSurfaceEllipse Ratio measurement object.
913 *
914 * @public @memberof GoSurfaceEllipse
915 * @version Introduced in firmware 4.0.10.27
916 * @param tool GoSurfaceEllipse object.
917 * @return A GoSurfaceEllipse Ratio measurement.
918 */
919 GoFx(GoSurfaceEllipseRatio) GoSurfaceEllipse_RatioMeasurement(GoSurfaceEllipse tool);
920
921 /**
922 * Returns a GoSurfaceEllipse Z Angle measurement object.
923 *
924 * @public @memberof GoSurfaceEllipse
925 * @version Introduced in firmware 4.0.10.27
926 * @param tool GoSurfaceEllipse object.
927 * @return A GoSurfaceEllipse Z Angle measurement.
928 */
929 GoFx(GoSurfaceEllipseZAngle) GoSurfaceEllipse_ZAngleMeasurement(GoSurfaceEllipse tool);
930
931
932 /**
933 * @class GoSurfaceHole
934 * @extends GoSurfaceTool
935 * @ingroup GoSdk-SurfaceTools
936 * @brief Represents a surface hole tool.
937 */
938 typedef GoSurfaceTool GoSurfaceHole;
939
940 /**
941 * Gets the current nominal radius value.
942 *
943 * @public @memberof GoSurfaceHole
944 * @version Introduced in firmware 4.0.10.27
945 * @param tool GoSurfaceHole object.
946 * @return The nominal radius value.
947 */
948 GoFx(k64f) GoSurfaceHole_NominalRadius(GoSurfaceHole tool);
949
950 /**
951 * Sets the nominal radius value.
952 *
953 * @public @memberof GoSurfaceHole
954 * @version Introduced in firmware 4.0.10.27
955 * @param tool GoSurfaceHole object.
956 * @param nominalRadius Nominal radius value to set.
957 * @return Operation status.
958 */
959 GoFx(kStatus) GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius);
960
961 /**
962 * Gets the current radius tolerance value.
963 *
964 * @public @memberof GoSurfaceHole
965 * @version Introduced in firmware 4.0.10.27
966 * @param tool GoSurfaceHole object.
967 * @return The radius tolerance value.
968 */
969 GoFx(k64f) GoSurfaceHole_RadiusTolerance(GoSurfaceHole tool);
970
971 /**
972 * Sets the radius tolerance value.
973 *
974 * @public @memberof GoSurfaceHole
975 * @version Introduced in firmware 4.0.10.27
976 * @param tool GoSurfaceHole object.
977 * @param radiusTolerance The radius tolerance value to set.
978 * @return Operation status.
979 */
980 GoFx(kStatus) GoSurfaceHole_SetRadiusTolerance(GoSurfaceHole tool, k64f radiusTolerance);
981
982 /**
983 * Gets the enabled state of partial detection.
984 *
985 * @public @memberof GoSurfaceHole
986 * @version Introduced in firmware 4.0.10.27
987 * @param tool GoSurfaceHole object.
988 * @return kTRUE if enabled and kFALSE if disabled.
989 */
990 GoFx(kBool) GoSurfaceHole_PartialDetectionEnabled(GoSurfaceHole tool);
991
992 /**
993 * Sets the enabled state of partial detection.
994 *
995 * @public @memberof GoSurfaceHole
996 * @version Introduced in firmware 4.0.10.27
997 * @param tool GoSurfaceHole object.
998 * @param enable kTRUE to enable partial detection and kFALSE to disable it.
999 * @return Operation status.
1000 */
1001 GoFx(kStatus) GoSurfaceHole_EnablePartialDetection(GoSurfaceHole tool, kBool enable);
1002
1003 /**
1004 * Gets the enabled state of the tool region.
1005 *
1006 * @public @memberof GoSurfaceHole
1007 * @version Introduced in firmware 4.0.10.27
1008 * @param tool GoSurfaceHole object.
1009 * @return kTRUE if enabled and kFALSE if disabled.
1010 */
1011 GoFx(kBool) GoSurfaceHole_RegionEnabled(GoSurfaceHole tool);
1012
1013 /**
1014 * Sets the enabled state of the tool region.
1015 *
1016 * @public @memberof GoSurfaceHole
1017 * @version Introduced in firmware 4.0.10.27
1018 * @param tool GoSurfaceHole object.
1019 * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1020 * @return Operation status.
1021 */
1022 GoFx(kStatus) GoSurfaceHole_EnableRegion(GoSurfaceHole tool, kBool enable);
1023
1024 /**
1025 * Returns the tool's region object.
1026 *
1027 * @public @memberof GoSurfaceHole
1028 * @version Introduced in firmware 4.0.10.27
1029 * @param tool GoSurfaceHole object.
1030 * @return A GoRegion3d object.
1031 */
1032 GoFx(GoRegion3d) GoSurfaceHole_Region(GoSurfaceHole tool);
1033
1034 /**
1035 * Gets the enabled state of reference regions.
1036 *
1037 * @public @memberof GoSurfaceHole
1038 * @version Introduced in firmware 4.0.10.27
1039 * @param tool GoSurfaceHole object.
1040 * @return kTRUE if enabled and kFALSE if disabled.
1041 */
1042 GoFx(kBool) GoSurfaceHole_RefRegionsEnabled(GoSurfaceHole tool);
1043
1044 /**
1045 * Sets the enabled state of reference regions.
1046 *
1047 * @public @memberof GoSurfaceHole
1048 * @version Introduced in firmware 4.0.10.27
1049 * @param tool GoSurfaceHole object.
1050 * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1051 * @return Operation status.
1052 */
1053 GoFx(kStatus) GoSurfaceHole_EnableRefRegions(GoSurfaceHole tool, kBool enable);
1054
1055 /**
1056 * Gets the reference region count.
1057 *
1058 * @public @memberof GoSurfaceHole
1059 * @version Introduced in firmware 4.0.10.27
1060 * @param tool GoSurfaceHole object.
1061 * @return The reference region count.
1062 */
1063 GoFx(kSize) GoSurfaceHole_RefRegionCount(GoSurfaceHole tool);
1064
1065 /**
1066 * Sets the reference region count.
1067 *
1068 * @public @memberof GoSurfaceHole
1069 * @version Introduced in firmware 4.0.10.27
1070 * @param tool GoSurfaceHole object.
1071 * @param count The reference region count.
1072 * @return Operation status.
1073 * @see GO_SURFACE_HOLE_MAX_REF_REGIONS
1074 */
1075 GoFx(kStatus) GoSurfaceHole_SetRefRegionCount(GoSurfaceHole tool, kSize count);
1076
1077 /**
1078 * Gets a reference region object at the given index.
1079 *
1080 * @public @memberof GoSurfaceHole
1081 * @version Introduced in firmware 4.0.10.27
1082 * @param tool GoSurfaceHole object.
1083 * @param index The index with which to retrieve a reference region.
1084 * @return A GoSurfaceRegion2d object.
1085 * @see GoSurfaceHole_RefRegionCount
1086 */
1087 GoFx(GoSurfaceRegion2d) GoSurfaceHole_RefRegionAt(GoSurfaceHole tool, kSize index);
1088
1089 /**
1090 * Gets the enabled state of auto-tilt.
1091 *
1092 * @public @memberof GoSurfaceHole
1093 * @version Introduced in firmware 4.0.10.27
1094 * @param tool GoSurfaceHole object.
1095 * @return kTRUE if enabled and kFALSE if disabled.
1096 */
1097 GoFx(kBool) GoSurfaceHole_AutoTiltEnabled(GoSurfaceHole tool);
1098
1099 /**
1100 * Sets the enabled state of auto-tilt.
1101 *
1102 * @public @memberof GoSurfaceHole
1103 * @version Introduced in firmware 4.0.10.27
1104 * @param tool GoSurfaceHole object.
1105 * @param enable kTRUE to enable it and kFALSE to disable it.
1106 * @return Operation status.
1107 */
1108 GoFx(kStatus) GoSurfaceHole_EnableAutoTilt(GoSurfaceHole tool, kBool enable);
1109
1110 /**
1111 * Gets the tilt X-angle value.
1112 *
1113 * @public @memberof GoSurfaceHole
1114 * @version Introduced in firmware 4.0.10.27
1115 * @param tool GoSurfaceHole object.
1116 * @return Tilt X-angle value.
1117 */
1118 GoFx(k64f) GoSurfaceHole_TiltXAngle(GoSurfaceHole tool);
1119
1120 /**
1121 * Sets the tilt X-angle value.
1122 *
1123 * @public @memberof GoSurfaceHole
1124 * @version Introduced in firmware 4.0.10.27
1125 * @param tool GoSurfaceHole object.
1126 * @param value The tilt X-angle value to set.
1127 * @return Operation status.
1128 */
1129 GoFx(kStatus) GoSurfaceHole_SetTiltXAngle(GoSurfaceHole tool, k64f value);
1130
1131 /**
1132 * Gets the tilt Y-angle value.
1133 *
1134 * @public @memberof GoSurfaceHole
1135 * @version Introduced in firmware 4.0.10.27
1136 * @param tool GoSurfaceHole object.
1137 * @return Tilt Y-angle value.
1138 */
1139 GoFx(k64f) GoSurfaceHole_TiltYAngle(GoSurfaceHole tool);
1140
1141 /**
1142 * Sets the tilt Y-angle value.
1143 *
1144 * @public @memberof GoSurfaceHole
1145 * @version Introduced in firmware 4.0.10.27
1146 * @param tool GoSurfaceHole object.
1147 * @param value The tilt Y-angle value to set.
1148 * @return Operation status.
1149 */
1150 GoFx(kStatus) GoSurfaceHole_SetTiltYAngle(GoSurfaceHole tool, k64f value);
1151
1152 /**
1153 * Returns a GoSurfaceHole X measurement object.
1154 *
1155 * @public @memberof GoSurfaceHole
1156 * @version Introduced in firmware 4.0.10.27
1157 * @param tool GoSurfaceHole object.
1158 * @return A GoSurfaceHole X measurement.
1159 */
1160 GoFx(GoSurfaceHoleX) GoSurfaceHole_XMeasurement(GoSurfaceHole tool);
1161
1162 /**
1163 * Returns a GoSurfaceHole Y measurement object.
1164 *
1165 * @public @memberof GoSurfaceHole
1166 * @version Introduced in firmware 4.0.10.27
1167 * @param tool GoSurfaceHole object.
1168 * @return A GoSurfaceHole Y measurement.
1169 */
1170 GoFx(GoSurfaceHoleY) GoSurfaceHole_YMeasurement(GoSurfaceHole tool);
1171
1172 /**
1173 * Returns a GoSurfaceHole Z measurement object.
1174 *
1175 * @public @memberof GoSurfaceHole
1176 * @version Introduced in firmware 4.0.10.27
1177 * @param tool GoSurfaceHole object.
1178 * @return A GoSurfaceHole Z measurement.
1179 */
1180 GoFx(GoSurfaceHoleZ) GoSurfaceHole_ZMeasurement(GoSurfaceHole tool);
1181
1182 /**
1183 * Returns a GoSurfaceHole Radius measurement object.
1184 *
1185 * @public @memberof GoSurfaceHole
1186 * @version Introduced in firmware 4.0.10.27
1187 * @param tool GoSurfaceHole object.
1188 * @return A GoSurfaceHole Radius measurement.
1189 */
1190 GoFx(GoSurfaceHoleRadius) GoSurfaceHole_RadiusMeasurement(GoSurfaceHole tool);
1191
1192
1193 /**
1194 * @class GoSurfaceOpening
1195 * @extends GoSurfaceTool
1196 * @ingroup GoSdk-SurfaceTools
1197 * @brief Represents a surface opening tool.
1198 */
1199 typedef GoSurfaceTool GoSurfaceOpening;
1200
1201 GoFx(kStatus) GoSurfaceOpening_SetType(GoSurfaceOpening tool, GoSurfaceOpeningType type);
1202
1203 /**
1204 * Gets the surface opening type.
1205 *
1206 * @public @memberof GoSurfaceOpening
1207 * @version Introduced in firmware 4.0.10.27
1208 * @param tool GoSurfaceOpening object.
1209 * @return The surface opening type.
1210 */
1211 GoFx(GoSurfaceOpeningType) GoSurfaceOpening_Type(GoSurfaceOpening tool);
1212
1213 /**
1214 * Gets the nominal width.
1215 *
1216 * @public @memberof GoSurfaceOpening
1217 * @version Introduced in firmware 4.0.10.27
1218 * @param tool GoSurfaceOpening object.
1219 * @return The nominal width (in mm).
1220 */
1221 GoFx(k64f) GoSurfaceOpening_NominalWidth(GoSurfaceOpening tool);
1222
1223 /**
1224 * Sets the nominal width.
1225 *
1226 * @public @memberof GoSurfaceOpening
1227 * @version Introduced in firmware 4.0.10.27
1228 * @param tool GoSurfaceOpening object.
1229 * @param value The nominal width to set (in mm).
1230 * @return Operation status.
1231 */
1232 GoFx(kStatus) GoSurfaceOpening_SetNominalWidth(GoSurfaceOpening tool, k64f value);
1233
1234 /**
1235 * Gets the nominal length.
1236 *
1237 * @public @memberof GoSurfaceOpening
1238 * @version Introduced in firmware 4.0.10.27
1239 * @param tool GoSurfaceOpening object.
1240 * @return The nominal length (in mm).
1241 */
1242 GoFx(k64f) GoSurfaceOpening_NominalLength(GoSurfaceOpening tool);
1243
1244 /**
1245 * Sets the nominal length.
1246 *
1247 * @public @memberof GoSurfaceOpening
1248 * @version Introduced in firmware 4.0.10.27
1249 * @param tool GoSurfaceOpening object.
1250 * @param value The nominal length to set (in mm).
1251 * @return Operation status.
1252 */
1253 GoFx(kStatus) GoSurfaceOpening_SetNominalLength(GoSurfaceOpening tool, k64f value);
1254
1255 /**
1256 * Gets the nominal angle.
1257 *
1258 * @public @memberof GoSurfaceOpening
1259 * @version Introduced in firmware 4.0.10.27
1260 * @param tool GoSurfaceOpening object.
1261 * @return The nominal angle (in degrees).
1262 */
1263 GoFx(k64f) GoSurfaceOpening_NominalAngle(GoSurfaceOpening tool);
1264
1265 /**
1266 * Sets the nominal angle.
1267 *
1268 * @public @memberof GoSurfaceOpening
1269 * @version Introduced in firmware 4.0.10.27
1270 * @param tool GoSurfaceOpening object.
1271 * @param value The nominal angle to set (in degrees).
1272 * @return Operation status.
1273 */
1274 GoFx(kStatus) GoSurfaceOpening_SetNominalAngle(GoSurfaceOpening tool, k64f value);
1275
1276 /**
1277 * Gets the nominal radius.
1278 *
1279 * @public @memberof GoSurfaceOpening
1280 * @version Introduced in firmware 4.0.10.27
1281 * @param tool GoSurfaceOpening object.
1282 * @return The nominal radius (in mm).
1283 */
1284 GoFx(k64f) GoSurfaceOpening_NominalRadius(GoSurfaceOpening tool);
1285
1286 /**
1287 * Sets the nominal radius.
1288 *
1289 * @public @memberof GoSurfaceOpening
1290 * @version Introduced in firmware 4.0.10.27
1291 * @param tool GoSurfaceOpening object.
1292 * @param value The nominal radius to set (in mm).
1293 * @return Operation status.
1294 */
1295 GoFx(kStatus) GoSurfaceOpening_SetNominalRadius(GoSurfaceOpening tool, k64f value);
1296
1297 /**
1298 * Gets the width tolerance.
1299 *
1300 * @public @memberof GoSurfaceOpening
1301 * @version Introduced in firmware 4.0.10.27
1302 * @param tool GoSurfaceOpening object.
1303 * @return The width tolerance (in mm).
1304 */
1305 GoFx(k64f) GoSurfaceOpening_WidthTolerance(GoSurfaceOpening tool);
1306
1307 /**
1308 * Sets the width tolerance.
1309 *
1310 * @public @memberof GoSurfaceOpening
1311 * @version Introduced in firmware 4.0.10.27
1312 * @param tool GoSurfaceOpening object.
1313 * @param value The width tolerance to set (in mm).
1314 * @return Operation status.
1315 */
1316 GoFx(kStatus) GoSurfaceOpening_SetWidthTolerance(GoSurfaceOpening tool, k64f value);
1317
1318 /**
1319 * Gets the length tolerance.
1320 *
1321 * @public @memberof GoSurfaceOpening
1322 * @version Introduced in firmware 4.0.10.27
1323 * @param tool GoSurfaceOpening object.
1324 * @return The length tolerance (in mm).
1325 */
1326 GoFx(k64f) GoSurfaceOpening_LengthTolerance(GoSurfaceOpening tool);
1327
1328 /**
1329 * Sets the length tolerance.
1330 *
1331 * @public @memberof GoSurfaceOpening
1332 * @version Introduced in firmware 4.0.10.27
1333 * @param tool GoSurfaceOpening object.
1334 * @param value The length tolerance to set (in mm).
1335 * @return Operation status.
1336 */
1337 GoFx(kStatus) GoSurfaceOpening_SetLengthTolerance(GoSurfaceOpening tool, k64f value);
1338
1339 /**
1340 * Gets the angle tolerance.
1341 *
1342 * @public @memberof GoSurfaceOpening
1343 * @version Introduced in firmware 4.0.10.27
1344 * @param tool GoSurfaceOpening object.
1345 * @return The angle tolerance (in degrees).
1346 */
1347 GoFx(k64f) GoSurfaceOpening_AngleTolerance(GoSurfaceOpening tool);
1348
1349 /**
1350 * Sets the angle tolerance.
1351 *
1352 * @public @memberof GoSurfaceOpening
1353 * @version Introduced in firmware 4.0.10.27
1354 * @param tool GoSurfaceOpening object.
1355 * @param value The angle tolerance to set (in degrees).
1356 * @return Operation status.
1357 */
1358 GoFx(kStatus) GoSurfaceOpening_SetAngleTolerance(GoSurfaceOpening tool, k64f value);
1359
1360 /**
1361 * Gets the enabled state of partial detection.
1362 *
1363 * @public @memberof GoSurfaceOpening
1364 * @version Introduced in firmware 4.0.10.27
1365 * @param tool GoSurfaceOpening object.
1366 * @return kTRUE if partial detection is enabled and kFALSE otherwise.
1367 */
1368 GoFx(kBool) GoSurfaceOpening_PartialDetectionEnabled(GoSurfaceOpening tool);
1369
1370 /**
1371 * Sets the enabled state of partial detection.
1372 *
1373 * @public @memberof GoSurfaceOpening
1374 * @version Introduced in firmware 4.0.10.27
1375 * @param tool GoSurfaceOpening object.
1376 * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1377 * @return Operation status.
1378 */
1379 GoFx(kStatus) GoSurfaceOpening_EnablePartialDetection(GoSurfaceOpening tool, kBool enable);
1380
1381 /**
1382 * Gets the enabled state of the tool region.
1383 *
1384 * @public @memberof GoSurfaceOpening
1385 * @version Introduced in firmware 4.0.10.27
1386 * @param tool GoSurfaceOpening object.
1387 * @return kTRUE if the tool region is enabled and kFALSE otherwise.
1388 */
1389 GoFx(kBool) GoSurfaceOpening_RegionEnabled(GoSurfaceOpening tool);
1390
1391 /**
1392 * Sets the enabled state of the tool region.
1393 *
1394 * @public @memberof GoSurfaceOpening
1395 * @version Introduced in firmware 4.0.10.27
1396 * @param tool GoSurfaceOpening object.
1397 * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1398 * @return Operation status.
1399 */
1400 GoFx(kStatus) GoSurfaceOpening_EnableRegion(GoSurfaceOpening tool, kBool enable);
1401
1402 /**
1403 * Returns the region object for the tool.
1404 *
1405 * @public @memberof GoSurfaceOpening
1406 * @version Introduced in firmware 4.0.10.27
1407 * @param tool GoSurfaceOpening object.
1408 * @return A GoRegion3d object.
1409 */
1410 GoFx(GoRegion3d) GoSurfaceOpening_Region(GoSurfaceOpening tool);
1411
1412 /**
1413 * Gets the enabled state of reference regions.
1414 *
1415 * @public @memberof GoSurfaceOpening
1416 * @version Introduced in firmware 4.0.10.27
1417 * @param tool GoSurfaceOpening object.
1418 * @return kTRUE if reference regions are enabled and kFALSE otherwise.
1419 */
1420 GoFx(kBool) GoSurfaceOpening_RefRegionsEnabled(GoSurfaceOpening tool);
1421
1422 /**
1423 * Sets the enabled state of reference regions.
1424 *
1425 * @public @memberof GoSurfaceOpening
1426 * @version Introduced in firmware 4.0.10.27
1427 * @param tool GoSurfaceOpening object.
1428 * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1429 * @return Operation status.
1430 */
1431 GoFx(kStatus) GoSurfaceOpening_EnableRefRegions(GoSurfaceOpening tool, kBool enable);
1432
1433 /**
1434 * Gets the reference region count.
1435 *
1436 * @public @memberof GoSurfaceOpening
1437 * @version Introduced in firmware 4.0.10.27
1438 * @param tool GoSurfaceOpening object.
1439 * @return The count of reference regions.
1440 */
1441 GoFx(kSize) GoSurfaceOpening_RefRegionCount(GoSurfaceOpening tool);
1442
1443 /**
1444 * Sets the reference region count.
1445 *
1446 * @public @memberof GoSurfaceOpening
1447 * @version Introduced in firmware 4.0.10.27
1448 * @param tool GoSurfaceOpening object.
1449 * @param count The reference region count to set.
1450 * @return Operation status.
1451 * @see GO_SURFACE_OPENING_MAX_REF_REGIONS
1452 */
1453 GoFx(kStatus) GoSurfaceOpening_SetRefRegionCount(GoSurfaceOpening tool, kSize count);
1454
1455 /**
1456 * Gets the reference region object at the specified index.
1457 *
1458 * @public @memberof GoSurfaceOpening
1459 * @version Introduced in firmware 4.0.10.27
1460 * @param tool GoSurfaceOpening object.
1461 * @param index The index with which to retrieve a reference region.
1462 * @return A GoSurfaceRegion2d object or kNULL if the index is invalid.
1463 * @see GoSurfaceOpening_RefRegionCount
1464 */
1465 GoFx(GoSurfaceRegion2d) GoSurfaceOpening_RefRegionAt(GoSurfaceOpening tool, kSize index);
1466
1467 /**
1468 * Gets the enabled state of auto-tilt.
1469 *
1470 * @public @memberof GoSurfaceOpening
1471 * @version Introduced in firmware 4.0.10.27
1472 * @param tool GoSurfaceOpening object.
1473 * @return kTRUE if auto-tilt is enabled and kFALSE otherwise.
1474 */
1475 GoFx(kBool) GoSurfaceOpening_AutoTiltEnabled(GoSurfaceOpening tool);
1476
1477 /**
1478 * Sets the enabled state of auto-tilt.
1479 *
1480 * @public @memberof GoSurfaceOpening
1481 * @version Introduced in firmware 4.0.10.27
1482 * @param tool GoSurfaceOpening object.
1483 * @param enable kTRUE to enable auto-tilt and kFALSE to disable it.
1484 * @return Operation status.
1485 */
1486 GoFx(kStatus) GoSurfaceOpening_EnableAutoTilt(GoSurfaceOpening tool, kBool enable);
1487
1488 /**
1489 * Gets the tilt X-angle.
1490 *
1491 * @public @memberof GoSurfaceOpening
1492 * @version Introduced in firmware 4.0.10.27
1493 * @param tool GoSurfaceOpening object.
1494 * @return The tilt X-angle.
1495 */
1496 GoFx(k64f) GoSurfaceOpening_TiltXAngle(GoSurfaceOpening tool);
1497
1498 /**
1499 * Sets the tilt X-angle.
1500 *
1501 * @public @memberof GoSurfaceOpening
1502 * @version Introduced in firmware 4.0.10.27
1503 * @param tool GoSurfaceOpening object.
1504 * @param value The tilt X-angle to set.
1505 * @return Operation status.
1506 */
1507 GoFx(kStatus) GoSurfaceOpening_SetTiltXAngle(GoSurfaceOpening tool, k64f value);
1508
1509 /**
1510 * Gets the tilt Y-angle.
1511 *
1512 * @public @memberof GoSurfaceOpening
1513 * @version Introduced in firmware 4.0.10.27
1514 * @param tool GoSurfaceOpening object.
1515 * @return The tilt Y-angle.
1516 */
1517 GoFx(k64f) GoSurfaceOpening_TiltYAngle(GoSurfaceOpening tool);
1518
1519 /**
1520 * Sets the tilt Y-angle.
1521 *
1522 * @public @memberof GoSurfaceOpening
1523 * @version Introduced in firmware 4.0.10.27
1524 * @param tool GoSurfaceOpening object.
1525 * @param value The tilt Y-angle to set.
1526 * @return Operation status.
1527 */
1528 GoFx(kStatus) GoSurfaceOpening_SetTiltYAngle(GoSurfaceOpening tool, k64f value);
1529
1530 /**
1531 * Returns a GoSurfaceOpening X measurement object.
1532 *
1533 * @public @memberof GoSurfaceOpening
1534 * @version Introduced in firmware 4.0.10.27
1535 * @param tool GoSurfaceOpening object.
1536 * @return A GoSurfaceOpening X measurement.
1537 */
1538 GoFx(GoSurfaceOpeningX) GoSurfaceOpening_XMeasurement(GoSurfaceOpening tool);
1539
1540 /**
1541 * Returns a GoSurfaceOpening Y measurement object.
1542 *
1543 * @public @memberof GoSurfaceOpening
1544 * @version Introduced in firmware 4.0.10.27
1545 * @param tool GoSurfaceOpening object.
1546 * @return A GoSurfaceOpening Y measurement.
1547 */
1548 GoFx(GoSurfaceOpeningY) GoSurfaceOpening_YMeasurement(GoSurfaceOpening tool);
1549
1550 /**
1551 * Returns a GoSurfaceOpening Z measurement object.
1552 *
1553 * @public @memberof GoSurfaceOpening
1554 * @version Introduced in firmware 4.0.10.27
1555 * @param tool GoSurfaceOpening object.
1556 * @return A GoSurfaceOpening Z measurement.
1557 */
1558 GoFx(GoSurfaceOpeningZ) GoSurfaceOpening_ZMeasurement(GoSurfaceOpening tool);
1559
1560 /**
1561 * Returns a GoSurfaceOpening Width measurement object.
1562 *
1563 * @public @memberof GoSurfaceOpening
1564 * @version Introduced in firmware 4.0.10.27
1565 * @param tool GoSurfaceOpening object.
1566 * @return A GoSurfaceOpening Width measurement.
1567 */
1568 GoFx(GoSurfaceOpeningWidth) GoSurfaceOpening_WidthMeasurement(GoSurfaceOpening tool);
1569
1570 /**
1571 * Returns a GoSurfaceOpening Length measurement object.
1572 *
1573 * @public @memberof GoSurfaceOpening
1574 * @version Introduced in firmware 4.0.10.27
1575 * @param tool GoSurfaceOpening object.
1576 * @return A GoSurfaceOpening Length measurement.
1577 */
1578 GoFx(GoSurfaceOpeningLength) GoSurfaceOpening_LengthMeasurement(GoSurfaceOpening tool);
1579
1580 /**
1581 * Returns a GoSurfaceOpening Angle measurement object.
1582 *
1583 * @public @memberof GoSurfaceOpening
1584 * @version Introduced in firmware 4.0.10.27
1585 * @param tool GoSurfaceOpening object.
1586 * @return A GoSurfaceOpening Angle measurement.
1587 */
1588 GoFx(GoSurfaceOpeningAngle) GoSurfaceOpening_AngleMeasurement(GoSurfaceOpening tool);
1589
1590
1591 /**
1592 * @class GoSurfacePlane
1593 * @extends GoSurfaceTool
1594 * @ingroup GoSdk-SurfaceTools
1595 * @brief Represents a surface plane tool.
1596 */
1597 typedef GoSurfaceTool GoSurfacePlane;
1598
1599 /**
1600 * Gets the enabled state of the reference regions.
1601 *
1602 * @public @memberof GoSurfacePlane
1603 * @version Introduced in firmware 4.0.10.27
1604 * @param tool GoSurfacePlane object.
1605 * @return kTRUE if the tool region is enabled and kFALSE otherwise.
1606 */
1607 GoFx(kBool) GoSurfacePlane_RegionsEnabled(GoSurfacePlane tool);
1608
1609 /**
1610 * Sets the enabled state of the reference regions.
1611 *
1612 * @public @memberof GoSurfacePlane
1613 * @version Introduced in firmware 4.0.10.27
1614 * @param tool GoSurfacePlane object.
1615 * @param enable kTRUE to enable regions and kFALSE to disable them.
1616 * @return Operation status.
1617 */
1618 GoFx(kStatus) GoSurfacePlane_EnableRegions(GoSurfacePlane tool, kBool enable);
1619
1620 /**
1621 * Gets the tool's region count.
1622 *
1623 * @public @memberof GoSurfacePlane
1624 * @version Introduced in firmware 4.0.10.27
1625 * @param tool GoSurfacePlane object.
1626 * @return The number of regions in the tool.
1627 */
1628 GoFx(kSize) GoSurfacePlane_RegionCount(GoSurfacePlane tool);
1629
1630 /**
1631 * Sets the tool region count.
1632 *
1633 * @public @memberof GoSurfacePlane
1634 * @version Introduced in firmware 4.0.10.27
1635 * @param tool GoSurfacePlane object.
1636 * @param count The region count to set.
1637 * @return Operation status.
1638 */
1639 GoFx(kStatus) GoSurfacePlane_SetRegionCount(GoSurfacePlane tool, kSize count);
1640
1641 /**
1642 * Gets a region at the specified index.
1643 *
1644 * @public @memberof GoSurfacePlane
1645 * @version Introduced in firmware 4.0.10.27
1646 * @param tool GoSurfacePlane object.
1647 * @param index The index with which to return a tool region.
1648 * @return A GoRegion3d object or kNULL if the index is in invalid.
1649 * @see GoSurfacePlane_RegionCount
1650 */
1651 GoFx(GoRegion3d) GoSurfacePlane_RegionAt(GoSurfacePlane tool, kSize index);
1652
1653 /**
1654 * Returns a GoSurfacePlane X Angle measurement object.
1655 *
1656 * @public @memberof GoSurfacePlane
1657 * @version Introduced in firmware 4.0.10.27
1658 * @param tool GoSurfacePlane object.
1659 * @return A GoSurfacePlane X Angle measurement.
1660 */
1661 GoFx(GoSurfacePlaneXAngle) GoSurfacePlane_XAngleMeasurement(GoSurfacePlane tool);
1662
1663 /**
1664 * Returns a GoSurfacePlane Y Angle measurement object.
1665 *
1666 * @public @memberof GoSurfacePlane
1667 * @version Introduced in firmware 4.0.10.27
1668 * @param tool GoSurfacePlane object.
1669 * @return A GoSurfacePlane Y Angle measurement.
1670 */
1671 GoFx(GoSurfacePlaneYAngle) GoSurfacePlane_YAngleMeasurement(GoSurfacePlane tool);
1672
1673 /**
1674 * Returns a GoSurfacePlane Z Offset measurement object.
1675 *
1676 * @public @memberof GoSurfacePlane
1677 * @version Introduced in firmware 4.0.10.27
1678 * @param tool GoSurfacePlane object.
1679 * @return A GoSurfacePlane Z Offset measurement.
1680 */
1681 GoFx(GoSurfacePlaneZOffset) GoSurfacePlane_ZOffsetMeasurement(GoSurfacePlane tool);
1682
1683
1684 /**
1685 * @class GoSurfacePosition
1686 * @extends GoSurfaceTool
1687 * @ingroup GoSdk-SurfaceTools
1688 * @brief Represents a surface position tool.
1689 */
1690 typedef GoSurfaceTool GoSurfacePosition;
1691
1692 GoFx(GoSurfaceFeature) GoSurfacePosition_Feature(GoSurfacePosition tool);
1693
1694 /**
1695 * Returns a GoSurfacePosition X measurement object.
1696 *
1697 * @public @memberof GoSurfacePosition
1698 * @version Introduced in firmware 4.0.10.27
1699 * @param tool GoSurfacePosition object.
1700 * @return A GoSurfacePosition X measurement.
1701 */
1702 GoFx(GoSurfacePositionX) GoSurfacePosition_XMeasurement(GoSurfacePosition tool);
1703
1704 /**
1705 * Returns a GoSurfacePosition Y measurement object.
1706 *
1707 * @public @memberof GoSurfacePosition
1708 * @version Introduced in firmware 4.0.10.27
1709 * @param tool GoSurfacePosition object.
1710 * @return A GoSurfacePosition Y measurement.
1711 */
1712 GoFx(GoSurfacePositionY) GoSurfacePosition_YMeasurement(GoSurfacePosition tool);
1713
1714 /**
1715 * Returns a GoSurfacePosition Z measurement object.
1716 *
1717 * @public @memberof GoSurfacePosition
1718 * @version Introduced in firmware 4.0.10.27
1719 * @param tool GoSurfacePosition object.
1720 * @return A GoSurfacePosition Z measurement.
1721 */
1722 GoFx(GoSurfacePositionZ) GoSurfacePosition_ZMeasurement(GoSurfacePosition tool);
1723
1724
1725 /**
1726 * @class GoSurfaceStud
1727 * @extends GoSurfaceTool
1728 * @ingroup GoSdk-SurfaceTools
1729 * @brief Represents a surface stud tool.
1730 */
1731 typedef GoSurfaceTool GoSurfaceStud;
1732
1733 /**
1734 * Returns the stud radius value.
1735 *
1736 * @public @memberof GoSurfaceStud
1737 * @version Introduced in firmware 4.0.10.27
1738 * @param tool GoSurfaceStud object.
1739 * @return The stud radius value.
1740 */
1741 GoFx(k64f) GoSurfaceStud_StudRadius(GoSurfaceStud tool);
1742
1743 /**
1744 * Sets the stud radius value.
1745 *
1746 * @public @memberof GoSurfaceStud
1747 * @version Introduced in firmware 4.0.10.27
1748 * @param tool GoSurfaceStud object.
1749 * @param value The stud radius value to set.
1750 * @return Operation status.
1751 */
1752 GoFx(kStatus) GoSurfaceStud_SetStudRadius(GoSurfaceStud tool, k64f value);
1753
1754 /**
1755 * Returns the stud height value.
1756 *
1757 * @public @memberof GoSurfaceStud
1758 * @version Introduced in firmware 4.0.10.27
1759 * @param tool GoSurfaceStud object.
1760 * @return The stud height value.
1761 */
1762 GoFx(k64f) GoSurfaceStud_StudHeight(GoSurfaceStud tool);
1763
1764 /**
1765 * Sets the stud height value.
1766 *
1767 * @public @memberof GoSurfaceStud
1768 * @version Introduced in firmware 4.0.10.27
1769 * @param tool GoSurfaceStud object.
1770 * @param value The stud height value to set.
1771 * @return Operation status.
1772 */
1773 GoFx(kStatus) GoSurfaceStud_SetStudHeight(GoSurfaceStud tool, k64f value);
1774
1775 /**
1776 * Returns the stud base height value.
1777 *
1778 * @public @memberof GoSurfaceStud
1779 * @version Introduced in firmware 4.0.10.27
1780 * @param tool GoSurfaceStud object.
1781 * @return The stud base height value.
1782 */
1783 GoFx(k64f) GoSurfaceStud_BaseHeight(GoSurfaceStud tool);
1784
1785 /**
1786 * Sets the base height value.
1787 *
1788 * @public @memberof GoSurfaceStud
1789 * @version Introduced in firmware 4.0.10.27
1790 * @param tool GoSurfaceStud object.
1791 * @param value The base height value to set.
1792 * @return Operation status.
1793 */
1794 GoFx(kStatus) GoSurfaceStud_SetBaseHeight(GoSurfaceStud tool, k64f value);
1795
1796 /**
1797 * Returns the stud tip height value.
1798 *
1799 * @public @memberof GoSurfaceStud
1800 * @version Introduced in firmware 4.0.10.27
1801 * @param tool GoSurfaceStud object.
1802 * @return The stud tip height value.
1803 */
1804 GoFx(k64f) GoSurfaceStud_TipHeight(GoSurfaceStud tool);
1805
1806 /**
1807 * Sets the tip height value.
1808 *
1809 * @public @memberof GoSurfaceStud
1810 * @version Introduced in firmware 4.0.10.27
1811 * @param tool GoSurfaceStud object.
1812 * @param value The tip height value to set.
1813 * @return Operation status.
1814 */
1815 GoFx(kStatus) GoSurfaceStud_SetTipHeight(GoSurfaceStud tool, k64f value);
1816
1817 /**
1818 * Gets the enabled state of the tool region.
1819 *
1820 * @public @memberof GoSurfaceStud
1821 * @version Introduced in firmware 4.0.10.27
1822 * @param tool GoSurfaceStud object.
1823 * @return kTRUE if enabled and kFALSE if disabled.
1824 */
1825 GoFx(kBool) GoSurfaceStud_RegionEnabled(GoSurfaceStud tool);
1826
1827 /**
1828 * Sets the enabled state of the tool region.
1829 *
1830 * @public @memberof GoSurfaceStud
1831 * @version Introduced in firmware 4.0.10.27
1832 * @param tool GoSurfaceStud object.
1833 * @param enable kTRUE to enable the region and kFALSE to disable it.
1834 * @return Operation status.
1835 */
1836 GoFx(kStatus) GoSurfaceStud_EnableRegion(GoSurfaceStud tool, kBool enable);
1837
1838 /**
1839 * Returns the tool region object.
1840 *
1841 * @public @memberof GoSurfaceStud
1842 * @version Introduced in firmware 4.0.10.27
1843 * @param tool GoSurfaceStud object.
1844 * @return A GoRegion3d object.
1845 */
1846 GoFx(GoRegion3d) GoSurfaceStud_Region(GoSurfaceStud tool);
1847
1848 /**
1849 * Gets the enabled state of the reference regions.
1850 *
1851 * @public @memberof GoSurfaceStud
1852 * @version Introduced in firmware 4.0.10.27
1853 * @param tool GoSurfaceStud object.
1854 * @return enable kTRUE if the reference regions are enabled and kFALSE otherwise.
1855 */
1856 GoFx(kBool) GoSurfaceStud_RefRegionsEnabled(GoSurfaceStud tool);
1857
1858 /**
1859 * Sets the enabled state of the reference regions.
1860 *
1861 * @public @memberof GoSurfaceStud
1862 * @version Introduced in firmware 4.0.10.27
1863 * @param tool GoSurfaceStud object.
1864 * @param enable kTRUE to enable the region and kFALSE to disable it.
1865 * @return Operation status.
1866 */
1867 GoFx(kStatus) GoSurfaceStud_EnableRefRegions(GoSurfaceStud tool, kBool enable);
1868
1869 /**
1870 * Sets the reference region count.
1871 *
1872 * @public @memberof GoSurfaceStud
1873 * @version Introduced in firmware 4.0.10.27
1874 * @param tool GoSurfaceStud object.
1875 * @param count The number of reference regions to use.
1876 * @return Operation status.
1877 * @see GO_SURFACE_STUD_MAX_REF_REGIONS
1878 */
1879 GoFx(kStatus) GoSurfaceStud_SetRefRegionCount(GoSurfaceStud tool, kSize count);
1880
1881 /**
1882 * Returns the reference region count.
1883 *
1884 * @public @memberof GoSurfaceStud
1885 * @version Introduced in firmware 4.0.10.27
1886 * @param tool GoSurfaceStud object.
1887 * @return The reference region count.
1888 */
1889 GoFx(kSize) GoSurfaceStud_RefRegionCount(GoSurfaceStud tool);
1890
1891 /**
1892 * Returns the reference region object at the given index.
1893 *
1894 * @public @memberof GoSurfaceStud
1895 * @version Introduced in firmware 4.0.10.27
1896 * @param tool GoSurfaceStud object.
1897 * @param index The index with which to return a reference region.
1898 * @return A GoSurfaceRegion2d object.
1899 * @see GoSurfaceStud_RefRegionCount
1900 */
1901 GoFx(GoSurfaceRegion2d) GoSurfaceStud_RefRegionAt(GoSurfaceStud tool, kSize index);
1902
1903 /**
1904 * Gets the enabled state of auto-tilt.
1905 *
1906 * @public @memberof GoSurfaceStud
1907 * @version Introduced in firmware 4.0.10.27
1908 * @param tool GoSurfaceStud object.
1909 * @return kTRUE if enabled and kFALSE if disabled.
1910 */
1911 GoFx(kBool) GoSurfaceStud_AutoTiltEnabled(GoSurfaceStud tool);
1912
1913 /**
1914 * Sets the enabled state of auto-tilt.
1915 *
1916 * @public @memberof GoSurfaceStud
1917 * @version Introduced in firmware 4.0.10.27
1918 * @param tool GoSurfaceStud object.
1919 * @param enable kTRUE to enable the region and kFALSE to disable it.
1920 * @return Operation status.
1921 */
1922 GoFx(kStatus) GoSurfaceStud_EnableAutoTilt(GoSurfaceStud tool, kBool enable);
1923
1924 /**
1925 * Gets the tilt X-angle value.
1926 *
1927 * @public @memberof GoSurfaceStud
1928 * @version Introduced in firmware 4.0.10.27
1929 * @param tool GoSurfaceStud object.
1930 * @return The tilt X-angle value.
1931 */
1932 GoFx(k64f) GoSurfaceStud_TiltXAngle(GoSurfaceStud tool);
1933
1934 /**
1935 * Sets the tilt X-angle value.
1936 *
1937 * @public @memberof GoSurfaceStud
1938 * @version Introduced in firmware 4.0.10.27
1939 * @param tool GoSurfaceStud object.
1940 * @param value The tilt X-angle value to set.
1941 * @return Operation status.
1942 */
1943 GoFx(kStatus) GoSurfaceStud_SetTiltXAngle(GoSurfaceStud tool, k64f value);
1944
1945 /**
1946 * Returns the tilt Y-angle value.
1947 *
1948 * @public @memberof GoSurfaceStud
1949 * @version Introduced in firmware 4.0.10.27
1950 * @param tool GoSurfaceStud object.
1951 * @return The tilt Y-angle value.
1952 */
1953 GoFx(k64f) GoSurfaceStud_TiltYAngle(GoSurfaceStud tool);
1954
1955 /**
1956 * Sets the tilt Y-angle value.
1957 *
1958 * @public @memberof GoSurfaceStud
1959 * @version Introduced in firmware 4.0.10.27
1960 * @param tool GoSurfaceStud object.
1961 * @param value The tilt Y-angle value to set.
1962 * @return Operation status.
1963 */
1964 GoFx(kStatus) GoSurfaceStud_SetTiltYAngle(GoSurfaceStud tool, k64f value);
1965
1966 /**
1967 * Returns a GoSurfaceStud Base X measurement object.
1968 *
1969 * @public @memberof GoSurfaceStud
1970 * @version Introduced in firmware 4.0.10.27
1971 * @param tool GoSurfaceStud object.
1972 * @return A GoSurfaceStud Base X measurement.
1973 */
1974 GoFx(GoSurfaceStudBaseX) GoSurfaceStud_BaseXMeasurement(GoSurfaceStud tool);
1975
1976 /**
1977 * Returns a GoSurfaceStud Base Y measurement object.
1978 *
1979 * @public @memberof GoSurfaceStud
1980 * @version Introduced in firmware 4.0.10.27
1981 * @param tool GoSurfaceStud object.
1982 * @return A GoSurfaceStud Base Y measurement.
1983 */
1984 GoFx(GoSurfaceStudBaseY) GoSurfaceStud_BaseYMeasurement(GoSurfaceStud tool);
1985
1986 /**
1987 * Returns a GoSurfaceStud Base Z measurement object.
1988 *
1989 * @public @memberof GoSurfaceStud
1990 * @version Introduced in firmware 4.0.10.27
1991 * @param tool GoSurfaceStud object.
1992 * @return A GoSurfaceStud Base Z measurement.
1993 */
1994 GoFx(GoSurfaceStudBaseZ) GoSurfaceStud_BaseZMeasurement(GoSurfaceStud tool);
1995
1996 /**
1997 * Returns a GoSurfaceStud Tip X measurement object.
1998 *
1999 * @public @memberof GoSurfaceStud
2000 * @version Introduced in firmware 4.0.10.27
2001 * @param tool GoSurfaceStud object.
2002 * @return A GoSurfaceStud Tip X measurement.
2003 */
2004 GoFx(GoSurfaceStudTipX) GoSurfaceStud_TipXMeasurement(GoSurfaceStud tool);
2005
2006 /**
2007 * Returns a GoSurfaceStud Tip Y measurement object.
2008 *
2009 * @public @memberof GoSurfaceStud
2010 * @version Introduced in firmware 4.0.10.27
2011 * @param tool GoSurfaceStud object.
2012 * @return A GoSurfaceStud Tip Y measurement.
2013 */
2014 GoFx(GoSurfaceStudTipY) GoSurfaceStud_TipYMeasurement(GoSurfaceStud tool);
2015
2016 /**
2017 * Returns a GoSurfaceStud Tip Z measurement object.
2018 *
2019 * @public @memberof GoSurfaceStud
2020 * @version Introduced in firmware 4.0.10.27
2021 * @param tool GoSurfaceStud object.
2022 * @return A GoSurfaceStud Tip Z measurement.
2023 */
2024 GoFx(GoSurfaceStudTipZ) GoSurfaceStud_TipZMeasurement(GoSurfaceStud tool);
2025
2026 /**
2027 * Returns a GoSurfaceStud Radius measurement object.
2028 *
2029 * @public @memberof GoSurfaceStud
2030 * @version Introduced in firmware 4.0.10.27
2031 * @param tool GoSurfaceStud object.
2032 * @return A GoSurfaceStud Radius measurement.
2033 */
2034 GoFx(GoSurfaceStudRadius) GoSurfaceStud_RadiusMeasurement(GoSurfaceStud tool);
2035
2036
2037 /**
2038 * @class GoSurfaceVolume
2039 * @extends GoSurfaceTool
2040 * @ingroup GoSdk-SurfaceTools
2041 * @brief Represents a surface volume tool.
2042 */
2043 typedef GoSurfaceTool GoSurfaceVolume;
2044
2045 /**
2046 * Gets the enabled state of the tool region.
2047 *
2048 * @public @memberof GoSurfaceVolume
2049 * @version Introduced in firmware 4.0.10.27
2050 * @param tool GoSurfaceVolume object.
2051 * @return kTRUE if enabled and kFALSE if disabled.
2052 */
2053 GoFx(kBool) GoSurfaceVolume_RegionEnabled(GoSurfaceVolume tool);
2054
2055 /**
2056 * Sets the enabled state of the tool region.
2057 *
2058 * @public @memberof GoSurfaceVolume
2059 * @version Introduced in firmware 4.0.10.27
2060 * @param tool GoSurfaceVolume object.
2061 * @param enable kTRUE to enable the tool region and kFALSE to disable it.
2062 */
2063 GoFx(kStatus) GoSurfaceVolume_EnableRegion(GoSurfaceVolume tool, kBool enable);
2064
2065 /**
2066 * Returns the tool region object.
2067 *
2068 * @public @memberof GoSurfaceVolume
2069 * @version Introduced in firmware 4.0.10.27
2070 * @param tool GoSurfaceVolume object.
2071 * @return A GoRegion3d object.
2072 */
2073 GoFx(GoRegion3d) GoSurfaceVolume_Region(GoSurfaceVolume tool);
2074
2075 /**
2076 * Returns a GoSurfaceVolume Volume measurement object.
2077 *
2078 * @public @memberof GoSurfaceVolume
2079 * @version Introduced in firmware 4.0.10.27
2080 * @param tool GoSurfaceVolume object.
2081 * @return A GoSurfaceVolume Volume measurement.
2082 */
2083 GoFx(GoSurfaceVolumeVolume) GoSurfaceVolume_VolumeMeasurement(GoSurfaceVolume tool);
2084
2085 /**
2086 * Returns a GoSurfaceVolume Area measurement object.
2087 *
2088 * @public @memberof GoSurfaceVolume
2089 * @version Introduced in firmware 4.0.10.27
2090 * @param tool GoSurfaceVolume object.
2091 * @return A GoSurfaceVolume Area measurement.
2092 */
2093 GoFx(GoSurfaceVolumeArea) GoSurfaceVolume_AreaMeasurement(GoSurfaceVolume tool);
2094
2095 /**
2096 * Returns a GoSurfaceVolume Thickness measurement object.
2097 *
2098 * @public @memberof GoSurfaceVolume
2099 * @version Introduced in firmware 4.0.10.27
2100 * @param tool GoSurfaceVolume object.
2101 * @return A GoSurfaceVolume Thickness measurement.
2102 */
2103 GoFx(GoSurfaceVolumeThickness) GoSurfaceVolume_ThicknessMeasurement(GoSurfaceVolume tool);
2104
2105
2106 /**
2107 * @class GoSurfaceRivet
2108 * @extends GoSurfaceTool
2109 * @ingroup GoSdk-SurfaceTools
2110 * @brief Represents a surface rivet tool.
2111 */
2112 typedef GoSurfaceTool GoSurfaceRivet;
2113
2114
2115 /**
2116 * Gets the current nominal height value.
2117 *
2118 * @public @memberof GoSurfaceRivet
2119 * @param tool GoSurfaceRivet object.
2120 * @return The nominal height value.
2121 */
2122 GoFx(k64f) GoSurfaceRivet_NominalHeight(GoSurfaceRivet tool);
2123
2124 /**
2125 * Sets the nominal height value.
2126 *
2127 * @public @memberof GoSurfaceRivet
2128 * @param tool GoSurfaceRivet object.
2129 * @param nominalHeight Nominal height value to set.
2130 * @return Operation status.
2131 */
2132 GoFx(kStatus) GoSurfaceRivet_SetNominalHeight(GoSurfaceRivet tool, k64f nominalHeight);
2133
2134
2135 /**
2136 * Gets the current nominal radius value.
2137 *
2138 * @public @memberof GoSurfaceRivet
2139 * @param tool GoSurfaceRivet object.
2140 * @return The nominal radius value.
2141 */
2142 GoFx(k64f) GoSurfaceRivet_NominalRadius(GoSurfaceRivet tool);
2143
2144 /**
2145 * Sets the nominal radius value.
2146 *
2147 * @public @memberof GoSurfaceRivet
2148 * @param tool GoSurfaceRivet object.
2149 * @param nominalRadius Nominal radius value to set.
2150 * @return Operation status.
2151 */
2152 GoFx(kStatus) GoSurfaceRivet_SetNominalRadius(GoSurfaceRivet tool, k64f nominalRadius);
2153
2154 /**
2155 * Gets the current radius tolerance value.
2156 *
2157 * @public @memberof GoSurfaceRivet
2158 * @param tool GoSurfaceRivet object.
2159 * @return The radius tolerance value.
2160 */
2161 GoFx(k64f) GoSurfaceRivet_RadiusTolerance(GoSurfaceRivet tool);
2162
2163 /**
2164 * Sets the radius tolerance value.
2165 *
2166 * @public @memberof GoSurfaceRivet
2167 * @param tool GoSurfaceRivet object.
2168 * @param radiusTolerance The radius tolerance value to set.
2169 * @return Operation status.
2170 */
2171 GoFx(kStatus) GoSurfaceRivet_SetRadiusTolerance(GoSurfaceRivet tool, k64f radiusTolerance);
2172
2173 /**
2174 * Gets the enabled state of partial detection.
2175 *
2176 * @public @memberof GoSurfaceRivet
2177 * @param tool GoSurfaceRivet object.
2178 * @return kTRUE if enabled and kFALSE if disabled.
2179 */
2180 GoFx(kBool) GoSurfaceRivet_PartialDetectionEnabled(GoSurfaceRivet tool);
2181
2182 /**
2183 * Sets the enabled state of partial detection.
2184 *
2185 * @public @memberof GoSurfaceRivet
2186 * @param tool GoSurfaceRivet object.
2187 * @param enable kTRUE to enable partial detection and kFALSE to disable it.
2188 * @return Operation status.
2189 */
2190 GoFx(kStatus) GoSurfaceRivet_EnablePartialDetection(GoSurfaceRivet tool, kBool enable);
2191
2192 /**
2193 * Gets the enabled state of the tool region.
2194 *
2195 * @public @memberof GoSurfaceRivet
2196 * @param tool GoSurfaceRivet object.
2197 * @return kTRUE if enabled and kFALSE if disabled.
2198 */
2199 GoFx(kBool) GoSurfaceRivet_RegionEnabled(GoSurfaceRivet tool);
2200
2201 /**
2202 * Sets the enabled state of the tool region.
2203 *
2204 * @public @memberof GoSurfaceRivet
2205 * @param tool GoSurfaceRivet object.
2206 * @param enable kTRUE to enable the tool region and kFALSE to disable it.
2207 * @return Operation status.
2208 */
2209 GoFx(kStatus) GoSurfaceRivet_EnableRegion(GoSurfaceRivet tool, kBool enable);
2210
2211 /**
2212 * Returns the tool's region object.
2213 *
2214 * @public @memberof GoSurfaceRivet
2215 * @param tool GoSurfaceRivet object.
2216 * @return A GoRegion3d object.
2217 */
2218 GoFx(GoRegion3d) GoSurfaceRivet_Region(GoSurfaceRivet tool);
2219
2220 /**
2221 * Gets the enabled state of reference regions.
2222 *
2223 * @public @memberof GoSurfaceRivet
2224 * @param tool GoSurfaceRivet object.
2225 * @return kTRUE if enabled and kFALSE if disabled.
2226 */
2227 GoFx(kBool) GoSurfaceRivet_RefRegionsEnabled(GoSurfaceRivet tool);
2228
2229 /**
2230 * Sets the enabled state of reference regions.
2231 *
2232 * @public @memberof GoSurfaceRivet
2233 * @param tool GoSurfaceRivet object.
2234 * @param enable kTRUE to enable reference regions and kFALSE to disable it.
2235 * @return Operation status.
2236 */
2237 GoFx(kStatus) GoSurfaceRivet_EnableRefRegions(GoSurfaceRivet tool, kBool enable);
2238
2239 /**
2240 * Gets the reference region count.
2241 *
2242 * @public @memberof GoSurfaceRivet
2243 * @param tool GoSurfaceRivet object.
2244 * @return The reference region count.
2245 */
2246 GoFx(kSize) GoSurfaceRivet_RefRegionCount(GoSurfaceRivet tool);
2247
2248 /**
2249 * Sets the reference region count.
2250 *
2251 * @public @memberof GoSurfaceRivet
2252 * @param tool GoSurfaceRivet object.
2253 * @param count The reference region count.
2254 * @return Operation status.
2255 * @see GO_SURFACE_RIVET_MAX_REF_REGIONS
2256 */
2257 GoFx(kStatus) GoSurfaceRivet_SetRefRegionCount(GoSurfaceRivet tool, kSize count);
2258
2259 /**
2260 * Gets a reference region object at the given index.
2261 *
2262 * @public @memberof GoSurfaceRivet
2263 * @param tool GoSurfaceRivet object.
2264 * @param index The index with which to retrieve a reference region.
2265 * @return A GoSurfaceRegion2d object.
2266 * @see GoSurfaceRivet_RefRegionCount
2267 */
2268 GoFx(GoSurfaceRegion2d) GoSurfaceRivet_RefRegionAt(GoSurfaceRivet tool, kSize index);
2269
2270 /**
2271 * Gets the enabled state of auto-tilt.
2272 *
2273 * @public @memberof GoSurfaceRivet
2274 * @param tool GoSurfaceRivet object.
2275 * @return kTRUE if enabled and kFALSE if disabled.
2276 */
2277 GoFx(kBool) GoSurfaceRivet_AutoTiltEnabled(GoSurfaceRivet tool);
2278
2279 /**
2280 * Sets the enabled state of auto-tilt.
2281 *
2282 * @public @memberof GoSurfaceRivet
2283 * @param tool GoSurfaceRivet object.
2284 * @param enable kTRUE to enable it and kFALSE to disable it.
2285 * @return Operation status.
2286 */
2287 GoFx(kStatus) GoSurfaceRivet_EnableAutoTilt(GoSurfaceRivet tool, kBool enable);
2288
2289 /**
2290 * Gets the tilt X-angle value.
2291 *
2292 * @public @memberof GoSurfaceRivet
2293 * @param tool GoSurfaceRivet object.
2294 * @return Tilt X-angle value.
2295 */
2296 GoFx(k64f) GoSurfaceRivet_TiltXAngle(GoSurfaceRivet tool);
2297
2298 /**
2299 * Sets the tilt X-angle value.
2300 *
2301 * @public @memberof GoSurfaceRivet
2302 * @param tool GoSurfaceRivet object.
2303 * @param value The tilt X-angle value to set.
2304 * @return Operation status.
2305 */
2306 GoFx(kStatus) GoSurfaceRivet_SetTiltXAngle(GoSurfaceRivet tool, k64f value);
2307
2308 /**
2309 * Gets the tilt Y-angle value.
2310 *
2311 * @public @memberof GoSurfaceRivet
2312 * @param tool GoSurfaceRivet object.
2313 * @return Tilt Y-angle value.
2314 */
2315 GoFx(k64f) GoSurfaceRivet_TiltYAngle(GoSurfaceRivet tool);
2316
2317 /**
2318 * Sets the tilt Y-angle value.
2319 *
2320 * @public @memberof GoSurfaceRivet
2321 * @param tool GoSurfaceRivet object.
2322 * @param value The tilt Y-angle value to set.
2323 * @return Operation status.
2324 */
2325 GoFx(kStatus) GoSurfaceRivet_SetTiltYAngle(GoSurfaceRivet tool, k64f value);
2326
2327 /**
2328 * Gets the rivet type.
2329 *
2330 * @public @memberof GoSurfaceRivet
2331 * @param tool GoSurfaceRivet object.
2332 * @return Rivet type value.
2333 */
2334 GoFx(GoSurfaceRivetType) GoSurfaceRivet_Type(GoSurfaceRivet tool);
2335
2336 /**
2337 * Sets the rivet type.
2338 *
2339 * @public @memberof GoSurfaceRivet
2340 * @param tool GoSurfaceRivet object.
2341 * @param type The rivet type to set.
2342 * @return Operation status.
2343 */
2344 GoFx(kStatus) GoSurfaceRivet_SetType(GoSurfaceRivet tool, GoSurfaceRivetType type);
2345
2346 /**
2347 * Gets the edge sensitivity.
2348 *
2349 * @public @memberof GoSurfaceRivet
2350 * @param tool GoSurfaceRivet object.
2351 * @return Sensitivity value.
2352 */
2353 GoFx(k64f) GoSurfaceRivet_EdgeSensitivity(GoSurfaceRivet tool);
2354
2355 /**
2356 * Sets the edge sensitivity.
2357 *
2358 * @public @memberof GoSurfaceRivet
2359 * @param tool GoSurfaceRivet object.
2360 * @param value Value to set.
2361 * @return Operation status.
2362 */
2363 GoFx(kStatus) GoSurfaceRivet_SetEdgeSensitivity(GoSurfaceRivet tool, k64f value);
2364
2365 /**
2366 * Gets the inner padding.
2367 *
2368 * @public @memberof GoSurfaceRivet
2369 * @param tool GoSurfaceRivet object.
2370 * @return Inner padding value.
2371 */
2372 GoFx(k64f) GoSurfaceRivet_InnerPadding(GoSurfaceRivet tool);
2373
2374 /**
2375 * Sets the inner padding.
2376 *
2377 * @public @memberof GoSurfaceRivet
2378 * @param tool GoSurfaceRivet object.
2379 * @param value Value to set.
2380 * @return Operation status.
2381 */
2382 GoFx(kStatus) GoSurfaceRivet_SetInnerPadding(GoSurfaceRivet tool, k64f value);
2383
2384 /**
2385 * Adds a new rivet tool measurement.
2386 *
2387 * @public @memberof GoSurfaceRivet
2388 * @param tool GoSurfaceRivet object.
2389 * @param type The measurement type that is being added.
2390 * @param measurement A handle to the newly added measurement. (can be kNULL)
2391 * @return Operation status.
2392 */
2393 GoFx(kStatus) GoSurfaceRivet_AddMeasurement(GoSurfaceRivet tool, GoMeasurementType type, GoMeasurement* measurement);
2394
2395 /**
2396 * Removes a measurement at the given index.
2397 *
2398 * @public @memberof GoSurfaceRivet
2399 * @param tool GoSurfaceRivet object.
2400 * @param index The index of the measurement to remove.
2401 * @return Operation status.
2402 */
2403 GoFx(kStatus) GoSurfaceRivet_RemoveMeasurement(GoSurfaceRivet tool, kSize index);
2404
2405 /**
2406 * Gets the measurement count.
2407 *
2408 * @public @memberof GoSurfaceRivet
2409 * @param tool GoSurfaceRivet object.
2410 * @return Measurement count.
2411 */
2412 GoFx(kSize) GoSurfaceRivet_MeasurementCount(GoSurfaceRivet tool);
2413
2414 /**
2415 * Gets the measurement at the given index.
2416 *
2417 * @public @memberof GoSurfaceRivet
2418 * @param tool GoSurfaceRivet object.
2419 * @param index The index of the measurement to return.
2420 * @return A rivet tool measurement handle.
2421 */
2422 GoFx(GoMeasurement) GoSurfaceRivet_MeasurementAt(GoSurfaceRivet tool, kSize index);
2423
2424 kEndHeader()
2425 #include <GoSdk/Tools/GoSurfaceTools.x.h>
2426
2427 #endif
2428
2429 /// @endcond
k32u
GoTool.h
Declares the base GoTool class.
GoMeasurement
Represents the base class for a tool measurement or script output.
GoMeasurementType
Lists all measurement types.
kSize
GoDataSource
Represents a data source.
GoUtils.h
Contains various helper functions.
GoSdkDef.h
Essential SDK declarations.
GoTool
Represents the base tool class.
k32s
kStatus
k64f
kBool