Gocator API
 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) 2016 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  * Sets the asymmetry detection type.
294  *
295  * @public @memberof GoSurfaceBox
296  * @version Introduced in firmware 4.4.4.14
297  * @param tool GoSurfaceBox object.
298  * @param value The asymmetry detection type to set.
299  * @return Operation status.
300  */
301 GoFx(kStatus) GoSurfaceBox_SetAsymmetryDetectionType(GoSurfaceBox tool, GoBoxAsymmetryType value);
302 
303 /**
304  * Gets the asymmetry detection type.
305  *
306  * @public @memberof GoSurfaceBox
307  * @version Introduced in firmware 4.4.4.14
308  * @param tool GoSurfaceBox object.
309  * @return The asymmetry detection type.
310  */
311 GoFx(GoBoxAsymmetryType) GoSurfaceBox_AsymmetryDetectionType(GoSurfaceBox tool);
312 
313 /**
314  * Returns a GoSurfaceBox X measurement object.
315  *
316  * @public @memberof GoSurfaceBox
317  * @version Introduced in firmware 4.0.10.27
318  * @param tool GoSurfaceBox object.
319  * @return A GoSurfaceBox X measurement.
320  */
321 GoFx(GoSurfaceBoxX) GoSurfaceBox_XMeasurement(GoSurfaceBox tool);
322 
323 /**
324  * Returns a GoSurfaceBox Y measurement object.
325  *
326  * @public @memberof GoSurfaceBox
327  * @version Introduced in firmware 4.0.10.27
328  * @param tool GoSurfaceBox object.
329  * @return A GoSurfaceBox Y measurement.
330  */
331 GoFx(GoSurfaceBoxY) GoSurfaceBox_YMeasurement(GoSurfaceBox tool);
332 
333 /**
334  * Returns a GoSurfaceBox Z measurement object.
335  *
336  * @public @memberof GoSurfaceBox
337  * @version Introduced in firmware 4.0.10.27
338  * @param tool GoSurfaceBox object.
339  * @return A GoSurfaceBox Z measurement.
340  */
341 GoFx(GoSurfaceBoxZ) GoSurfaceBox_ZMeasurement(GoSurfaceBox tool);
342 
343 /**
344  * Returns a GoSurfaceBox Width measurement object.
345  *
346  * @public @memberof GoSurfaceBox
347  * @version Introduced in firmware 4.0.10.27
348  * @param tool GoSurfaceBox object.
349  * @return A GoSurfaceBox Width measurement.
350  */
351 GoFx(GoSurfaceBoxWidth) GoSurfaceBox_WidthMeasurement(GoSurfaceBox tool);
352 
353 /**
354  * Returns a GoSurfaceBox Length measurement object.
355  *
356  * @public @memberof GoSurfaceBox
357  * @version Introduced in firmware 4.0.10.27
358  * @param tool GoSurfaceBox object.
359  * @return A GoSurfaceBox Length measurement.
360  */
361 GoFx(GoSurfaceBoxLength) GoSurfaceBox_LengthMeasurement(GoSurfaceBox tool);
362 
363 /**
364  * Returns a GoSurfaceBox Height measurement object.
365  *
366  * @public @memberof GoSurfaceBox
367  * @version Introduced in firmware 4.0.10.27
368  * @param tool GoSurfaceBox object.
369  * @return A GoSurfaceBox Height measurement.
370  */
371 GoFx(GoSurfaceBoxHeight) GoSurfaceBox_HeightMeasurement(GoSurfaceBox tool);
372 
373 /**
374  * Returns a GoSurfaceBox Z Angle measurement object.
375  *
376  * @public @memberof GoSurfaceBox
377  * @version Introduced in firmware 4.0.10.27
378  * @param tool GoSurfaceBox object.
379  * @return A GoSurfaceBox Z Angle measurement.
380  */
381 GoFx(GoSurfaceBoxZAngle) GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool);
382 
383 /**
384  * Returns a GoSurfaceBox global X measurement object.
385  *
386  * @public @memberof GoSurfaceBox
387  * @version Introduced in firmware 4.0.10.27
388  * @param tool GoSurfaceBox object.
389  * @return A GoSurfaceBox global X measurement.
390  */
391 GoFx(GoSurfaceBoxGlobalX) GoSurfaceBox_GlobalXMeasurement(GoSurfaceBox tool);
392 
393 /**
394  * Returns a GoSurfaceBox global Y measurement object.
395  *
396  * @public @memberof GoSurfaceBox
397  * @version Introduced in firmware 4.0.10.27
398  * @param tool GoSurfaceBox object.
399  * @return A GoSurfaceBox global Y measurement.
400  */
401 GoFx(GoSurfaceBoxGlobalY) GoSurfaceBox_GlobalYMeasurement(GoSurfaceBox tool);
402 
403 /**
404  * Returns a GoSurfaceBox global Z Angle measurement object.
405  *
406  * @public @memberof GoSurfaceBox
407  * @version Introduced in firmware 4.2.4.7
408  * @param tool GoSurfaceBox object.
409  * @return A GoSurfaceBox global Z angle measurement.
410  */
411 GoFx(GoSurfaceBoxGlobalZAngle) GoSurfaceBox_GlobalZAngleMeasurement(GoSurfaceBox tool);
412 
413 
414 /**
415 * @class GoSurfaceCountersunkHole
416 * @extends GoSurfaceTool
417 * @ingroup GoSdk-SurfaceTools
418 * @brief Represents a Surface Counter Sunk Hole tool.
419 */
420 typedef GoSurfaceTool GoSurfaceCountersunkHole;
421 
422 /**
423  * Sets the shape.
424  *
425  * @public @memberof GoSurfaceCountersunkHole
426  * @version Introduced in firmware 4.3.3.124
427  * @param tool GoSurfaceCountersunkHole object.
428  * @param value The value to set.
429  * @return Operation status.
430  */
431 GoFx(kStatus) GoSurfaceCountersunkHole_SetShape(GoSurfaceCountersunkHole tool, GoSurfaceCountersunkHoleShape value);
432 
433 /**
434  * Returns the shape.
435  *
436  * @public @memberof GoSurfaceCountersunkHole
437  * @version Introduced in firmware 4.3.3.124
438  * @param tool GoSurfaceCountersunkHole object.
439  * @return The nominal bevel angle.
440  */
441 GoFx(GoSurfaceCountersunkHoleShape) GoSurfaceCountersunkHole_Shape(GoSurfaceCountersunkHole tool);
442 
443 /**
444  * Sets the nominal bevel angle.
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_SetNominalBevelAngle(GoSurfaceCountersunkHole tool, k64f value);
453 
454 /**
455  * Returns the nominal bevel angle.
456  *
457  * @public @memberof GoSurfaceCountersunkHole
458  * @version Introduced in firmware 4.0.10.27
459  * @param tool GoSurfaceCountersunkHole object.
460  * @return The nominal bevel angle.
461  */
462 GoFx(k64f) GoSurfaceCountersunkHole_NominalBevelAngle(GoSurfaceCountersunkHole tool);
463 
464 /**
465  * Sets the nominal outer radius.
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_SetNominalOuterRadius(GoSurfaceCountersunkHole tool, k64f value);
474 
475 /**
476  * Returns the nominal outer radius.
477  *
478  * @public @memberof GoSurfaceCountersunkHole
479  * @version Introduced in firmware 4.0.10.27
480  * @param tool GoSurfaceCountersunkHole object.
481  * @return The nominal outer radius.
482  */
483 GoFx(k64f) GoSurfaceCountersunkHole_NominalOuterRadius(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 bevel radius offset.
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_SetBevelRadiusOffset(GoSurfaceCountersunkHole tool, k64f value);
516 
517 /**
518  * Returns the bevel radius offset.
519  *
520  * @public @memberof GoSurfaceCountersunkHole
521  * @version Introduced in firmware 4.0.10.27
522  * @param tool GoSurfaceCountersunkHole object.
523  * @return The bevel radius offset.
524  */
525 GoFx(k64f) GoSurfaceCountersunkHole_BevelRadiusOffset(GoSurfaceCountersunkHole tool);
526 
527 /**
528  * Enables or disables partial counter sunk hole detection.
529  *
530  * @public @memberof GoSurfaceCountersunkHole
531  * @version Introduced in firmware 4.0.10.27
532  * @param tool GoSurfaceCountersunkHole object.
533  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
534  * @return Operation status.
535  */
536 GoFx(kStatus) GoSurfaceCountersunkHole_EnablePartialDetection(GoSurfaceCountersunkHole tool, kBool enable);
537 
538 /**
539  * Returns the state of partial detection.
540  *
541  * @public @memberof GoSurfaceCountersunkHole
542  * @version Introduced in firmware 4.0.10.27
543  * @param tool GoSurfaceCountersunkHole object.
544  * @return kTRUE if partial detection is enabled. kFALSE otherwise.
545  */
546 GoFx(kBool) GoSurfaceCountersunkHole_PartialDetectionEnabled(GoSurfaceCountersunkHole tool);
547 
548 /**
549  * Enables or disables the tool region.
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 the tool region and kFALSE to disable it.
555  * @return Operation status.
556  */
557 GoFx(kStatus) GoSurfaceCountersunkHole_EnableRegion(GoSurfaceCountersunkHole tool, kBool enable);
558 
559 /**
560  * Returns the state of the tool region.
561  *
562  * @public @memberof GoSurfaceCountersunkHole
563  * @version Introduced in firmware 4.0.10.27
564  * @param tool GoSurfaceCountersunkHole object.
565  * @return kTRUE if the tool region is enabled. kFALSE otherwise.
566  */
567 GoFx(kBool) GoSurfaceCountersunkHole_RegionEnabled(GoSurfaceCountersunkHole tool);
568 
569 /**
570  * Returns the tool region.
571  *
572  * @public @memberof GoSurfaceCountersunkHole
573  * @version Introduced in firmware 4.0.10.27
574  * @param tool GoSurfaceCountersunkHole object.
575  * @return The tool region.
576  */
577 GoFx(GoRegion3d) GoSurfaceCountersunkHole_Region(GoSurfaceCountersunkHole tool);
578 
579 /**
580  * Enables or disables reference regions.
581  *
582  * @public @memberof GoSurfaceCountersunkHole
583  * @version Introduced in firmware 4.0.10.27
584  * @param tool GoSurfaceCountersunkHole object.
585  * @param enable kTRUE to enable reference regions and kFALSE to disable them.
586  * @return Operation status.
587  */
588 GoFx(kStatus) GoSurfaceCountersunkHole_EnableRefRegions(GoSurfaceCountersunkHole tool, kBool enable);
589 
590 /**
591  * Returns the state of the tool reference regions.
592  *
593  * @public @memberof GoSurfaceCountersunkHole
594  * @version Introduced in firmware 4.0.10.27
595  * @param tool GoSurfaceCountersunkHole object.
596  * @return kTRUE if refrence regions are enabled. kFALSE otherwise.
597  */
598 GoFx(kBool) GoSurfaceCountersunkHole_RefRegionsEnabled(GoSurfaceCountersunkHole tool);
599 
600 /**
601  * Sets the reference region count.
602  *
603  * @public @memberof GoSurfaceCountersunkHole
604  * @version Introduced in firmware 4.0.10.27
605  * @param tool GoSurfaceCountersunkHole object.
606  * @param count The number of references regions to use when enabled.
607  * @return Reference region count.
608  * @see GO_SURFACE_COUNTERSUNK_HOLE_MAX_REF_REGIONS
609 
610  */
611 GoFx(kStatus) GoSurfaceCountersunkHole_SetRefRegionCount(GoSurfaceCountersunkHole tool, kSize count);
612 
613 /**
614  * Returns the reference region count.
615  *
616  * @public @memberof GoSurfaceCountersunkHole
617  * @version Introduced in firmware 4.0.10.27
618  * @param tool GoSurfaceCountersunkHole object.
619  * @return Reference region count.
620  */
621 GoFx(kSize) GoSurfaceCountersunkHole_RefRegionCount(GoSurfaceCountersunkHole tool);
622 
623 /**
624  * Returns the reference region at the given index.
625  *
626  * @public @memberof GoSurfaceCountersunkHole
627  * @version Introduced in firmware 4.0.10.27
628  * @param tool GoSurfaceCountersunkHole object.
629  * @param index The index of the reference region to retrieve.
630  * @return A reference region.
631  */
632 GoFx(GoSurfaceRegion2d) GoSurfaceCountersunkHole_RefRegionAt(GoSurfaceCountersunkHole tool, kSize index);
633 
634 /**
635  * Enables or disables automatic tilt.
636  *
637  * @public @memberof GoSurfaceCountersunkHole
638  * @version Introduced in firmware 4.0.10.27
639  * @param tool GoSurfaceCountersunkHole object.
640  * @param enable kTRUE to enable auto tilt and kFALSE to disable it.
641  * @return Operation status.
642  */
643 GoFx(kStatus) GoSurfaceCountersunkHole_EnableAutoTilt(GoSurfaceCountersunkHole tool, kBool enable);
644 
645 /**
646  * Returns the state of auto tilt.
647  *
648  * @public @memberof GoSurfaceCountersunkHole
649  * @version Introduced in firmware 4.0.10.27
650  * @param tool GoSurfaceCountersunkHole object.
651  * @return kTRUE if auto tilt is enabled. kFALSE otherwise.
652  */
653 GoFx(kBool) GoSurfaceCountersunkHole_AutoTiltEnabled(GoSurfaceCountersunkHole tool);
654 
655 /**
656  * Sets the tilt X angle.
657  *
658  * @public @memberof GoSurfaceCountersunkHole
659  * @version Introduced in firmware 4.0.10.27
660  * @param tool GoSurfaceCountersunkHole object.
661  * @param value The value to set.
662  * @return Operation status.
663  */
664 GoFx(kStatus) GoSurfaceCountersunkHole_SetTiltXAngle(GoSurfaceCountersunkHole tool, k64f value);
665 
666 /**
667  * Returns the tilt X angle value.
668  *
669  * @public @memberof GoSurfaceCountersunkHole
670  * @version Introduced in firmware 4.0.10.27
671  * @param tool GoSurfaceCountersunkHole object.
672  * @return Tilt X angle value.
673  */
674 GoFx(k64f) GoSurfaceCountersunkHole_TiltXAngle(GoSurfaceCountersunkHole tool);
675 
676 /**
677  * Sets the tilt Y 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_SetTiltYAngle(GoSurfaceCountersunkHole tool, k64f value);
686 
687 /**
688  * Returns the tilt Y angle value.
689  *
690  * @public @memberof GoSurfaceCountersunkHole
691  * @version Introduced in firmware 4.0.10.27
692  * @param tool GoSurfaceCountersunkHole object.
693  * @return Tilt Y angle value.
694  */
695 GoFx(k64f) GoSurfaceCountersunkHole_TiltYAngle(GoSurfaceCountersunkHole tool);
696 
697 /**
698  * Enables or disables curve fitting.
699  *
700  * @public @memberof GoSurfaceCountersunkHole
701  * @version Introduced in firmware 4.1.3.106
702  * @param tool GoSurfaceCountersunkHole object.
703  * @param enable kTRUE to enable curve fitting and kFALSE to disable it.
704  * @return Operation status.
705  */
706 GoFx(kStatus) GoSurfaceCountersunkHole_EnableCurveFit(GoSurfaceCountersunkHole tool, kBool enable);
707 
708 
709 /**
710  * Returns the state of auto tilt.
711  *
712  * @public @memberof GoSurfaceCountersunkHole
713  * @version Introduced in firmware 4.1.3.106
714  * @param tool GoSurfaceCountersunkHole object.
715  * @return kTRUE if curve fitting is enabled. kFALSE otherwise.
716  */
717 GoFx(kBool) GoSurfaceCountersunkHole_CurveFitEnabled(GoSurfaceCountersunkHole tool);
718 
719 /**
720  * Sets the curve orientation angle.
721  *
722  * @public @memberof GoSurfaceCountersunkHole
723  * @version Introduced in firmware 4.1.3.106
724  * @param tool GoSurfaceCountersunkHole object.
725  * @param value The value to set.
726  * @return Operation status.
727  */
728 GoFx(kStatus) GoSurfaceCountersunkHole_SetCurveOrientation(GoSurfaceCountersunkHole tool, k64f value);
729 
730 /**
731  * Returns the curve orientation angle value.
732  *
733  * @public @memberof GoSurfaceCountersunkHole
734  * @version Introduced in firmware 4.1.3.106
735  * @param tool GoSurfaceCountersunkHole object.
736  * @return Curve orientation angle value.
737  */
738 GoFx(k64f) GoSurfaceCountersunkHole_CurveOrientation(GoSurfaceCountersunkHole tool);
739 
740 /**
741  * Sets the plane fit range.
742  *
743  * @public @memberof GoSurfaceCountersunkHole
744  * @version Introduced in firmware 4.5.3.57
745  * @param tool GoSurfaceCountersunkHole object.
746  * @param value The value to set.
747  * @return Operation status.
748  */
749 GoFx(kStatus) GoSurfaceCountersunkHole_SetPlaneFitRange(GoSurfaceCountersunkHole tool, k64f value);
750 
751 /**
752  * Gets the enabled state of the plane fit range.
753  *
754  * @public @memberof GoSurfaceCountersunkHole
755  * @version Introduced in firmware 4.5.3.57
756  * @param tool GoSurfaceCountersunkHole object.
757  * @return kTRUE if enabled and kFALSE if disabled.
758  */
759 GoFx(kBool) GoSurfaceCountersunkHole_PlaneFitRangeEnabled(GoSurfaceCountersunkHole tool);
760 
761 /**
762  * Sets the enabled state of the plane fit range.
763  *
764  * @public @memberof GoSurfaceCountersunkHole
765  * @version Introduced in firmware 4.5.3.57
766  * @param tool GoSurfaceCountersunkHole object.
767  * @param enable kTRUE to enable it and kFALSE to disable it.
768  * @return Operation status.
769  */
770 GoFx(kStatus) GoSurfaceCountersunkHole_EnablePlaneFitRange(GoSurfaceCountersunkHole tool, kBool enable);
771 
772 /**
773  * Returns the plane fit range.
774  *
775  * @public @memberof GoSurfaceCountersunkHole
776  * @version Introduced in firmware 4.5.3.57
777  * @param tool GoSurfaceCountersunkHole object.
778  * @return Plane fit range value.
779  */
780 GoFx(k64f) GoSurfaceCountersunkHole_PlaneFitRange(GoSurfaceCountersunkHole tool);
781 
782 /**
783  * Returns a GoSurfaceCountersunkHole tool X position measurement object.
784  *
785  * @public @memberof GoSurfaceCountersunkHole
786  * @version Introduced in firmware 4.0.10.27
787  * @param tool GoSurfaceCountersunkHole object.
788  * @return A GoSurfaceCountersunkHole X position measurement.
789  */
790 GoFx(GoSurfaceCountersunkHoleX) GoSurfaceCountersunkHole_XMeasurement(GoSurfaceCountersunkHole tool);
791 
792 /**
793  * Returns a GoSurfaceCountersunkHole tool Y position measurement object.
794  *
795  * @public @memberof GoSurfaceCountersunkHole
796  * @version Introduced in firmware 4.0.10.27
797  * @param tool GoSurfaceCountersunkHole object.
798  * @return A GoSurfaceCountersunkHole Y position measurement.
799  */
800 GoFx(GoSurfaceCountersunkHoleY) GoSurfaceCountersunkHole_YMeasurement(GoSurfaceCountersunkHole tool);
801 
802 /**
803  * Returns a GoSurfaceCountersunkHole tool Z position measurement object.
804  *
805  * @public @memberof GoSurfaceCountersunkHole
806  * @version Introduced in firmware 4.0.10.27
807  * @param tool GoSurfaceCountersunkHole object.
808  * @return A GoSurfaceCountersunkHole Z position measurement.
809  */
810 GoFx(GoSurfaceCountersunkHoleZ) GoSurfaceCountersunkHole_ZMeasurement(GoSurfaceCountersunkHole tool);
811 
812 /**
813  * Returns a GoSurfaceCountersunkHole tool Outer Radius measurement object.
814  *
815  * @public @memberof GoSurfaceCountersunkHole
816  * @version Introduced in firmware 4.0.10.27
817  * @param tool GoSurfaceCountersunkHole object.
818  * @return A GoSurfaceCountersunkHole Outer Radius measurement.
819  */
820 GoFx(GoSurfaceCountersunkHoleOuterRadius) GoSurfaceCountersunkHole_OuterRadiusMeasurement(GoSurfaceCountersunkHole tool);
821 
822 /**
823  * Returns a GoSurfaceCountersunkHole tool Depth measurement object.
824  *
825  * @public @memberof GoSurfaceCountersunkHole
826  * @version Introduced in firmware 4.0.10.27
827  * @param tool GoSurfaceCountersunkHole object.
828  * @return A GoSurfaceCountersunkHole Depth measurement.
829  */
830 GoFx(GoSurfaceCountersunkHoleDepth) GoSurfaceCountersunkHole_DepthMeasurement(GoSurfaceCountersunkHole tool);
831 
832 /**
833  * Returns a GoSurfaceCountersunkHole tool counterbore depth measurement object.
834  *
835  * @public @memberof GoSurfaceCountersunkHole
836  * @version Introduced in firmware 4.3.3.124
837  * @param tool GoSurfaceCountersunkHole object.
838  * @return A GoSurfaceCountersunkHole counterbore depth measurement.
839  */
840 GoFx(GoSurfaceCountersunkHoleCounterboreDepth) GoSurfaceCountersunkHole_CounterboreDepth(GoSurfaceCountersunkHole tool);
841 
842 /**
843  * Returns a GoSurfaceCountersunkHole tool Bevel Radius measurement object.
844  *
845  * @public @memberof GoSurfaceCountersunkHole
846  * @version Introduced in firmware 4.0.10.27
847  * @param tool GoSurfaceCountersunkHole object.
848  * @return A GoSurfaceCountersunkHole Bevel Radius measurement.
849  */
850 GoFx(GoSurfaceCountersunkHoleBevelRadius) GoSurfaceCountersunkHole_BevelRadiusMeasurement(GoSurfaceCountersunkHole tool);
851 
852 /**
853  * Returns a GoSurfaceCountersunkHole tool Bevel Angle measurement object.
854  *
855  * @public @memberof GoSurfaceCountersunkHole
856  * @version Introduced in firmware 4.0.10.27
857  * @param tool GoSurfaceCountersunkHole object.
858  * @return A GoSurfaceCountersunkHole Bevel Angle measurement.
859  */
860 GoFx(GoSurfaceCountersunkHoleBevelAngle) GoSurfaceCountersunkHole_BevelAngleMeasurement(GoSurfaceCountersunkHole tool);
861 
862 /**
863  * Returns a GoSurfaceCountersunkHole tool X Angle measurement object.
864  *
865  * @public @memberof GoSurfaceCountersunkHole
866  * @version Introduced in firmware 4.0.10.27
867  * @param tool GoSurfaceCountersunkHole object.
868  * @return A GoSurfaceCountersunkHole X angle measurement.
869  */
870 GoFx(GoSurfaceCountersunkHoleXAngle) GoSurfaceCountersunkHole_XAngleMeasurement(GoSurfaceCountersunkHole tool);
871 
872 /**
873  * Returns a GoSurfaceCountersunkHole tool Y Angle measurement object.
874  *
875  * @public @memberof GoSurfaceCountersunkHole
876  * @version Introduced in firmware 4.0.10.27
877  * @param tool GoSurfaceCountersunkHole object.
878  * @return A GoSurfaceCountersunkHole Y angle measurement.
879  */
880 GoFx(GoSurfaceCountersunkHoleYAngle) GoSurfaceCountersunkHole_YAngleMeasurement(GoSurfaceCountersunkHole tool);
881 
882 /**
883  * Returns a GoSurfaceCountersunkHole tool axis tilt measurement object.
884  *
885  * @public @memberof GoSurfaceCountersunkHole
886  * @version Introduced in firmware 4.5.3.57
887  * @param tool GoSurfaceCountersunkHole object.
888  * @return A GoSurfaceCountersunkHole axis tilt measurement.
889  */
890 GoFx(GoSurfaceCountersunkHoleAxisTilt) GoSurfaceCountersunkHole_AxisTilt(GoSurfaceCountersunkHole tool);
891 
892 /**
893  * Returns a GoSurfaceCountersunkHole tool axis orientation measurement object.
894  *
895  * @public @memberof GoSurfaceCountersunkHole
896  * @version Introduced in firmware 4.5.3.57
897  * @param tool GoSurfaceCountersunkHole object.
898  * @return A GoSurfaceCountersunkHole axis orientation measurement.
899  */
900 GoFx(GoSurfaceCountersunkHoleAxisOrientation) GoSurfaceCountersunkHole_AxisOrientation(GoSurfaceCountersunkHole tool);
901 
902 /**
903  * @class GoSurfaceDim
904  * @extends GoSurfaceTool
905  * @ingroup GoSdk-SurfaceTools
906  * @brief Represents a Surface dimension tool.
907  */
908 typedef GoSurfaceTool GoSurfaceDim;
909 
910 /**
911  * Gets the reference Surface feature.
912  *
913  * @public @memberof GoSurfaceDim
914  * @version Introduced in firmware 4.4.4.14
915  * @param tool GoSurfaceDim object.
916  * @return The reference Surface feature object.
917  */
918 GoFx(GoSurfaceFeature) GoSurfaceDim_RefFeature(GoSurfaceDim tool);
919 
920 
921 /**
922  * Gets the non-reference Surface feature.
923  *
924  * @public @memberof GoSurfaceDim
925  * @version Introduced in firmware 4.4.4.14
926  * @param tool GoSurfaceDim object.
927  * @return The non-reference Surface feature object.
928  */
929 GoFx(GoSurfaceFeature) GoSurfaceDim_Feature(GoSurfaceDim tool);
930 
931 /**
932  * Returns a GoSurfaceDim Width measurement object.
933  *
934  * @public @memberof GoSurfaceDim
935  * @version Introduced in firmware 4.4.4.14
936  * @param tool GoSurfaceDim object.
937  * @return A GoSurfaceDimWidth measurement.
938  */
939 GoFx(GoSurfaceDimWidth) GoSurfaceDim_WidthMeasurement(GoSurfaceDim tool);
940 
941 /**
942  * Returns a GoSurfaceDim Height measurement object.
943  *
944  * @public @memberof GoSurfaceDim
945  * @version Introduced in firmware 4.4.4.14
946  * @param tool GoSurfaceDim object.
947  * @return A GoSurfaceDimHeight measurement.
948  */
949 GoFx(GoSurfaceDimHeight) GoSurfaceDim_HeightMeasurement(GoSurfaceDim tool);
950 
951 /**
952  * Returns a GoSurfaceDim Length measurement object.
953  *
954  * @public @memberof GoSurfaceDim
955  * @version Introduced in firmware 4.4.4.14
956  * @param tool GoSurfaceDim object.
957  * @return A GoSurfaceDimLength measurement.
958  */
959 GoFx(GoSurfaceDimLength) GoSurfaceDim_LengthMeasurement(GoSurfaceDim tool);
960 
961 /**
962  * Returns a GoSurfaceDim Distance measurement object.
963  *
964  * @public @memberof GoSurfaceDim
965  * @version Introduced in firmware 4.4.4.14
966  * @param tool GoSurfaceDim object.
967  * @return A GoSurfaceDimDistance measurement.
968  */
969 GoFx(GoSurfaceDimDistance) GoSurfaceDim_DistanceMeasurement(GoSurfaceDim tool);
970 
971 /**
972  * Returns a GoSurfaceDim Plane Distance measurement object.
973  *
974  * @public @memberof GoSurfaceDim
975  * @version Introduced in firmware 4.4.4.14
976  * @param tool GoSurfaceDim object.
977  * @return A GoSurfaceDimPlaneDistance measurement.
978  */
979 GoFx(GoSurfaceDimPlaneDistance) GoSurfaceDim_PlaneDistanceMeasurement(GoSurfaceDim tool);
980 
981 /**
982  * Returns a GoSurfaceDim Center X measurement object.
983  *
984  * @public @memberof GoSurfaceDim
985  * @version Introduced in firmware 4.4.4.14
986  * @param tool GoSurfaceDim object.
987  * @return A GoSurfaceDimCenterX measurement.
988  */
989 GoFx(GoSurfaceDimCenterX) GoSurfaceDim_CenterXMeasurement(GoSurfaceDim tool);
990 
991 /**
992  * Returns a GoSurfaceDim Center Y measurement object.
993  *
994  * @public @memberof GoSurfaceDim
995  * @version Introduced in firmware 4.4.4.14
996  * @param tool GoSurfaceDim object.
997  * @return A GoSurfaceDimCenterY measurement.
998  */
999 GoFx(GoSurfaceDimCenterY) GoSurfaceDim_CenterYMeasurement(GoSurfaceDim tool);
1000 
1001 
1002 /**
1003  * Returns a GoSurfaceDim Center Z measurement object.
1004  *
1005  * @public @memberof GoSurfaceDim
1006  * @version Introduced in firmware 4.4.4.14
1007  * @param tool GoSurfaceDim object.
1008  * @return A GoSurfaceDimCenterZ measurement.
1009  */
1010 GoFx(GoSurfaceDimCenterZ) GoSurfaceDim_CenterZMeasurement(GoSurfaceDim tool);
1011 
1012 
1013 
1014 /**
1015  * @class GoSurfaceEllipse
1016  * @extends GoSurfaceTool
1017  * @ingroup GoSdk-SurfaceTools
1018  * @brief Represents a surface ellipse tool.
1019  */
1020 typedef GoSurfaceTool GoSurfaceEllipse;
1021 
1022 /**
1023  * Enables or disables the tool region.
1024  *
1025  * @public @memberof GoSurfaceEllipse
1026  * @version Introduced in firmware 4.0.10.27
1027  * @param tool GoSurfaceEllipse object.
1028  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1029  * @return Operation status.
1030  */
1031 GoFx(kStatus) GoSurfaceEllipse_EnableRegion(GoSurfaceEllipse tool, kBool enable);
1032 
1033 /**
1034  * Returns the enabled state of the tool region.
1035  *
1036  * @public @memberof GoSurfaceEllipse
1037  * @version Introduced in firmware 4.0.10.27
1038  * @param tool GoSurfaceEllipse object.
1039  * @return kTRUE if enabled and kFALSE if disabled.
1040  */
1041 GoFx(kBool) GoSurfaceEllipse_RegionEnabled(GoSurfaceEllipse tool);
1042 
1043 /**
1044  * Gets the tool region.
1045  *
1046  * @public @memberof GoSurfaceEllipse
1047  * @version Introduced in firmware 4.0.10.27
1048  * @param tool GoSurfaceEllipse object.
1049  * @return A GoRegion3d object.
1050  */
1051 GoFx(GoRegion3d) GoSurfaceEllipse_Region(GoSurfaceEllipse tool);
1052 
1053 /**
1054  * Sets the asymmetry detection type.
1055  *
1056  * @public @memberof GoSurfaceEllipse
1057  * @version Introduced in firmware 4.4.4.14
1058  * @param tool GoSurfaceEllipse object.
1059  * @param value The asymmetry detection type to set.
1060  * @return Operation status.
1061  */
1062 GoFx(kStatus) GoSurfaceEllipse_SetAsymmetryDetectionType(GoSurfaceEllipse tool, GoEllipseAsymmetryType value);
1063 
1064 /**
1065  * Gets the asymmetry detection type.
1066  *
1067  * @public @memberof GoSurfaceEllipse
1068  * @version Introduced in firmware 4.4.4.14
1069  * @param tool GoSurfaceEllipse object.
1070  * @return The asymmetry detection type.
1071  */
1072 GoFx(GoEllipseAsymmetryType) GoSurfaceEllipse_AsymmetryDetectionType(GoSurfaceEllipse tool);
1073 
1074 /**
1075  * Returns a GoSurfaceEllipse Major measurement object.
1076  *
1077  * @public @memberof GoSurfaceEllipse
1078  * @version Introduced in firmware 4.0.10.27
1079  * @param tool GoSurfaceEllipse object.
1080  * @return A GoSurfaceEllipse Major measurement.
1081  */
1082 GoFx(GoSurfaceEllipseMajor) GoSurfaceEllipse_MajorMeasurement(GoSurfaceEllipse tool);
1083 
1084 /**
1085  * Returns a GoSurfaceEllipse Minor measurement object.
1086  *
1087  * @public @memberof GoSurfaceEllipse
1088  * @version Introduced in firmware 4.0.10.27
1089  * @param tool GoSurfaceEllipse object.
1090  * @return A GoSurfaceEllipse Minor measurement.
1091  */
1092 GoFx(GoSurfaceEllipseMinor) GoSurfaceEllipse_MinorMeasurement(GoSurfaceEllipse tool);
1093 
1094 /**
1095  * Returns a GoSurfaceEllipse Ratio measurement object.
1096  *
1097  * @public @memberof GoSurfaceEllipse
1098  * @version Introduced in firmware 4.0.10.27
1099  * @param tool GoSurfaceEllipse object.
1100  * @return A GoSurfaceEllipse Ratio measurement.
1101  */
1102 GoFx(GoSurfaceEllipseRatio) GoSurfaceEllipse_RatioMeasurement(GoSurfaceEllipse tool);
1103 
1104 /**
1105  * Returns a GoSurfaceEllipse Z Angle measurement object.
1106  *
1107  * @public @memberof GoSurfaceEllipse
1108  * @version Introduced in firmware 4.0.10.27
1109  * @param tool GoSurfaceEllipse object.
1110  * @return A GoSurfaceEllipse Z Angle measurement.
1111  */
1112 GoFx(GoSurfaceEllipseZAngle) GoSurfaceEllipse_ZAngleMeasurement(GoSurfaceEllipse tool);
1113 
1114 
1115 /**
1116  * @class GoSurfaceHole
1117  * @extends GoSurfaceTool
1118  * @ingroup GoSdk-SurfaceTools
1119  * @brief Represents a surface hole tool.
1120  */
1121 typedef GoSurfaceTool GoSurfaceHole;
1122 
1123 /**
1124  * Gets the current nominal radius value.
1125  *
1126  * @public @memberof GoSurfaceHole
1127  * @version Introduced in firmware 4.0.10.27
1128  * @param tool GoSurfaceHole object.
1129  * @return The nominal radius value.
1130  */
1131 GoFx(k64f) GoSurfaceHole_NominalRadius(GoSurfaceHole tool);
1132 
1133 /**
1134  * Sets the nominal radius value.
1135  *
1136  * @public @memberof GoSurfaceHole
1137  * @version Introduced in firmware 4.0.10.27
1138  * @param tool GoSurfaceHole object.
1139  * @param nominalRadius Nominal radius value to set.
1140  * @return Operation status.
1141  */
1142 GoFx(kStatus) GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius);
1143 
1144 /**
1145  * Gets the current radius tolerance value.
1146  *
1147  * @public @memberof GoSurfaceHole
1148  * @version Introduced in firmware 4.0.10.27
1149  * @param tool GoSurfaceHole object.
1150  * @return The radius tolerance value.
1151  */
1152 GoFx(k64f) GoSurfaceHole_RadiusTolerance(GoSurfaceHole tool);
1153 
1154 /**
1155  * Sets the radius tolerance value.
1156  *
1157  * @public @memberof GoSurfaceHole
1158  * @version Introduced in firmware 4.0.10.27
1159  * @param tool GoSurfaceHole object.
1160  * @param radiusTolerance The radius tolerance value to set.
1161  * @return Operation status.
1162  */
1163 GoFx(kStatus) GoSurfaceHole_SetRadiusTolerance(GoSurfaceHole tool, k64f radiusTolerance);
1164 
1165 /**
1166  * Gets the enabled state of partial detection.
1167  *
1168  * @public @memberof GoSurfaceHole
1169  * @version Introduced in firmware 4.0.10.27
1170  * @param tool GoSurfaceHole object.
1171  * @return kTRUE if enabled and kFALSE if disabled.
1172  */
1173 GoFx(kBool) GoSurfaceHole_PartialDetectionEnabled(GoSurfaceHole tool);
1174 
1175 /**
1176  * Sets the enabled state of partial detection.
1177  *
1178  * @public @memberof GoSurfaceHole
1179  * @version Introduced in firmware 4.0.10.27
1180  * @param tool GoSurfaceHole object.
1181  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1182  * @return Operation status.
1183  */
1184 GoFx(kStatus) GoSurfaceHole_EnablePartialDetection(GoSurfaceHole tool, kBool enable);
1185 
1186 /**
1187  * Gets the enabled state of the tool region.
1188  *
1189  * @public @memberof GoSurfaceHole
1190  * @version Introduced in firmware 4.0.10.27
1191  * @param tool GoSurfaceHole object.
1192  * @return kTRUE if enabled and kFALSE if disabled.
1193  */
1194 GoFx(kBool) GoSurfaceHole_RegionEnabled(GoSurfaceHole tool);
1195 
1196 /**
1197  * Sets the enabled state of the tool region.
1198  *
1199  * @public @memberof GoSurfaceHole
1200  * @version Introduced in firmware 4.0.10.27
1201  * @param tool GoSurfaceHole object.
1202  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1203  * @return Operation status.
1204  */
1205 GoFx(kStatus) GoSurfaceHole_EnableRegion(GoSurfaceHole tool, kBool enable);
1206 
1207 /**
1208  * Returns the tool's region object.
1209  *
1210  * @public @memberof GoSurfaceHole
1211  * @version Introduced in firmware 4.0.10.27
1212  * @param tool GoSurfaceHole object.
1213  * @return A GoRegion3d object.
1214  */
1215 GoFx(GoRegion3d) GoSurfaceHole_Region(GoSurfaceHole tool);
1216 
1217 /**
1218  * Gets the enabled state of reference regions.
1219  *
1220  * @public @memberof GoSurfaceHole
1221  * @version Introduced in firmware 4.0.10.27
1222  * @param tool GoSurfaceHole object.
1223  * @return kTRUE if enabled and kFALSE if disabled.
1224  */
1225 GoFx(kBool) GoSurfaceHole_RefRegionsEnabled(GoSurfaceHole tool);
1226 
1227 /**
1228  * Sets the enabled state of reference regions.
1229  *
1230  * @public @memberof GoSurfaceHole
1231  * @version Introduced in firmware 4.0.10.27
1232  * @param tool GoSurfaceHole object.
1233  * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1234  * @return Operation status.
1235  */
1236 GoFx(kStatus) GoSurfaceHole_EnableRefRegions(GoSurfaceHole tool, kBool enable);
1237 
1238 /**
1239  * Gets the reference region count.
1240  *
1241  * @public @memberof GoSurfaceHole
1242  * @version Introduced in firmware 4.0.10.27
1243  * @param tool GoSurfaceHole object.
1244  * @return The reference region count.
1245  */
1246 GoFx(kSize) GoSurfaceHole_RefRegionCount(GoSurfaceHole tool);
1247 
1248 /**
1249  * Sets the reference region count.
1250  *
1251  * @public @memberof GoSurfaceHole
1252  * @version Introduced in firmware 4.0.10.27
1253  * @param tool GoSurfaceHole object.
1254  * @param count The reference region count.
1255  * @return Operation status.
1256  * @see GO_SURFACE_HOLE_MAX_REF_REGIONS
1257  */
1258 GoFx(kStatus) GoSurfaceHole_SetRefRegionCount(GoSurfaceHole tool, kSize count);
1259 
1260 /**
1261  * Gets a reference region object at the given index.
1262  *
1263  * @public @memberof GoSurfaceHole
1264  * @version Introduced in firmware 4.0.10.27
1265  * @param tool GoSurfaceHole object.
1266  * @param index The index with which to retrieve a reference region.
1267  * @return A GoSurfaceRegion2d object.
1268  * @see GoSurfaceHole_RefRegionCount
1269  */
1270 GoFx(GoSurfaceRegion2d) GoSurfaceHole_RefRegionAt(GoSurfaceHole tool, kSize index);
1271 
1272 /**
1273  * Gets the enabled state of auto-tilt.
1274  *
1275  * @public @memberof GoSurfaceHole
1276  * @version Introduced in firmware 4.0.10.27
1277  * @param tool GoSurfaceHole object.
1278  * @return kTRUE if enabled and kFALSE if disabled.
1279  */
1280 GoFx(kBool) GoSurfaceHole_AutoTiltEnabled(GoSurfaceHole tool);
1281 
1282 /**
1283  * Sets the enabled state of auto-tilt.
1284  *
1285  * @public @memberof GoSurfaceHole
1286  * @version Introduced in firmware 4.0.10.27
1287  * @param tool GoSurfaceHole object.
1288  * @param enable kTRUE to enable it and kFALSE to disable it.
1289  * @return Operation status.
1290  */
1291 GoFx(kStatus) GoSurfaceHole_EnableAutoTilt(GoSurfaceHole tool, kBool enable);
1292 
1293 /**
1294  * Gets the tilt X-angle value.
1295  *
1296  * @public @memberof GoSurfaceHole
1297  * @version Introduced in firmware 4.0.10.27
1298  * @param tool GoSurfaceHole object.
1299  * @return Tilt X-angle value.
1300  */
1301 GoFx(k64f) GoSurfaceHole_TiltXAngle(GoSurfaceHole tool);
1302 
1303 /**
1304  * Sets the tilt X-angle value.
1305  *
1306  * @public @memberof GoSurfaceHole
1307  * @version Introduced in firmware 4.0.10.27
1308  * @param tool GoSurfaceHole object.
1309  * @param value The tilt X-angle value to set.
1310  * @return Operation status.
1311  */
1312 GoFx(kStatus) GoSurfaceHole_SetTiltXAngle(GoSurfaceHole tool, k64f value);
1313 
1314 /**
1315  * Gets the tilt Y-angle value.
1316  *
1317  * @public @memberof GoSurfaceHole
1318  * @version Introduced in firmware 4.0.10.27
1319  * @param tool GoSurfaceHole object.
1320  * @return Tilt Y-angle value.
1321  */
1322 GoFx(k64f) GoSurfaceHole_TiltYAngle(GoSurfaceHole tool);
1323 
1324 /**
1325  * Sets the tilt Y-angle value.
1326  *
1327  * @public @memberof GoSurfaceHole
1328  * @version Introduced in firmware 4.0.10.27
1329  * @param tool GoSurfaceHole object.
1330  * @param value The tilt Y-angle value to set.
1331  * @return Operation status.
1332  */
1333 GoFx(kStatus) GoSurfaceHole_SetTiltYAngle(GoSurfaceHole tool, k64f value);
1334 
1335 /**
1336  * Gets the enabled state of the depth limit.
1337  *
1338  * @public @memberof GoSurfaceHole
1339  * @version Introduced in firmware 4.3.3.124
1340  * @param tool GoSurfaceHole object.
1341  * @return kTRUE if enabled and kFALSE if disabled.
1342  */
1343 GoFx(kBool) GoSurfaceHole_DepthLimitEnabled(GoSurfaceHole tool);
1344 
1345 /**
1346  * Sets the enabled state of the depth limit.
1347  *
1348  * @public @memberof GoSurfaceHole
1349  * @version Introduced in firmware 4.3.3.124
1350  * @param tool GoSurfaceHole object.
1351  * @param enable kTRUE to enable it and kFALSE to disable it.
1352  * @return Operation status.
1353  */
1354 GoFx(kStatus) GoSurfaceHole_EnableDepthLimit(GoSurfaceHole tool, kBool enable);
1355 
1356 /**
1357  * Gets the depth limit value.
1358  *
1359  * @public @memberof GoSurfaceHole
1360  * @version Introduced in firmware 4.3.3.124
1361  * @param tool GoSurfaceHole object.
1362  * @return Depth limit value.
1363 
1364  */
1365 GoFx(k64f) GoSurfaceHole_DepthLimit(GoSurfaceHole tool);
1366 
1367 /**
1368  * Sets the depth limit value.
1369  *
1370  * @public @memberof GoSurfaceHole
1371  * @version Introduced in firmware 4.3.3.124
1372  * @param tool GoSurfaceHole object.
1373  * @param value The depth limit value to set.
1374  * @return Operation status.
1375  * @see GoSurfaceHole_DepthLimitEnabled, GoSurfaceHole_EnableDepthLimit
1376  */
1377 GoFx(kStatus) GoSurfaceHole_SetDepthLimit(GoSurfaceHole tool, k64f value);
1378 
1379 /**
1380  * Returns a GoSurfaceHole X measurement object.
1381  *
1382  * @public @memberof GoSurfaceHole
1383  * @version Introduced in firmware 4.0.10.27
1384  * @param tool GoSurfaceHole object.
1385  * @return A GoSurfaceHole X measurement.
1386  */
1387 GoFx(GoSurfaceHoleX) GoSurfaceHole_XMeasurement(GoSurfaceHole tool);
1388 
1389 /**
1390  * Returns a GoSurfaceHole Y measurement object.
1391  *
1392  * @public @memberof GoSurfaceHole
1393  * @version Introduced in firmware 4.0.10.27
1394  * @param tool GoSurfaceHole object.
1395  * @return A GoSurfaceHole Y measurement.
1396  */
1397 GoFx(GoSurfaceHoleY) GoSurfaceHole_YMeasurement(GoSurfaceHole tool);
1398 
1399 /**
1400  * Returns a GoSurfaceHole Z measurement object.
1401  *
1402  * @public @memberof GoSurfaceHole
1403  * @version Introduced in firmware 4.0.10.27
1404  * @param tool GoSurfaceHole object.
1405  * @return A GoSurfaceHole Z measurement.
1406  */
1407 GoFx(GoSurfaceHoleZ) GoSurfaceHole_ZMeasurement(GoSurfaceHole tool);
1408 
1409 /**
1410  * Returns a GoSurfaceHole Radius measurement object.
1411  *
1412  * @public @memberof GoSurfaceHole
1413  * @version Introduced in firmware 4.0.10.27
1414  * @param tool GoSurfaceHole object.
1415  * @return A GoSurfaceHole Radius measurement.
1416  */
1417 GoFx(GoSurfaceHoleRadius) GoSurfaceHole_RadiusMeasurement(GoSurfaceHole tool);
1418 
1419 
1420 /**
1421  * @class GoSurfaceOpening
1422  * @extends GoSurfaceTool
1423  * @ingroup GoSdk-SurfaceTools
1424  * @brief Represents a surface opening tool.
1425  */
1426 typedef GoSurfaceTool GoSurfaceOpening;
1427 
1428 GoFx(kStatus) GoSurfaceOpening_SetType(GoSurfaceOpening tool, GoSurfaceOpeningType type);
1429 
1430 /**
1431  * Gets the surface opening type.
1432  *
1433  * @public @memberof GoSurfaceOpening
1434  * @version Introduced in firmware 4.0.10.27
1435  * @param tool GoSurfaceOpening object.
1436  * @return The surface opening type.
1437  */
1438 GoFx(GoSurfaceOpeningType) GoSurfaceOpening_Type(GoSurfaceOpening tool);
1439 
1440 /**
1441  * Gets the nominal width.
1442  *
1443  * @public @memberof GoSurfaceOpening
1444  * @version Introduced in firmware 4.0.10.27
1445  * @param tool GoSurfaceOpening object.
1446  * @return The nominal width (in mm).
1447  */
1448 GoFx(k64f) GoSurfaceOpening_NominalWidth(GoSurfaceOpening tool);
1449 
1450 /**
1451  * Sets the nominal width.
1452  *
1453  * @public @memberof GoSurfaceOpening
1454  * @version Introduced in firmware 4.0.10.27
1455  * @param tool GoSurfaceOpening object.
1456  * @param value The nominal width to set (in mm).
1457  * @return Operation status.
1458  */
1459 GoFx(kStatus) GoSurfaceOpening_SetNominalWidth(GoSurfaceOpening tool, k64f value);
1460 
1461 /**
1462  * Gets the nominal length.
1463  *
1464  * @public @memberof GoSurfaceOpening
1465  * @version Introduced in firmware 4.0.10.27
1466  * @param tool GoSurfaceOpening object.
1467  * @return The nominal length (in mm).
1468  */
1469 GoFx(k64f) GoSurfaceOpening_NominalLength(GoSurfaceOpening tool);
1470 
1471 /**
1472  * Sets the nominal length.
1473  *
1474  * @public @memberof GoSurfaceOpening
1475  * @version Introduced in firmware 4.0.10.27
1476  * @param tool GoSurfaceOpening object.
1477  * @param value The nominal length to set (in mm).
1478  * @return Operation status.
1479  */
1480 GoFx(kStatus) GoSurfaceOpening_SetNominalLength(GoSurfaceOpening tool, k64f value);
1481 
1482 /**
1483  * Gets the nominal angle.
1484  *
1485  * @public @memberof GoSurfaceOpening
1486  * @version Introduced in firmware 4.0.10.27
1487  * @param tool GoSurfaceOpening object.
1488  * @return The nominal angle (in degrees).
1489  */
1490 GoFx(k64f) GoSurfaceOpening_NominalAngle(GoSurfaceOpening tool);
1491 
1492 /**
1493  * Sets the nominal angle.
1494  *
1495  * @public @memberof GoSurfaceOpening
1496  * @version Introduced in firmware 4.0.10.27
1497  * @param tool GoSurfaceOpening object.
1498  * @param value The nominal angle to set (in degrees).
1499  * @return Operation status.
1500  */
1501 GoFx(kStatus) GoSurfaceOpening_SetNominalAngle(GoSurfaceOpening tool, k64f value);
1502 
1503 /**
1504  * Gets the nominal radius.
1505  *
1506  * @public @memberof GoSurfaceOpening
1507  * @version Introduced in firmware 4.0.10.27
1508  * @param tool GoSurfaceOpening object.
1509  * @return The nominal radius (in mm).
1510  */
1511 GoFx(k64f) GoSurfaceOpening_NominalRadius(GoSurfaceOpening tool);
1512 
1513 /**
1514  * Sets the nominal radius.
1515  *
1516  * @public @memberof GoSurfaceOpening
1517  * @version Introduced in firmware 4.0.10.27
1518  * @param tool GoSurfaceOpening object.
1519  * @param value The nominal radius to set (in mm).
1520  * @return Operation status.
1521  */
1522 GoFx(kStatus) GoSurfaceOpening_SetNominalRadius(GoSurfaceOpening tool, k64f value);
1523 
1524 /**
1525  * Gets the width tolerance.
1526  *
1527  * @public @memberof GoSurfaceOpening
1528  * @version Introduced in firmware 4.0.10.27
1529  * @param tool GoSurfaceOpening object.
1530  * @return The width tolerance (in mm).
1531  */
1532 GoFx(k64f) GoSurfaceOpening_WidthTolerance(GoSurfaceOpening tool);
1533 
1534 /**
1535  * Sets the width tolerance.
1536  *
1537  * @public @memberof GoSurfaceOpening
1538  * @version Introduced in firmware 4.0.10.27
1539  * @param tool GoSurfaceOpening object.
1540  * @param value The width tolerance to set (in mm).
1541  * @return Operation status.
1542  */
1543 GoFx(kStatus) GoSurfaceOpening_SetWidthTolerance(GoSurfaceOpening tool, k64f value);
1544 
1545 /**
1546  * Gets the length tolerance.
1547  *
1548  * @public @memberof GoSurfaceOpening
1549  * @version Introduced in firmware 4.0.10.27
1550  * @param tool GoSurfaceOpening object.
1551  * @return The length tolerance (in mm).
1552  */
1553 GoFx(k64f) GoSurfaceOpening_LengthTolerance(GoSurfaceOpening tool);
1554 
1555 /**
1556  * Sets the length tolerance.
1557  *
1558  * @public @memberof GoSurfaceOpening
1559  * @version Introduced in firmware 4.0.10.27
1560  * @param tool GoSurfaceOpening object.
1561  * @param value The length tolerance to set (in mm).
1562  * @return Operation status.
1563  */
1564 GoFx(kStatus) GoSurfaceOpening_SetLengthTolerance(GoSurfaceOpening tool, k64f value);
1565 
1566 /**
1567  * Gets the angle tolerance.
1568  *
1569  * @public @memberof GoSurfaceOpening
1570  * @version Introduced in firmware 4.0.10.27
1571  * @param tool GoSurfaceOpening object.
1572  * @return The angle tolerance (in degrees).
1573  */
1574 GoFx(k64f) GoSurfaceOpening_AngleTolerance(GoSurfaceOpening tool);
1575 
1576 /**
1577  * Sets the angle tolerance.
1578  *
1579  * @public @memberof GoSurfaceOpening
1580  * @version Introduced in firmware 4.0.10.27
1581  * @param tool GoSurfaceOpening object.
1582  * @param value The angle tolerance to set (in degrees).
1583  * @return Operation status.
1584  */
1585 GoFx(kStatus) GoSurfaceOpening_SetAngleTolerance(GoSurfaceOpening tool, k64f value);
1586 
1587 /**
1588  * Gets the enabled state of partial detection.
1589  *
1590  * @public @memberof GoSurfaceOpening
1591  * @version Introduced in firmware 4.0.10.27
1592  * @param tool GoSurfaceOpening object.
1593  * @return kTRUE if partial detection is enabled and kFALSE otherwise.
1594  */
1595 GoFx(kBool) GoSurfaceOpening_PartialDetectionEnabled(GoSurfaceOpening tool);
1596 
1597 /**
1598  * Sets the enabled state of partial detection.
1599  *
1600  * @public @memberof GoSurfaceOpening
1601  * @version Introduced in firmware 4.0.10.27
1602  * @param tool GoSurfaceOpening object.
1603  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1604  * @return Operation status.
1605  */
1606 GoFx(kStatus) GoSurfaceOpening_EnablePartialDetection(GoSurfaceOpening tool, kBool enable);
1607 
1608 /**
1609  * Gets the enabled state of the tool region.
1610  *
1611  * @public @memberof GoSurfaceOpening
1612  * @version Introduced in firmware 4.0.10.27
1613  * @param tool GoSurfaceOpening object.
1614  * @return kTRUE if the tool region is enabled and kFALSE otherwise.
1615  */
1616 GoFx(kBool) GoSurfaceOpening_RegionEnabled(GoSurfaceOpening tool);
1617 
1618 /**
1619  * Sets the enabled state of the tool region.
1620  *
1621  * @public @memberof GoSurfaceOpening
1622  * @version Introduced in firmware 4.0.10.27
1623  * @param tool GoSurfaceOpening object.
1624  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1625  * @return Operation status.
1626  */
1627 GoFx(kStatus) GoSurfaceOpening_EnableRegion(GoSurfaceOpening tool, kBool enable);
1628 
1629 /**
1630  * Returns the region object for the tool.
1631  *
1632  * @public @memberof GoSurfaceOpening
1633  * @version Introduced in firmware 4.0.10.27
1634  * @param tool GoSurfaceOpening object.
1635  * @return A GoRegion3d object.
1636  */
1637 GoFx(GoRegion3d) GoSurfaceOpening_Region(GoSurfaceOpening tool);
1638 
1639 /**
1640  * Gets the enabled state of reference regions.
1641  *
1642  * @public @memberof GoSurfaceOpening
1643  * @version Introduced in firmware 4.0.10.27
1644  * @param tool GoSurfaceOpening object.
1645  * @return kTRUE if reference regions are enabled and kFALSE otherwise.
1646  */
1647 GoFx(kBool) GoSurfaceOpening_RefRegionsEnabled(GoSurfaceOpening tool);
1648 
1649 /**
1650  * Sets the enabled state of reference regions.
1651  *
1652  * @public @memberof GoSurfaceOpening
1653  * @version Introduced in firmware 4.0.10.27
1654  * @param tool GoSurfaceOpening object.
1655  * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1656  * @return Operation status.
1657  */
1658 GoFx(kStatus) GoSurfaceOpening_EnableRefRegions(GoSurfaceOpening tool, kBool enable);
1659 
1660 /**
1661  * Gets the reference region count.
1662  *
1663  * @public @memberof GoSurfaceOpening
1664  * @version Introduced in firmware 4.0.10.27
1665  * @param tool GoSurfaceOpening object.
1666  * @return The count of reference regions.
1667  */
1668 GoFx(kSize) GoSurfaceOpening_RefRegionCount(GoSurfaceOpening tool);
1669 
1670 /**
1671  * Sets the reference region count.
1672  *
1673  * @public @memberof GoSurfaceOpening
1674  * @version Introduced in firmware 4.0.10.27
1675  * @param tool GoSurfaceOpening object.
1676  * @param count The reference region count to set.
1677  * @return Operation status.
1678  * @see GO_SURFACE_OPENING_MAX_REF_REGIONS
1679  */
1680 GoFx(kStatus) GoSurfaceOpening_SetRefRegionCount(GoSurfaceOpening tool, kSize count);
1681 
1682 /**
1683  * Gets the reference region object at the specified index.
1684  *
1685  * @public @memberof GoSurfaceOpening
1686  * @version Introduced in firmware 4.0.10.27
1687  * @param tool GoSurfaceOpening object.
1688  * @param index The index with which to retrieve a reference region.
1689  * @return A GoSurfaceRegion2d object or kNULL if the index is invalid.
1690  * @see GoSurfaceOpening_RefRegionCount
1691  */
1692 GoFx(GoSurfaceRegion2d) GoSurfaceOpening_RefRegionAt(GoSurfaceOpening tool, kSize index);
1693 
1694 /**
1695  * Gets the enabled state of auto-tilt.
1696  *
1697  * @public @memberof GoSurfaceOpening
1698  * @version Introduced in firmware 4.0.10.27
1699  * @param tool GoSurfaceOpening object.
1700  * @return kTRUE if auto-tilt is enabled and kFALSE otherwise.
1701  */
1702 GoFx(kBool) GoSurfaceOpening_AutoTiltEnabled(GoSurfaceOpening tool);
1703 
1704 /**
1705  * Sets the enabled state of auto-tilt.
1706  *
1707  * @public @memberof GoSurfaceOpening
1708  * @version Introduced in firmware 4.0.10.27
1709  * @param tool GoSurfaceOpening object.
1710  * @param enable kTRUE to enable auto-tilt and kFALSE to disable it.
1711  * @return Operation status.
1712  */
1713 GoFx(kStatus) GoSurfaceOpening_EnableAutoTilt(GoSurfaceOpening tool, kBool enable);
1714 
1715 /**
1716  * Gets the tilt X-angle.
1717  *
1718  * @public @memberof GoSurfaceOpening
1719  * @version Introduced in firmware 4.0.10.27
1720  * @param tool GoSurfaceOpening object.
1721  * @return The tilt X-angle.
1722  */
1723 GoFx(k64f) GoSurfaceOpening_TiltXAngle(GoSurfaceOpening tool);
1724 
1725 /**
1726  * Sets the tilt X-angle.
1727  *
1728  * @public @memberof GoSurfaceOpening
1729  * @version Introduced in firmware 4.0.10.27
1730  * @param tool GoSurfaceOpening object.
1731  * @param value The tilt X-angle to set.
1732  * @return Operation status.
1733  */
1734 GoFx(kStatus) GoSurfaceOpening_SetTiltXAngle(GoSurfaceOpening tool, k64f value);
1735 
1736 /**
1737  * Gets the tilt Y-angle.
1738  *
1739  * @public @memberof GoSurfaceOpening
1740  * @version Introduced in firmware 4.0.10.27
1741  * @param tool GoSurfaceOpening object.
1742  * @return The tilt Y-angle.
1743  */
1744 GoFx(k64f) GoSurfaceOpening_TiltYAngle(GoSurfaceOpening tool);
1745 
1746 /**
1747  * Sets the tilt Y-angle.
1748  *
1749  * @public @memberof GoSurfaceOpening
1750  * @version Introduced in firmware 4.0.10.27
1751  * @param tool GoSurfaceOpening object.
1752  * @param value The tilt Y-angle to set.
1753  * @return Operation status.
1754  */
1755 GoFx(kStatus) GoSurfaceOpening_SetTiltYAngle(GoSurfaceOpening tool, k64f value);
1756 
1757 /**
1758  * Gets the enabled state of the depth limit.
1759  *
1760  * @public @memberof GoSurfaceOpening
1761  * @version Introduced in firmware 4.3.3.124
1762  * @param tool GoSurfaceOpening object.
1763  * @return kTRUE if enabled and kFALSE if disabled.
1764  */
1765 GoFx(kBool) GoSurfaceOpening_DepthLimitEnabled(GoSurfaceOpening tool);
1766 
1767 /**
1768  * Sets the enabled state of the depth limit.
1769  *
1770  * @public @memberof GoSurfaceOpening
1771  * @version Introduced in firmware 4.3.3.124
1772  * @param tool GoSurfaceOpening object.
1773  * @param enable kTRUE to enable it and kFALSE to disable it.
1774  * @return Operation status.
1775  */
1776 GoFx(kStatus) GoSurfaceOpening_EnableDepthLimit(GoSurfaceOpening tool, kBool enable);
1777 
1778 /**
1779  * Gets the depth limit value.
1780  *
1781  * @public @memberof GoSurfaceOpening
1782  * @version Introduced in firmware 4.3.3.124
1783  * @param tool GoSurfaceOpening object.
1784  * @return Depth limit value.
1785 
1786  */
1787 GoFx(k64f) GoSurfaceOpening_DepthLimit(GoSurfaceOpening tool);
1788 
1789 /**
1790  * Sets the depth limit value.
1791  *
1792  * @public @memberof GoSurfaceOpening
1793  * @version Introduced in firmware 4.3.3.124
1794  * @param tool GoSurfaceOpening object.
1795  * @param value The depth limit value to set.
1796  * @return Operation status.
1797  * @see GoSurfaceOpening_DepthLimitEnabled, GoSurfaceOpening_EnableDepthLimit
1798  */
1799 GoFx(kStatus) GoSurfaceOpening_SetDepthLimit(GoSurfaceOpening tool, k64f value);
1800 
1801 
1802 /**
1803  * Returns a GoSurfaceOpening X measurement object.
1804  *
1805  * @public @memberof GoSurfaceOpening
1806  * @version Introduced in firmware 4.0.10.27
1807  * @param tool GoSurfaceOpening object.
1808  * @return A GoSurfaceOpening X measurement.
1809  */
1810 GoFx(GoSurfaceOpeningX) GoSurfaceOpening_XMeasurement(GoSurfaceOpening tool);
1811 
1812 /**
1813  * Returns a GoSurfaceOpening Y measurement object.
1814  *
1815  * @public @memberof GoSurfaceOpening
1816  * @version Introduced in firmware 4.0.10.27
1817  * @param tool GoSurfaceOpening object.
1818  * @return A GoSurfaceOpening Y measurement.
1819  */
1820 GoFx(GoSurfaceOpeningY) GoSurfaceOpening_YMeasurement(GoSurfaceOpening tool);
1821 
1822 /**
1823  * Returns a GoSurfaceOpening Z measurement object.
1824  *
1825  * @public @memberof GoSurfaceOpening
1826  * @version Introduced in firmware 4.0.10.27
1827  * @param tool GoSurfaceOpening object.
1828  * @return A GoSurfaceOpening Z measurement.
1829  */
1830 GoFx(GoSurfaceOpeningZ) GoSurfaceOpening_ZMeasurement(GoSurfaceOpening tool);
1831 
1832 /**
1833  * Returns a GoSurfaceOpening Width measurement object.
1834  *
1835  * @public @memberof GoSurfaceOpening
1836  * @version Introduced in firmware 4.0.10.27
1837  * @param tool GoSurfaceOpening object.
1838  * @return A GoSurfaceOpening Width measurement.
1839  */
1840 GoFx(GoSurfaceOpeningWidth) GoSurfaceOpening_WidthMeasurement(GoSurfaceOpening tool);
1841 
1842 /**
1843  * Returns a GoSurfaceOpening Length measurement object.
1844  *
1845  * @public @memberof GoSurfaceOpening
1846  * @version Introduced in firmware 4.0.10.27
1847  * @param tool GoSurfaceOpening object.
1848  * @return A GoSurfaceOpening Length measurement.
1849  */
1850 GoFx(GoSurfaceOpeningLength) GoSurfaceOpening_LengthMeasurement(GoSurfaceOpening tool);
1851 
1852 /**
1853  * Returns a GoSurfaceOpening Angle measurement object.
1854  *
1855  * @public @memberof GoSurfaceOpening
1856  * @version Introduced in firmware 4.0.10.27
1857  * @param tool GoSurfaceOpening object.
1858  * @return A GoSurfaceOpening Angle measurement.
1859  */
1860 GoFx(GoSurfaceOpeningAngle) GoSurfaceOpening_AngleMeasurement(GoSurfaceOpening tool);
1861 
1862 
1863 /**
1864  * @class GoSurfacePlane
1865  * @extends GoSurfaceTool
1866  * @ingroup GoSdk-SurfaceTools
1867  * @brief Represents a surface plane tool.
1868  */
1869 typedef GoSurfaceTool GoSurfacePlane;
1870 
1871 /**
1872  * Gets the enabled state of the reference regions.
1873  *
1874  * @public @memberof GoSurfacePlane
1875  * @version Introduced in firmware 4.0.10.27
1876  * @param tool GoSurfacePlane object.
1877  * @return kTRUE if the tool region is enabled and kFALSE otherwise.
1878  */
1879 GoFx(kBool) GoSurfacePlane_RegionsEnabled(GoSurfacePlane tool);
1880 
1881 /**
1882  * Sets the enabled state of the reference regions.
1883  *
1884  * @public @memberof GoSurfacePlane
1885  * @version Introduced in firmware 4.0.10.27
1886  * @param tool GoSurfacePlane object.
1887  * @param enable kTRUE to enable regions and kFALSE to disable them.
1888  * @return Operation status.
1889  */
1890 GoFx(kStatus) GoSurfacePlane_EnableRegions(GoSurfacePlane tool, kBool enable);
1891 
1892 /**
1893  * Gets the tool's region count.
1894  *
1895  * @public @memberof GoSurfacePlane
1896  * @version Introduced in firmware 4.0.10.27
1897  * @param tool GoSurfacePlane object.
1898  * @return The number of regions in the tool.
1899  */
1900 GoFx(kSize) GoSurfacePlane_RegionCount(GoSurfacePlane tool);
1901 
1902 /**
1903  * Sets the tool region count.
1904  *
1905  * @public @memberof GoSurfacePlane
1906  * @version Introduced in firmware 4.0.10.27
1907  * @param tool GoSurfacePlane object.
1908  * @param count The region count to set.
1909  * @return Operation status.
1910  */
1911 GoFx(kStatus) GoSurfacePlane_SetRegionCount(GoSurfacePlane tool, kSize count);
1912 
1913 /**
1914  * Gets a region at the specified index.
1915  *
1916  * @public @memberof GoSurfacePlane
1917  * @version Introduced in firmware 4.0.10.27
1918  * @param tool GoSurfacePlane object.
1919  * @param index The index with which to return a tool region.
1920  * @return A GoRegion3d object or kNULL if the index is in invalid.
1921  * @see GoSurfacePlane_RegionCount
1922  */
1923 GoFx(GoRegion3d) GoSurfacePlane_RegionAt(GoSurfacePlane tool, kSize index);
1924 
1925 /**
1926  * Returns a GoSurfacePlane X Angle measurement object.
1927  *
1928  * @public @memberof GoSurfacePlane
1929  * @version Introduced in firmware 4.0.10.27
1930  * @param tool GoSurfacePlane object.
1931  * @return A GoSurfacePlane X Angle measurement.
1932  */
1933 GoFx(GoSurfacePlaneXAngle) GoSurfacePlane_XAngleMeasurement(GoSurfacePlane tool);
1934 
1935 /**
1936  * Returns a GoSurfacePlane Y Angle measurement object.
1937  *
1938  * @public @memberof GoSurfacePlane
1939  * @version Introduced in firmware 4.0.10.27
1940  * @param tool GoSurfacePlane object.
1941  * @return A GoSurfacePlane Y Angle measurement.
1942  */
1943 GoFx(GoSurfacePlaneYAngle) GoSurfacePlane_YAngleMeasurement(GoSurfacePlane tool);
1944 
1945 /**
1946  * Returns a GoSurfacePlane Z Offset measurement object.
1947  *
1948  * @public @memberof GoSurfacePlane
1949  * @version Introduced in firmware 4.0.10.27
1950  * @param tool GoSurfacePlane object.
1951  * @return A GoSurfacePlane Z Offset measurement.
1952  */
1953 GoFx(GoSurfacePlaneZOffset) GoSurfacePlane_ZOffsetMeasurement(GoSurfacePlane tool);
1954 
1955 /**
1956  * Returns a GoSurfacePlane Standard Deviation measurement object.
1957  *
1958  * @public @memberof GoSurfacePlane
1959  * @version Introduced in firmware 4.4.4.14
1960  * @param tool GoSurfacePlane object.
1961  * @return A GoSurfacePlane Standard Deviation measurement.
1962  */
1963 GoFx(GoSurfacePlaneStdDev) GoSurfacePlane_StdDevMeasurement(GoSurfacePlane tool);
1964 
1965 /**
1966  * Returns a GoSurfacePlane Minimum Error measurement object.
1967  *
1968  * @public @memberof GoSurfacePlane
1969  * @version Introduced in firmware 4.4.4.14
1970  * @param tool GoSurfacePlane object.
1971  * @return A GoSurfacePlane Minimum Error measurement.
1972  */
1973 GoFx(GoSurfacePlaneMinError) GoSurfacePlane_MinErrorMeasurement(GoSurfacePlane tool);
1974 
1975 /**
1976  * Returns a GoSurfacePlane Maximum Error measurement object.
1977  *
1978  * @public @memberof GoSurfacePlane
1979  * @version Introduced in firmware 4.4.4.14
1980  * @param tool GoSurfacePlane object.
1981  * @return A GoSurfacePlane Maximum Error measurement.
1982  */
1983 GoFx(GoSurfacePlaneMaxError) GoSurfacePlane_MaxErrorMeasurement(GoSurfacePlane tool);
1984 
1985 
1986 /**
1987  * @class GoSurfacePosition
1988  * @extends GoSurfaceTool
1989  * @ingroup GoSdk-SurfaceTools
1990  * @brief Represents a surface position tool.
1991  */
1992 typedef GoSurfaceTool GoSurfacePosition;
1993 
1994 GoFx(GoSurfaceFeature) GoSurfacePosition_Feature(GoSurfacePosition tool);
1995 
1996 /**
1997  * Returns a GoSurfacePosition X measurement object.
1998  *
1999  * @public @memberof GoSurfacePosition
2000  * @version Introduced in firmware 4.0.10.27
2001  * @param tool GoSurfacePosition object.
2002  * @return A GoSurfacePosition X measurement.
2003  */
2004 GoFx(GoSurfacePositionX) GoSurfacePosition_XMeasurement(GoSurfacePosition tool);
2005 
2006 /**
2007  * Returns a GoSurfacePosition Y measurement object.
2008  *
2009  * @public @memberof GoSurfacePosition
2010  * @version Introduced in firmware 4.0.10.27
2011  * @param tool GoSurfacePosition object.
2012  * @return A GoSurfacePosition Y measurement.
2013  */
2014 GoFx(GoSurfacePositionY) GoSurfacePosition_YMeasurement(GoSurfacePosition tool);
2015 
2016 /**
2017  * Returns a GoSurfacePosition Z measurement object.
2018  *
2019  * @public @memberof GoSurfacePosition
2020  * @version Introduced in firmware 4.0.10.27
2021  * @param tool GoSurfacePosition object.
2022  * @return A GoSurfacePosition Z measurement.
2023  */
2024 GoFx(GoSurfacePositionZ) GoSurfacePosition_ZMeasurement(GoSurfacePosition tool);
2025 
2026 
2027 /**
2028  * @class GoSurfaceStud
2029  * @extends GoSurfaceTool
2030  * @ingroup GoSdk-SurfaceTools
2031  * @brief Represents a surface stud tool.
2032  */
2033 typedef GoSurfaceTool GoSurfaceStud;
2034 
2035 /**
2036  * Returns the stud radius value.
2037  *
2038  * @public @memberof GoSurfaceStud
2039  * @version Introduced in firmware 4.0.10.27
2040  * @param tool GoSurfaceStud object.
2041  * @return The stud radius value.
2042  */
2043 GoFx(k64f) GoSurfaceStud_StudRadius(GoSurfaceStud tool);
2044 
2045 /**
2046  * Sets the stud radius value.
2047  *
2048  * @public @memberof GoSurfaceStud
2049  * @version Introduced in firmware 4.0.10.27
2050  * @param tool GoSurfaceStud object.
2051  * @param value The stud radius value to set.
2052  * @return Operation status.
2053  */
2054 GoFx(kStatus) GoSurfaceStud_SetStudRadius(GoSurfaceStud tool, k64f value);
2055 
2056 /**
2057  * Returns the stud height value.
2058  *
2059  * @public @memberof GoSurfaceStud
2060  * @version Introduced in firmware 4.0.10.27
2061  * @param tool GoSurfaceStud object.
2062  * @return The stud height value.
2063  */
2064 GoFx(k64f) GoSurfaceStud_StudHeight(GoSurfaceStud tool);
2065 
2066 /**
2067  * Sets the stud height value.
2068  *
2069  * @public @memberof GoSurfaceStud
2070  * @version Introduced in firmware 4.0.10.27
2071  * @param tool GoSurfaceStud object.
2072  * @param value The stud height value to set.
2073  * @return Operation status.
2074  */
2075 GoFx(kStatus) GoSurfaceStud_SetStudHeight(GoSurfaceStud tool, k64f value);
2076 
2077 /**
2078  * Returns the stud base height value.
2079  *
2080  * @public @memberof GoSurfaceStud
2081  * @version Introduced in firmware 4.0.10.27
2082  * @param tool GoSurfaceStud object.
2083  * @return The stud base height value.
2084  */
2085 GoFx(k64f) GoSurfaceStud_BaseHeight(GoSurfaceStud tool);
2086 
2087 /**
2088  * Sets the base height value.
2089  *
2090  * @public @memberof GoSurfaceStud
2091  * @version Introduced in firmware 4.0.10.27
2092  * @param tool GoSurfaceStud object.
2093  * @param value The base height value to set.
2094  * @return Operation status.
2095  */
2096 GoFx(kStatus) GoSurfaceStud_SetBaseHeight(GoSurfaceStud tool, k64f value);
2097 
2098 /**
2099  * Returns the stud tip height value.
2100  *
2101  * @public @memberof GoSurfaceStud
2102  * @version Introduced in firmware 4.0.10.27
2103  * @param tool GoSurfaceStud object.
2104  * @return The stud tip height value.
2105  */
2106 GoFx(k64f) GoSurfaceStud_TipHeight(GoSurfaceStud tool);
2107 
2108 /**
2109  * Sets the tip height value.
2110  *
2111  * @public @memberof GoSurfaceStud
2112  * @version Introduced in firmware 4.0.10.27
2113  * @param tool GoSurfaceStud object.
2114  * @param value The tip height value to set.
2115  * @return Operation status.
2116  */
2117 GoFx(kStatus) GoSurfaceStud_SetTipHeight(GoSurfaceStud tool, k64f value);
2118 
2119 /**
2120  * Gets the enabled state of the tool region.
2121  *
2122  * @public @memberof GoSurfaceStud
2123  * @version Introduced in firmware 4.0.10.27
2124  * @param tool GoSurfaceStud object.
2125  * @return kTRUE if enabled and kFALSE if disabled.
2126  */
2127 GoFx(kBool) GoSurfaceStud_RegionEnabled(GoSurfaceStud tool);
2128 
2129 /**
2130  * Sets the enabled state of the tool region.
2131  *
2132  * @public @memberof GoSurfaceStud
2133  * @version Introduced in firmware 4.0.10.27
2134  * @param tool GoSurfaceStud object.
2135  * @param enable kTRUE to enable the region and kFALSE to disable it.
2136  * @return Operation status.
2137  */
2138 GoFx(kStatus) GoSurfaceStud_EnableRegion(GoSurfaceStud tool, kBool enable);
2139 
2140 /**
2141  * Returns the tool region object.
2142  *
2143  * @public @memberof GoSurfaceStud
2144  * @version Introduced in firmware 4.0.10.27
2145  * @param tool GoSurfaceStud object.
2146  * @return A GoRegion3d object.
2147  */
2148 GoFx(GoRegion3d) GoSurfaceStud_Region(GoSurfaceStud tool);
2149 
2150 /**
2151  * Gets the enabled state of the reference regions.
2152  *
2153  * @public @memberof GoSurfaceStud
2154  * @version Introduced in firmware 4.0.10.27
2155  * @param tool GoSurfaceStud object.
2156  * @return enable kTRUE if the reference regions are enabled and kFALSE otherwise.
2157  */
2158 GoFx(kBool) GoSurfaceStud_RefRegionsEnabled(GoSurfaceStud tool);
2159 
2160 /**
2161  * Sets the enabled state of the reference regions.
2162  *
2163  * @public @memberof GoSurfaceStud
2164  * @version Introduced in firmware 4.0.10.27
2165  * @param tool GoSurfaceStud object.
2166  * @param enable kTRUE to enable the region and kFALSE to disable it.
2167  * @return Operation status.
2168  */
2169 GoFx(kStatus) GoSurfaceStud_EnableRefRegions(GoSurfaceStud tool, kBool enable);
2170 
2171 /**
2172  * Sets the reference region count.
2173  *
2174  * @public @memberof GoSurfaceStud
2175  * @version Introduced in firmware 4.0.10.27
2176  * @param tool GoSurfaceStud object.
2177  * @param count The number of reference regions to use.
2178  * @return Operation status.
2179  * @see GO_SURFACE_STUD_MAX_REF_REGIONS
2180  */
2181 GoFx(kStatus) GoSurfaceStud_SetRefRegionCount(GoSurfaceStud tool, kSize count);
2182 
2183 /**
2184  * Returns the reference region count.
2185  *
2186  * @public @memberof GoSurfaceStud
2187  * @version Introduced in firmware 4.0.10.27
2188  * @param tool GoSurfaceStud object.
2189  * @return The reference region count.
2190  */
2191 GoFx(kSize) GoSurfaceStud_RefRegionCount(GoSurfaceStud tool);
2192 
2193 /**
2194  * Returns the reference region object at the given index.
2195  *
2196  * @public @memberof GoSurfaceStud
2197  * @version Introduced in firmware 4.0.10.27
2198  * @param tool GoSurfaceStud object.
2199  * @param index The index with which to return a reference region.
2200  * @return A GoSurfaceRegion2d object.
2201  * @see GoSurfaceStud_RefRegionCount
2202  */
2203 GoFx(GoSurfaceRegion2d) GoSurfaceStud_RefRegionAt(GoSurfaceStud tool, kSize index);
2204 
2205 /**
2206  * Gets the enabled state of auto-tilt.
2207  *
2208  * @public @memberof GoSurfaceStud
2209  * @version Introduced in firmware 4.0.10.27
2210  * @param tool GoSurfaceStud object.
2211  * @return kTRUE if enabled and kFALSE if disabled.
2212  */
2213 GoFx(kBool) GoSurfaceStud_AutoTiltEnabled(GoSurfaceStud tool);
2214 
2215 /**
2216  * Sets the enabled state of auto-tilt.
2217  *
2218  * @public @memberof GoSurfaceStud
2219  * @version Introduced in firmware 4.0.10.27
2220  * @param tool GoSurfaceStud object.
2221  * @param enable kTRUE to enable the region and kFALSE to disable it.
2222  * @return Operation status.
2223  */
2224 GoFx(kStatus) GoSurfaceStud_EnableAutoTilt(GoSurfaceStud tool, kBool enable);
2225 
2226 /**
2227  * Gets the tilt X-angle value.
2228  *
2229  * @public @memberof GoSurfaceStud
2230  * @version Introduced in firmware 4.0.10.27
2231  * @param tool GoSurfaceStud object.
2232  * @return The tilt X-angle value.
2233  */
2234 GoFx(k64f) GoSurfaceStud_TiltXAngle(GoSurfaceStud tool);
2235 
2236 /**
2237  * Sets the tilt X-angle value.
2238  *
2239  * @public @memberof GoSurfaceStud
2240  * @version Introduced in firmware 4.0.10.27
2241  * @param tool GoSurfaceStud object.
2242  * @param value The tilt X-angle value to set.
2243  * @return Operation status.
2244  */
2245 GoFx(kStatus) GoSurfaceStud_SetTiltXAngle(GoSurfaceStud tool, k64f value);
2246 
2247 /**
2248  * Returns the tilt Y-angle value.
2249  *
2250  * @public @memberof GoSurfaceStud
2251  * @version Introduced in firmware 4.0.10.27
2252  * @param tool GoSurfaceStud object.
2253  * @return The tilt Y-angle value.
2254  */
2255 GoFx(k64f) GoSurfaceStud_TiltYAngle(GoSurfaceStud tool);
2256 
2257 /**
2258  * Sets the tilt Y-angle value.
2259  *
2260  * @public @memberof GoSurfaceStud
2261  * @version Introduced in firmware 4.0.10.27
2262  * @param tool GoSurfaceStud object.
2263  * @param value The tilt Y-angle value to set.
2264  * @return Operation status.
2265  */
2266 GoFx(kStatus) GoSurfaceStud_SetTiltYAngle(GoSurfaceStud tool, k64f value);
2267 
2268 /**
2269  * Returns a GoSurfaceStud Base X measurement object.
2270  *
2271  * @public @memberof GoSurfaceStud
2272  * @version Introduced in firmware 4.0.10.27
2273  * @param tool GoSurfaceStud object.
2274  * @return A GoSurfaceStud Base X measurement.
2275  */
2276 GoFx(GoSurfaceStudBaseX) GoSurfaceStud_BaseXMeasurement(GoSurfaceStud tool);
2277 
2278 /**
2279  * Returns a GoSurfaceStud Base Y measurement object.
2280  *
2281  * @public @memberof GoSurfaceStud
2282  * @version Introduced in firmware 4.0.10.27
2283  * @param tool GoSurfaceStud object.
2284  * @return A GoSurfaceStud Base Y measurement.
2285  */
2286 GoFx(GoSurfaceStudBaseY) GoSurfaceStud_BaseYMeasurement(GoSurfaceStud tool);
2287 
2288 /**
2289  * Returns a GoSurfaceStud Base Z measurement object.
2290  *
2291  * @public @memberof GoSurfaceStud
2292  * @version Introduced in firmware 4.0.10.27
2293  * @param tool GoSurfaceStud object.
2294  * @return A GoSurfaceStud Base Z measurement.
2295  */
2296 GoFx(GoSurfaceStudBaseZ) GoSurfaceStud_BaseZMeasurement(GoSurfaceStud tool);
2297 
2298 /**
2299  * Returns a GoSurfaceStud Tip X measurement object.
2300  *
2301  * @public @memberof GoSurfaceStud
2302  * @version Introduced in firmware 4.0.10.27
2303  * @param tool GoSurfaceStud object.
2304  * @return A GoSurfaceStud Tip X measurement.
2305  */
2306 GoFx(GoSurfaceStudTipX) GoSurfaceStud_TipXMeasurement(GoSurfaceStud tool);
2307 
2308 /**
2309  * Returns a GoSurfaceStud Tip Y measurement object.
2310  *
2311  * @public @memberof GoSurfaceStud
2312  * @version Introduced in firmware 4.0.10.27
2313  * @param tool GoSurfaceStud object.
2314  * @return A GoSurfaceStud Tip Y measurement.
2315  */
2316 GoFx(GoSurfaceStudTipY) GoSurfaceStud_TipYMeasurement(GoSurfaceStud tool);
2317 
2318 /**
2319  * Returns a GoSurfaceStud Tip Z measurement object.
2320  *
2321  * @public @memberof GoSurfaceStud
2322  * @version Introduced in firmware 4.0.10.27
2323  * @param tool GoSurfaceStud object.
2324  * @return A GoSurfaceStud Tip Z measurement.
2325  */
2326 GoFx(GoSurfaceStudTipZ) GoSurfaceStud_TipZMeasurement(GoSurfaceStud tool);
2327 
2328 /**
2329  * Returns a GoSurfaceStud Radius measurement object.
2330  *
2331  * @public @memberof GoSurfaceStud
2332  * @version Introduced in firmware 4.0.10.27
2333  * @param tool GoSurfaceStud object.
2334  * @return A GoSurfaceStud Radius measurement.
2335  */
2336 GoFx(GoSurfaceStudRadius) GoSurfaceStud_RadiusMeasurement(GoSurfaceStud tool);
2337 
2338 
2339 /**
2340  * @class GoSurfaceVolume
2341  * @extends GoSurfaceTool
2342  * @ingroup GoSdk-SurfaceTools
2343  * @brief Represents a surface volume tool.
2344  */
2345 typedef GoSurfaceTool GoSurfaceVolume;
2346 
2347 /**
2348  * Gets the enabled state of the tool region.
2349  *
2350  * @public @memberof GoSurfaceVolume
2351  * @version Introduced in firmware 4.0.10.27
2352  * @param tool GoSurfaceVolume object.
2353  * @return kTRUE if enabled and kFALSE if disabled.
2354  */
2355 GoFx(kBool) GoSurfaceVolume_RegionEnabled(GoSurfaceVolume tool);
2356 
2357 /**
2358  * Sets the enabled state of the tool region.
2359  *
2360  * @public @memberof GoSurfaceVolume
2361  * @version Introduced in firmware 4.0.10.27
2362  * @param tool GoSurfaceVolume object.
2363  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
2364  */
2365 GoFx(kStatus) GoSurfaceVolume_EnableRegion(GoSurfaceVolume tool, kBool enable);
2366 
2367 /**
2368  * Returns the tool region object.
2369  *
2370  * @public @memberof GoSurfaceVolume
2371  * @version Introduced in firmware 4.0.10.27
2372  * @param tool GoSurfaceVolume object.
2373  * @return A GoRegion3d object.
2374  */
2375 GoFx(GoRegion3d) GoSurfaceVolume_Region(GoSurfaceVolume tool);
2376 
2377 /**
2378  * Returns a GoSurfaceVolume Volume measurement object.
2379  *
2380  * @public @memberof GoSurfaceVolume
2381  * @version Introduced in firmware 4.0.10.27
2382  * @param tool GoSurfaceVolume object.
2383  * @return A GoSurfaceVolume Volume measurement.
2384  */
2385 GoFx(GoSurfaceVolumeVolume) GoSurfaceVolume_VolumeMeasurement(GoSurfaceVolume tool);
2386 
2387 /**
2388  * Returns a GoSurfaceVolume Area measurement object.
2389  *
2390  * @public @memberof GoSurfaceVolume
2391  * @version Introduced in firmware 4.0.10.27
2392  * @param tool GoSurfaceVolume object.
2393  * @return A GoSurfaceVolume Area measurement.
2394  */
2395 GoFx(GoSurfaceVolumeArea) GoSurfaceVolume_AreaMeasurement(GoSurfaceVolume tool);
2396 
2397 /**
2398  * Returns a GoSurfaceVolume Thickness measurement object.
2399  *
2400  * @public @memberof GoSurfaceVolume
2401  * @version Introduced in firmware 4.0.10.27
2402  * @param tool GoSurfaceVolume object.
2403  * @return A GoSurfaceVolume Thickness measurement.
2404  */
2405 GoFx(GoSurfaceVolumeThickness) GoSurfaceVolume_ThicknessMeasurement(GoSurfaceVolume tool);
2406 
2407 kEndHeader()
2408 #include <GoSdk/Tools/GoSurfaceTools.x.h>
2409 
2410 #endif
2411 
2412 /// @endcond
GoTool.h
Declares the base GoTool class.
GoDataSource
Represents a data source.
GoUtils.h
Contains various helper functions.
GoSdkDef.h
Essential SDK declarations.
GoTool
Represents the base tool class.