Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSurfaceTools.h
Go to the documentation of this file.
1 /**
2  * @file GoSurfaceTools.h
3  * @brief Declares all surface tools and their related classes.
4  *
5  * @internal
6  * Copyright (C) 2016-2021 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 
11 #ifndef GO_SURFACE_TOOLS_H
12 #define GO_SURFACE_TOOLS_H
13 
14 #include <GoSdk/GoSdkDef.h>
15 #include <GoSdk/Tools/GoTool.h>
17 #include <GoSdk/GoUtils.h>
18 
19 /**
20  * @class GoSurfaceTool
21  * @extends GoTool
22  * @note Supported with G2, G3
23  * @ingroup GoSdk-SurfaceTools
24  * @brief Represents a base surface tool.
25  */
26 typedef GoTool GoSurfaceTool;
27 
28 /**
29  * Sets the data stream. Note that stream validation will only occur if tool
30  * is in the tool options list.
31  *
32  * @public @memberof GoSurfaceTool
33  * @note Supported with G2, G3
34  * @version Introduced in firmware 5.3.19.50
35  * @param tool GoSurfaceTool object.
36  * @param stream GoDataStream value.
37  * @return Operation status.
38  * @see GoSurfaceTool_StreamOptionCount, GoSurfaceTool_StreamOptionAt
39  */
41 
42 /**
43  * Gets the data stream.
44  *
45  * @public @memberof GoSurfaceTool
46  * @note Supported with G2, G3
47  * @version Introduced in firmware 5.3.19.50
48  * @param tool GoSurfaceTool object.
49  * @return The current Surface tool data stream value.
50  */
52 
53 /**
54  * Gets the data stream option list count.
55  *
56  * @public @memberof GoSurfaceTool
57  * @note Supported with G2, G3
58  * @version Introduced in firmware 5.3.19.50
59  * @param tool GoSurfaceTool object.
60  * @return The current Surface tool data stream option list count.
61  */
63 
64 /**
65  * Gets the data stream option at the given index.
66  *
67  * @public @memberof GoSurfaceTool
68  * @note Supported with G2, G3
69  * @version Introduced in firmware 5.3.19.50
70  * @param tool GoSurfaceTool object.
71  * @param index The index of the option list to access.
72  * @return The Surface tool data stream option at the given index, or k32U_MAX if an invalid index is given.
73  */
75 
76 /**
77  * Sets the data source. Note that source validation will only occur if tool
78  * is in the tool options list.
79  *
80  * @public @memberof GoSurfaceTool
81  * @note Supported with G2, G3
82  * @version Introduced in firmware 4.0.10.27
83  * @param tool GoSurfaceTool object.
84  * @param source GoDataSource object.
85  * @return Operation status.
86  * @see GoTools_ToolOptionCount, GoTools_ToolOptionAt
87  */
89 
90 /**
91  * Gets the data source.
92  *
93  * @public @memberof GoSurfaceTool
94  * @note Supported with G2, G3
95  * @version Introduced in firmware 4.0.10.27
96  * @param tool GoSurfaceTool object.
97  * @return The data source.
98  */
100 
101 /**
102  * Gets the data source option list count.
103  *
104  * @public @memberof GoSurfaceTool
105  * @note Supported with G2, G3
106  * @version Introduced in firmware 4.0.10.27
107  * @param tool GoSurfaceTool object.
108  * @return The current tool data source option list count.
109  */
111 
112 /**
113  * Gets the data source option at the given index.
114  *
115  * @public @memberof GoSurfaceTool
116  * @note Supported with G2, G3
117  * @version Introduced in firmware 4.0.10.27
118  * @param tool GoSurfaceTool object.
119  * @param index The index of the option list to access.
120  * @return The tool data source option at the given index, or k32U_MAX if an invalid index is given.
121  */
122 
124 
125 /**
126  * Gets the X-anchoring option list count.
127  *
128  * @public @memberof GoSurfaceTool
129  * @note Supported with G2, G3
130  * @version Introduced in firmware 4.0.10.27
131  * @param tool GoSurfaceTool object.
132  * @return The X-anchoring option list count.
133  */
135 
136 /**
137  * Gets the X-anchoring option at the given index.
138  *
139  * @public @memberof GoSurfaceTool
140  * @note Supported with G2, G3
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 X-anchoring option at the given index or k32U_MAX if invalid.
145  */
147 
148 /**
149  * Gets the current X-anchoring source.
150  *
151  * @public @memberof GoSurfaceTool
152  * @note Supported with G2, G3
153  * @version Introduced in firmware 4.0.10.27
154  * @param tool GoSurfaceTool object.
155  * @return The X-anchoring source or -1 if no source is currently set.
156  */
158 
159 /**
160  * Sets the X-anchoring source.
161  *
162  * @public @memberof GoSurfaceTool
163  * @note Supported with G2, G3
164  * @version Introduced in firmware 4.0.10.27
165  * @param tool GoSurfaceTool object.
166  * @param id The measurement ID of a valid X-anchoring source.
167  * @return Operation status.
168  */
170 
171 /**
172  * Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
173  *
174  * @public @memberof GoSurfaceTool
175  * @note Supported with G2, G3
176  * @version Introduced in firmware 4.0.10.27
177  * @param tool GoSurfaceTool object.
178  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
179  */
181 
182 /**
183  * Gets the Y-anchoring option list count.
184  *
185  * @public @memberof GoSurfaceTool
186  * @note Supported with G2, G3
187  * @version Introduced in firmware 4.0.10.27
188  * @param tool GoSurfaceTool object.
189  * @return The Y-anchoring option list count.
190  */
192 
193 /**
194  * Gets the Y-anchoring option at the given index.
195  *
196  * @public @memberof GoSurfaceTool
197  * @note Supported with G2, G3
198  * @version Introduced in firmware 4.0.10.27
199  * @param tool GoSurfaceTool object.
200  * @param index The index of the option list to access.
201  * @return The Y-anchoring option at the given index or k32U_MAX if invalid.
202  */
204 
205 /**
206  * Gets the current Y-anchoring source.
207  *
208  * @public @memberof GoSurfaceTool
209  * @note Supported with G2, G3
210  * @version Introduced in firmware 4.0.10.27
211  * @param tool GoSurfaceTool object.
212  * @return The Y-anchoring source or -1 if no source is currently set.
213  */
215 
216 /**
217  * Sets the Y-anchoring source.
218  *
219  * @public @memberof GoSurfaceTool
220  * @note Supported with G2, G3
221  * @version Introduced in firmware 4.0.10.27
222  * @param tool GoSurfaceTool object.
223  * @param id The measurement ID of a valid Y-anchoring source.
224  * @return Operation status.
225  */
227 
228 /**
229  * Returns a boolean value representing whether or not a valid Y-anchoring source has been set for Y-anchoring.
230  *
231  * @public @memberof GoSurfaceTool
232  * @note Supported with G2, G3
233  * @version Introduced in firmware 4.0.10.27
234  * @param tool GoSurfaceTool object.
235  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
236  */
238 
239 /**
240  * Gets the Z-anchoring option list count.
241  *
242  * @public @memberof GoSurfaceTool
243  * @note Supported with G2, G3
244  * @version Introduced in firmware 4.0.10.27
245  * @param tool GoSurfaceTool object.
246  * @return The X-anchoring option list count.
247  */
249 
250 /**
251  * Gets the Z-anchoring option at the given index.
252  *
253  * @public @memberof GoSurfaceTool
254  * @note Supported with G2, G3
255  * @version Introduced in firmware 4.0.10.27
256  * @param tool GoSurfaceTool object.
257  * @param index The index of the option list to access.
258  * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
259  */
261 
262 /**
263  * Gets the current Z-anchoring source.
264  *
265  * @public @memberof GoSurfaceTool
266  * @note Supported with G2, G3
267  * @version Introduced in firmware 4.0.10.27
268  * @param tool GoSurfaceTool object.
269  * @return The Z-anchoring source or -1 if no source is currently set.
270  */
272 
273 /**
274  * Sets the Z-anchoring source.
275  *
276  * @public @memberof GoSurfaceTool
277  * @note Supported with G2, G3
278  * @version Introduced in firmware 4.0.10.27
279  * @param tool GoSurfaceTool object.
280  * @param id The measurement ID of a valid Z-anchoring source.
281  * @return Operation status.
282  */
284 
285 /**
286  * Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
287  *
288  * @public @memberof GoSurfaceTool
289  * @note Supported with G2, G3
290  * @version Introduced in firmware 4.0.10.27
291  * @param tool GoSurfaceTool object.
292  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
293  */
295 
296 /**
297 * Gets the Z-anchoring option list count.
298 *
299 * @public @memberof GoSurfaceTool
300 * @note Supported with G2, G3
301 * @version Introduced in firmware 4.6.1.123
302 * @param tool GoSurfaceTool object.
303 * @return The X-anchoring option list count.
304 */
306 
307 /**
308 * Gets the ZAngle-anchoring option at the given index.
309 *
310 * @public @memberof GoSurfaceTool
311 * @note Supported with G2, G3
312 * @version Introduced in firmware 4.6.1.123
313 * @param tool GoSurfaceTool object.
314 * @param index The index of the option list to access.
315 * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
316 */
318 
319 /**
320 * Sets the ZAngle-anchoring source.
321 *
322 * @public @memberof GoSurfaceTool
323 * @note Supported with G2, G3
324 * @version Introduced in firmware 4.6.1.123
325 * @param tool GoSurfaceTool object.
326 * @param id The measurement ID of a valid Z-anchoring source.
327 * @return Operation status.
328 */
330 
331 /**
332 * Returns a boolean value representing whether or not a valid ZAngle - anchoring source has been set for ZAngle - anchoring.
333 *
334 * @public @memberof GoSurfaceTool
335 * @note Supported with G2, G3
336 * @version Introduced in firmware 4.6.1.123
337 * @param tool GoSurfaceTool object.
338 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
339 */
341 
342 /**
343 * Gets the ZAngle-anchoring source.
344 *
345 * @public @memberof GoSurfaceTool
346 * @note Supported with G2, G3
347 * @version Introduced in firmware 4.6.1.123
348 * @param tool GoSurfaceTool object.
349 * @return Operation status.
350 */
352 
353 /**
354  * @class GoSurfaceBox
355  * @extends GoSurfaceTool
356  * @note Supported with G2, G3
357  * @ingroup GoSdk-SurfaceTools
358  * @brief Represents a surface bounding box tool.\n all width/height/length/radius and x/y/z units are in mm, angles in degrees
359  */
360 typedef GoSurfaceTool GoSurfaceBox;
361 
362 /**
363  * Returns the enabled state of Z-rotation.
364  *
365  * @public @memberof GoSurfaceBox
366  * @note Supported with G2, G3
367  * @version Introduced in firmware 4.0.10.27
368  * @param tool GoSurfaceBox object.
369  * @return kTRUE if enabled and kFALSE if disabled.
370  */
371 GoFx(kBool) GoSurfaceBox_ZRotationEnabled(GoSurfaceBox tool);
372 
373 /**
374  * Enables or disables Z-rotation.
375  *
376  * @public @memberof GoSurfaceBox
377  * @note Supported with G2, G3
378  * @version Introduced in firmware 4.0.10.27
379  * @param tool GoSurfaceBox object.
380  * @param enable kTRUE to enable Z-rotation, kFALSE to disable it.
381  * @return Operation status.
382  */
383 GoFx(kStatus) GoSurfaceBox_EnableZRotation(GoSurfaceBox tool, kBool enable);
384 
385 /**
386  * Returns the enabled state of the tool region.
387  *
388  * @public @memberof GoSurfaceBox
389  * @note Supported with G2, G3
390  * @version Introduced in firmware 4.0.10.27
391  * @param tool GoSurfaceBox object.
392  * @return kTRUE if enabled and kFALSE if disabled.
393  */
394 GoFx(kBool) GoSurfaceBox_RegionEnabled(GoSurfaceBox tool);
395 
396 /**
397  * Enables or disables the tool region.
398  *
399  * @public @memberof GoSurfaceBox
400  * @note Supported with G2, G3
401  * @version Introduced in firmware 4.0.10.27
402  * @param tool GoSurfaceBox object.
403  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
404  * @return Operation status.
405  */
406 GoFx(kStatus) GoSurfaceBox_EnableRegion(GoSurfaceBox tool, kBool enable);
407 
408 /**
409  * Gets the surface bounding box region.
410  *
411  * @public @memberof GoSurfaceBox
412  * @note Supported with G2, G3
413  * @version Introduced in firmware 4.0.10.27
414  * @param tool GoSurfaceBox object.
415  * @return A GoRegion3d object.
416  */
417 GoFx(GoRegion3d) GoSurfaceBox_Region(GoSurfaceBox tool);
418 
419 /**
420  * Sets the asymmetry detection type.
421  *
422  * @public @memberof GoSurfaceBox
423  * @note Supported with G2, G3
424  * @version Introduced in firmware 4.4.4.14
425  * @param tool GoSurfaceBox object.
426  * @param value The asymmetry detection type to set.
427  * @return Operation status.
428  */
430 
431 /**
432  * Gets the asymmetry detection type.
433  *
434  * @public @memberof GoSurfaceBox
435  * @note Supported with G2, G3
436  * @version Introduced in firmware 4.4.4.14
437  * @param tool GoSurfaceBox object.
438  * @return The asymmetry detection type.
439  */
441 
442 /**
443  * Returns a GoSurfaceBox X measurement object.
444  *
445  * @public @memberof GoSurfaceBox
446  * @note Supported with G2, G3
447  * @version Introduced in firmware 4.0.10.27
448  * @param tool GoSurfaceBox object.
449  * @return A GoSurfaceBox X measurement.
450  */
451 GoFx(GoSurfaceBoxX) GoSurfaceBox_XMeasurement(GoSurfaceBox tool);
452 
453 /**
454  * Returns a GoSurfaceBox Y measurement object.
455  *
456  * @public @memberof GoSurfaceBox
457  * @note Supported with G2, G3
458  * @version Introduced in firmware 4.0.10.27
459  * @param tool GoSurfaceBox object.
460  * @return A GoSurfaceBox Y measurement.
461  */
462 GoFx(GoSurfaceBoxY) GoSurfaceBox_YMeasurement(GoSurfaceBox tool);
463 
464 /**
465  * Returns a GoSurfaceBox Z measurement object.
466  *
467  * @public @memberof GoSurfaceBox
468  * @note Supported with G2, G3
469  * @version Introduced in firmware 4.0.10.27
470  * @param tool GoSurfaceBox object.
471  * @return A GoSurfaceBox Z measurement.
472  */
473 GoFx(GoSurfaceBoxZ) GoSurfaceBox_ZMeasurement(GoSurfaceBox tool);
474 
475 /**
476  * Returns a GoSurfaceBox Width measurement object.
477  *
478  * @public @memberof GoSurfaceBox
479  * @note Supported with G2, G3
480  * @version Introduced in firmware 4.0.10.27
481  * @param tool GoSurfaceBox object.
482  * @return A GoSurfaceBox Width measurement.
483  */
484 GoFx(GoSurfaceBoxWidth) GoSurfaceBox_WidthMeasurement(GoSurfaceBox tool);
485 
486 /**
487  * Returns a GoSurfaceBox Length measurement object.
488  *
489  * @public @memberof GoSurfaceBox
490  * @note Supported with G2, G3
491  * @version Introduced in firmware 4.0.10.27
492  * @param tool GoSurfaceBox object.
493  * @return A GoSurfaceBox Length measurement.
494  */
495 GoFx(GoSurfaceBoxLength) GoSurfaceBox_LengthMeasurement(GoSurfaceBox tool);
496 
497 /**
498  * Returns a GoSurfaceBox Height measurement object.
499  *
500  * @public @memberof GoSurfaceBox
501  * @note Supported with G2, G3
502  * @version Introduced in firmware 4.0.10.27
503  * @param tool GoSurfaceBox object.
504  * @return A GoSurfaceBox Height measurement.
505  */
506 GoFx(GoSurfaceBoxHeight) GoSurfaceBox_HeightMeasurement(GoSurfaceBox tool);
507 
508 /**
509  * Returns a GoSurfaceBox Z Angle measurement object.
510  *
511  * @public @memberof GoSurfaceBox
512  * @note Supported with G2, G3
513  * @version Introduced in firmware 4.0.10.27
514  * @param tool GoSurfaceBox object.
515  * @return A GoSurfaceBox Z Angle measurement.
516  */
517 GoFx(GoSurfaceBoxZAngle) GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool);
518 
519 /**
520  * Returns a GoSurfaceBox global X measurement object.
521  *
522  * @public @memberof GoSurfaceBox
523  * @note Supported with G2, G3
524  * @version Introduced in firmware 4.0.10.27
525  * @param tool GoSurfaceBox object.
526  * @return A GoSurfaceBox global X measurement.
527  */
529 
530 /**
531  * Returns a GoSurfaceBox global Y measurement object.
532  *
533  * @public @memberof GoSurfaceBox
534  * @note Supported with G2, G3
535  * @version Introduced in firmware 4.0.10.27
536  * @param tool GoSurfaceBox object.
537  * @return A GoSurfaceBox global Y measurement.
538  */
540 
541 /**
542  * Returns a GoSurfaceBox global Z Angle measurement object.
543  *
544  * @public @memberof GoSurfaceBox
545  * @note Supported with G2, G3
546  * @version Introduced in firmware 4.2.4.7
547  * @param tool GoSurfaceBox object.
548  * @return A GoSurfaceBox global Z angle measurement.
549  */
551 
552 /**
553 * Returns a GoSurfaceBoundingBoxCenterPoint center point feature object.
554 *
555 * @public @memberof GoSurfaceBox
556 * @note Supported with G2, G3
557 * @version Introduced in firmware 4.2.4.7
558 * @param tool GoSurfaceBox object.
559 * @return A GoSurfaceBoundingBoxCenterPoint center point feature.
560 */
562 
563 /**
564 * Returns a GoSurfaceBoundingBoxAxisLine axis line feature object.
565 *
566 * @public @memberof GoSurfaceBox
567 * @version Introduced in firmware 6.1.18.16
568 * @note Supported with G2, G3
569 * @param tool GoSurfaceBox object.
570 * @return A GoSurfaceBoundingBoxAxisLine axis line feature.
571 */
572 GoFx(GoSurfaceBoundingBoxAxisLine) GoSurfaceBox_AxisLine(GoSurfaceBox tool);
573 
574 /**
575 * @class GoSurfaceCountersunkHole
576 * @extends GoSurfaceTool
577 * @note Supported with G2, G3
578 * @ingroup GoSdk-SurfaceTools
579 * @brief Represents a Surface Counter Sunk Hole tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
580 */
582 
583 /**
584  * Sets the shape.
585  *
586  * @public @memberof GoSurfaceCountersunkHole
587  * @note Supported with G2, G3
588  * @version Introduced in firmware 4.3.3.124
589  * @param tool GoSurfaceCountersunkHole object.
590  * @param value The value to set.
591  * @return Operation status.
592  */
593 GoFx(kStatus) GoSurfaceCountersunkHole_SetShape(GoSurfaceCountersunkHole tool, GoSurfaceCountersunkHoleShape value);
594 
595 /**
596  * Returns the shape.
597  *
598  * @public @memberof GoSurfaceCountersunkHole
599  * @note Supported with G2, G3
600  * @version Introduced in firmware 4.3.3.124
601  * @param tool GoSurfaceCountersunkHole object.
602  * @return The nominal bevel angle.
603  */
604 GoFx(GoSurfaceCountersunkHoleShape) GoSurfaceCountersunkHole_Shape(GoSurfaceCountersunkHole tool);
605 
606 /**
607  * Sets the nominal bevel angle.
608  *
609  * @public @memberof GoSurfaceCountersunkHole
610  * @note Supported with G2, G3
611  * @version Introduced in firmware 4.0.10.27
612  * @param tool GoSurfaceCountersunkHole object.
613  * @param value The value to set.
614  * @return Operation status.
615  */
616 GoFx(kStatus) GoSurfaceCountersunkHole_SetNominalBevelAngle(GoSurfaceCountersunkHole tool, k64f value);
617 
618 /**
619  * Returns the nominal bevel angle.
620  *
621  * @public @memberof GoSurfaceCountersunkHole
622  * @note Supported with G2, G3
623  * @version Introduced in firmware 4.0.10.27
624  * @param tool GoSurfaceCountersunkHole object.
625  * @return The nominal bevel angle.
626  */
627 GoFx(k64f) GoSurfaceCountersunkHole_NominalBevelAngle(GoSurfaceCountersunkHole tool);
628 
629 /**
630  * Sets the nominal outer radius.
631  *
632  * @public @memberof GoSurfaceCountersunkHole
633  * @note Supported with G2, G3
634  * @version Introduced in firmware 4.0.10.27
635  * @param tool GoSurfaceCountersunkHole object.
636  * @param value The value to set.
637  * @return Operation status.
638  */
639 GoFx(kStatus) GoSurfaceCountersunkHole_SetNominalOuterRadius(GoSurfaceCountersunkHole tool, k64f value);
640 
641 /**
642  * Returns the nominal outer radius.
643  *
644  * @public @memberof GoSurfaceCountersunkHole
645  * @note Supported with G2, G3
646  * @version Introduced in firmware 4.0.10.27
647  * @param tool GoSurfaceCountersunkHole object.
648  * @return The nominal outer radius.
649  */
650 GoFx(k64f) GoSurfaceCountersunkHole_NominalOuterRadius(GoSurfaceCountersunkHole tool);
651 
652 /**
653  * Sets the nominal inner radius.
654  *
655  * @public @memberof GoSurfaceCountersunkHole
656  * @note Supported with G2, G3
657  * @version Introduced in firmware 4.0.10.27
658  * @param tool GoSurfaceCountersunkHole object.
659  * @param value The value to set.
660  * @return Operation status.
661  */
662 GoFx(kStatus) GoSurfaceCountersunkHole_SetNominalInnerRadius(GoSurfaceCountersunkHole tool, k64f value);
663 
664 /**
665  * Returns the nominal inner radius.
666  *
667  * @public @memberof GoSurfaceCountersunkHole
668  * @note Supported with G2, G3
669  * @version Introduced in firmware 4.0.10.27
670  * @param tool GoSurfaceCountersunkHole object.
671  * @return The nominal inner radius.
672  */
673 GoFx(k64f) GoSurfaceCountersunkHole_NominalInnerRadius(GoSurfaceCountersunkHole tool);
674 
675 /**
676  * Sets the bevel radius offset.
677  *
678  * @public @memberof GoSurfaceCountersunkHole
679  * @note Supported with G2, G3
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_SetBevelRadiusOffset(GoSurfaceCountersunkHole tool, k64f value);
686 
687 /**
688  * Returns the bevel radius offset.
689  *
690  * @public @memberof GoSurfaceCountersunkHole
691  * @note Supported with G2, G3
692  * @version Introduced in firmware 4.0.10.27
693  * @param tool GoSurfaceCountersunkHole object.
694  * @return The bevel radius offset.
695  */
696 GoFx(k64f) GoSurfaceCountersunkHole_BevelRadiusOffset(GoSurfaceCountersunkHole tool);
697 
698 /**
699  * Enables or disables partial counter sunk hole detection.
700  *
701  * @public @memberof GoSurfaceCountersunkHole
702  * @note Supported with G2, G3
703  * @version Introduced in firmware 4.0.10.27
704  * @param tool GoSurfaceCountersunkHole object.
705  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
706  * @return Operation status.
707  */
708 GoFx(kStatus) GoSurfaceCountersunkHole_EnablePartialDetection(GoSurfaceCountersunkHole tool, kBool enable);
709 
710 /**
711  * Returns the state of partial detection.
712  *
713  * @public @memberof GoSurfaceCountersunkHole
714  * @note Supported with G2, G3
715  * @version Introduced in firmware 4.0.10.27
716  * @param tool GoSurfaceCountersunkHole object.
717  * @return kTRUE if partial detection is enabled. kFALSE otherwise.
718  */
719 GoFx(kBool) GoSurfaceCountersunkHole_PartialDetectionEnabled(GoSurfaceCountersunkHole tool);
720 
721 /**
722  * Enables or disables the tool region.
723  *
724  * @public @memberof GoSurfaceCountersunkHole
725  * @note Supported with G2, G3
726  * @version Introduced in firmware 4.0.10.27
727  * @param tool GoSurfaceCountersunkHole object.
728  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
729  * @return Operation status.
730  */
731 GoFx(kStatus) GoSurfaceCountersunkHole_EnableRegion(GoSurfaceCountersunkHole tool, kBool enable);
732 
733 /**
734  * Returns the state of the tool region.
735  *
736  * @public @memberof GoSurfaceCountersunkHole
737  * @note Supported with G2, G3
738  * @version Introduced in firmware 4.0.10.27
739  * @param tool GoSurfaceCountersunkHole object.
740  * @return kTRUE if the tool region is enabled. kFALSE otherwise.
741  */
742 GoFx(kBool) GoSurfaceCountersunkHole_RegionEnabled(GoSurfaceCountersunkHole tool);
743 
744 /**
745  * Returns the tool region.
746  *
747  * @public @memberof GoSurfaceCountersunkHole
748  * @note Supported with G2, G3
749  * @version Introduced in firmware 4.0.10.27
750  * @param tool GoSurfaceCountersunkHole object.
751  * @return The tool region.
752  */
753 GoFx(GoRegion3d) GoSurfaceCountersunkHole_Region(GoSurfaceCountersunkHole tool);
754 
755 /**
756  * Enables or disables reference regions.
757  *
758  * @public @memberof GoSurfaceCountersunkHole
759  * @note Supported with G2, G3
760  * @version Introduced in firmware 4.0.10.27
761  * @param tool GoSurfaceCountersunkHole object.
762  * @param enable kTRUE to enable reference regions and kFALSE to disable them.
763  * @return Operation status.
764  */
765 GoFx(kStatus) GoSurfaceCountersunkHole_EnableRefRegions(GoSurfaceCountersunkHole tool, kBool enable);
766 
767 /**
768  * Returns the state of the tool reference regions.
769  *
770  * @public @memberof GoSurfaceCountersunkHole
771  * @note Supported with G2, G3
772  * @version Introduced in firmware 4.0.10.27
773  * @param tool GoSurfaceCountersunkHole object.
774  * @return kTRUE if refrence regions are enabled. kFALSE otherwise.
775  */
776 GoFx(kBool) GoSurfaceCountersunkHole_RefRegionsEnabled(GoSurfaceCountersunkHole tool);
777 
778 /**
779  * Sets the reference region count.
780  *
781  * @public @memberof GoSurfaceCountersunkHole
782  * @note Supported with G2, G3
783  * @version Introduced in firmware 4.0.10.27
784  * @param tool GoSurfaceCountersunkHole object.
785  * @param count The number of references regions to use when enabled.
786  * @return Reference region count.
787  * @see GO_SURFACE_COUNTERSUNK_HOLE_MAX_REF_REGIONS
788 
789  */
790 GoFx(kStatus) GoSurfaceCountersunkHole_SetRefRegionCount(GoSurfaceCountersunkHole tool, kSize count);
791 
792 /**
793  * Returns the reference region count.
794  *
795  * @public @memberof GoSurfaceCountersunkHole
796  * @note Supported with G2, G3
797  * @version Introduced in firmware 4.0.10.27
798  * @param tool GoSurfaceCountersunkHole object.
799  * @return Reference region count.
800  */
801 GoFx(kSize) GoSurfaceCountersunkHole_RefRegionCount(GoSurfaceCountersunkHole tool);
802 
803 /**
804  * Returns the reference region at the given index.
805  *
806  * @public @memberof GoSurfaceCountersunkHole
807  * @note Supported with G2, G3
808  * @version Introduced in firmware 4.0.10.27
809  * @param tool GoSurfaceCountersunkHole object.
810  * @param index The index of the reference region to retrieve.
811  * @return A reference region.
812  */
813 GoFx(GoSurfaceRegion2d) GoSurfaceCountersunkHole_RefRegionAt(GoSurfaceCountersunkHole tool, kSize index);
814 
815 /**
816  * Enables or disables automatic tilt.
817  *
818  * @public @memberof GoSurfaceCountersunkHole
819  * @note Supported with G2, G3
820  * @version Introduced in firmware 4.0.10.27
821  * @param tool GoSurfaceCountersunkHole object.
822  * @param enable kTRUE to enable auto tilt and kFALSE to disable it.
823  * @return Operation status.
824  */
825 GoFx(kStatus) GoSurfaceCountersunkHole_EnableAutoTilt(GoSurfaceCountersunkHole tool, kBool enable);
826 
827 /**
828  * Returns the state of auto tilt.
829  *
830  * @public @memberof GoSurfaceCountersunkHole
831  * @note Supported with G2, G3
832  * @version Introduced in firmware 4.0.10.27
833  * @param tool GoSurfaceCountersunkHole object.
834  * @return kTRUE if auto tilt is enabled. kFALSE otherwise.
835  */
836 GoFx(kBool) GoSurfaceCountersunkHole_AutoTiltEnabled(GoSurfaceCountersunkHole tool);
837 
838 /**
839  * Sets the tilt X angle.
840  *
841  * @public @memberof GoSurfaceCountersunkHole
842  * @note Supported with G2, G3
843  * @version Introduced in firmware 4.0.10.27
844  * @param tool GoSurfaceCountersunkHole object.
845  * @param value The value to set.
846  * @return Operation status.
847  */
848 GoFx(kStatus) GoSurfaceCountersunkHole_SetTiltXAngle(GoSurfaceCountersunkHole tool, k64f value);
849 
850 /**
851  * Returns the tilt X angle value.
852  *
853  * @public @memberof GoSurfaceCountersunkHole
854  * @note Supported with G2, G3
855  * @version Introduced in firmware 4.0.10.27
856  * @param tool GoSurfaceCountersunkHole object.
857  * @return Tilt X angle value.
858  */
859 GoFx(k64f) GoSurfaceCountersunkHole_TiltXAngle(GoSurfaceCountersunkHole tool);
860 
861 /**
862  * Sets the tilt Y angle.
863  *
864  * @public @memberof GoSurfaceCountersunkHole
865  * @note Supported with G2, G3
866  * @version Introduced in firmware 4.0.10.27
867  * @param tool GoSurfaceCountersunkHole object.
868  * @param value The value to set.
869  * @return Operation status.
870  */
871 GoFx(kStatus) GoSurfaceCountersunkHole_SetTiltYAngle(GoSurfaceCountersunkHole tool, k64f value);
872 
873 /**
874  * Returns the tilt Y angle value.
875  *
876  * @public @memberof GoSurfaceCountersunkHole
877  * @note Supported with G2, G3
878  * @version Introduced in firmware 4.0.10.27
879  * @param tool GoSurfaceCountersunkHole object.
880  * @return Tilt Y angle value.
881  */
882 GoFx(k64f) GoSurfaceCountersunkHole_TiltYAngle(GoSurfaceCountersunkHole tool);
883 
884 /**
885  * Enables or disables curve fitting.
886  *
887  * @public @memberof GoSurfaceCountersunkHole
888  * @note Supported with G2, G3
889  * @version Introduced in firmware 4.1.3.106
890  * @param tool GoSurfaceCountersunkHole object.
891  * @param enable kTRUE to enable curve fitting and kFALSE to disable it.
892  * @return Operation status.
893  */
894 GoFx(kStatus) GoSurfaceCountersunkHole_EnableCurveFit(GoSurfaceCountersunkHole tool, kBool enable);
895 
896 
897 /**
898  * Returns the state of auto tilt.
899  *
900  * @public @memberof GoSurfaceCountersunkHole
901  * @note Supported with G2, G3
902  * @version Introduced in firmware 4.1.3.106
903  * @param tool GoSurfaceCountersunkHole object.
904  * @return kTRUE if curve fitting is enabled. kFALSE otherwise.
905  */
906 GoFx(kBool) GoSurfaceCountersunkHole_CurveFitEnabled(GoSurfaceCountersunkHole tool);
907 
908 /**
909  * Sets the curve orientation angle.
910  *
911  * @public @memberof GoSurfaceCountersunkHole
912  * @note Supported with G2, G3
913  * @version Introduced in firmware 4.1.3.106
914  * @param tool GoSurfaceCountersunkHole object.
915  * @param value The value to set.
916  * @return Operation status.
917  */
918 GoFx(kStatus) GoSurfaceCountersunkHole_SetCurveOrientation(GoSurfaceCountersunkHole tool, k64f value);
919 
920 /**
921  * Returns the curve orientation angle value.
922  *
923  * @public @memberof GoSurfaceCountersunkHole
924  * @note Supported with G2, G3
925  * @version Introduced in firmware 4.1.3.106
926  * @param tool GoSurfaceCountersunkHole object.
927  * @return Curve orientation angle value.
928  */
929 GoFx(k64f) GoSurfaceCountersunkHole_CurveOrientation(GoSurfaceCountersunkHole tool);
930 
931 /**
932  * Sets the plane fit range.
933  *
934  * @public @memberof GoSurfaceCountersunkHole
935  * @note Supported with G2, G3
936  * @version Introduced in firmware 4.5.3.57
937  * @param tool GoSurfaceCountersunkHole object.
938  * @param value The value to set.
939  * @return Operation status.
940  */
941 GoFx(kStatus) GoSurfaceCountersunkHole_SetPlaneFitRange(GoSurfaceCountersunkHole tool, k64f value);
942 
943 /**
944  * Gets the enabled state of the plane fit range.
945  *
946  * @public @memberof GoSurfaceCountersunkHole
947  * @note Supported with G2, G3
948  * @version Introduced in firmware 4.5.3.57
949  * @param tool GoSurfaceCountersunkHole object.
950  * @return kTRUE if enabled and kFALSE if disabled.
951  */
952 GoFx(kBool) GoSurfaceCountersunkHole_PlaneFitRangeEnabled(GoSurfaceCountersunkHole tool);
953 
954 /**
955  * Sets the enabled state of the plane fit range.
956  *
957  * @public @memberof GoSurfaceCountersunkHole
958  * @note Supported with G2, G3
959  * @version Introduced in firmware 4.5.3.57
960  * @param tool GoSurfaceCountersunkHole object.
961  * @param enable kTRUE to enable it and kFALSE to disable it.
962  * @return Operation status.
963  */
964 GoFx(kStatus) GoSurfaceCountersunkHole_EnablePlaneFitRange(GoSurfaceCountersunkHole tool, kBool enable);
965 
966 /**
967  * Returns the plane fit range.
968  *
969  * @public @memberof GoSurfaceCountersunkHole
970  * @note Supported with G2, G3
971  * @version Introduced in firmware 4.5.3.57
972  * @param tool GoSurfaceCountersunkHole object.
973  * @return Plane fit range value.
974  */
975 GoFx(k64f) GoSurfaceCountersunkHole_PlaneFitRange(GoSurfaceCountersunkHole tool);
976 
977 /**
978  * Returns a GoSurfaceCountersunkHole tool X position measurement object.
979  *
980  * @public @memberof GoSurfaceCountersunkHole
981  * @note Supported with G2, G3
982  * @version Introduced in firmware 4.0.10.27
983  * @param tool GoSurfaceCountersunkHole object.
984  * @return A GoSurfaceCountersunkHole X position measurement.
985  */
986 GoFx(GoSurfaceCountersunkHoleX) GoSurfaceCountersunkHole_XMeasurement(GoSurfaceCountersunkHole tool);
987 
988 /**
989  * Returns a GoSurfaceCountersunkHole tool Y position measurement object.
990  *
991  * @public @memberof GoSurfaceCountersunkHole
992  * @note Supported with G2, G3
993  * @version Introduced in firmware 4.0.10.27
994  * @param tool GoSurfaceCountersunkHole object.
995  * @return A GoSurfaceCountersunkHole Y position measurement.
996  */
997 GoFx(GoSurfaceCountersunkHoleY) GoSurfaceCountersunkHole_YMeasurement(GoSurfaceCountersunkHole tool);
998 
999 /**
1000  * Returns a GoSurfaceCountersunkHole tool Z position measurement object.
1001  *
1002  * @public @memberof GoSurfaceCountersunkHole
1003  * @note Supported with G2, G3
1004  * @version Introduced in firmware 4.0.10.27
1005  * @param tool GoSurfaceCountersunkHole object.
1006  * @return A GoSurfaceCountersunkHole Z position measurement.
1007  */
1008 GoFx(GoSurfaceCountersunkHoleZ) GoSurfaceCountersunkHole_ZMeasurement(GoSurfaceCountersunkHole tool);
1009 
1010 /**
1011  * Returns a GoSurfaceCountersunkHole tool Outer Radius measurement object.
1012  *
1013  * @public @memberof GoSurfaceCountersunkHole
1014  * @note Supported with G2, G3
1015  * @version Introduced in firmware 4.0.10.27
1016  * @param tool GoSurfaceCountersunkHole object.
1017  * @return A GoSurfaceCountersunkHoleOuterRadius Outer Radius measurement.
1018  */
1020 
1021 /**
1022  * Returns a GoSurfaceCountersunkHole tool Depth measurement object.
1023  *
1024  * @public @memberof GoSurfaceCountersunkHole
1025  * @note Supported with G2, G3
1026  * @version Introduced in firmware 4.0.10.27
1027  * @param tool GoSurfaceCountersunkHole object.
1028  * @return A GoSurfaceCoGoSurfaceCountersunkHoleDepthuntersunkHole Depth measurement.
1029  */
1031 
1032 /**
1033  * Returns a GoSurfaceCountersunkHole tool counterbore depth measurement object.
1034  *
1035  * @public @memberof GoSurfaceCountersunkHole
1036  * @note Supported with G2, G3
1037  * @version Introduced in firmware 4.3.3.124
1038  * @param tool GoSurfaceCountersunkHole object.
1039  * @return A GoSurfaceCountersunkHoleCounterboreDepth counterbore depth measurement.
1040  */
1042 
1043 /**
1044  * Returns a GoSurfaceCountersunkHole tool Bevel Radius measurement object.
1045  *
1046  * @public @memberof GoSurfaceCountersunkHole
1047  * @note Supported with G2, G3
1048  * @version Introduced in firmware 4.0.10.27
1049  * @param tool GoSurfaceCountersunkHole object.
1050  * @return A GoSurfaceCountersunkHoleBevelRadius Bevel Radius measurement.
1051  */
1053 
1054 /**
1055  * Returns a GoSurfaceCountersunkHole tool Bevel Angle measurement object.
1056  *
1057  * @public @memberof GoSurfaceCountersunkHole
1058  * @note Supported with G2, G3
1059  * @version Introduced in firmware 4.0.10.27
1060  * @param tool GoSurfaceCountersunkHole object.
1061  * @return A GoSurfaceCountersunkHoleBevelAngle Bevel Angle measurement.
1062  */
1064 
1065 /**
1066  * Returns a GoSurfaceCountersunkHole tool X Angle measurement object.
1067  *
1068  * @public @memberof GoSurfaceCountersunkHole
1069  * @note Supported with G2, G3
1070  * @version Introduced in firmware 4.0.10.27
1071  * @param tool GoSurfaceCountersunkHole object.
1072  * @return A GoSurfaceCountersunkHoleXAngle X angle measurement.
1073  */
1075 
1076 /**
1077  * Returns a GoSurfaceCountersunkHole tool Y Angle measurement object.
1078  *
1079  * @public @memberof GoSurfaceCountersunkHole
1080  * @note Supported with G2, G3
1081  * @version Introduced in firmware 4.0.10.27
1082  * @param tool GoSurfaceCountersunkHole object.
1083  * @return A GoSurfaceCountersunkHoleYAngle Y angle measurement.
1084  */
1086 
1087 /**
1088  * Returns a GoSurfaceCountersunkHole tool axis tilt measurement object.
1089  *
1090  * @public @memberof GoSurfaceCountersunkHole
1091  * @note Supported with G2, G3
1092  * @version Introduced in firmware 4.5.3.57
1093  * @param tool GoSurfaceCountersunkHole object.
1094  * @return A GoSurfaceCountersunkHoleAxisTilt axis tilt measurement.
1095  */
1096 GoFx(GoSurfaceCountersunkHoleAxisTilt) GoSurfaceCountersunkHole_AxisTilt(GoSurfaceCountersunkHole tool);
1097 
1098 /**
1099  * Returns a GoSurfaceCountersunkHole tool axis orientation measurement object.
1100  *
1101  * @public @memberof GoSurfaceCountersunkHole
1102  * @note Supported with G2, G3
1103  * @version Introduced in firmware 4.5.3.57
1104  * @param tool GoSurfaceCountersunkHole object.
1105  * @return A GoSurfaceCountersunkHoleAxisOrientation axis orientation measurement.
1106  */
1108 
1109 /**
1110 * Returns a GoSurfaceCountersunkHoleCenterPoint tool center point feature.
1111 *
1112 * @public @memberof GoSurfaceCountersunkHoleCenterPoint
1113 * @note Supported with G2, G3
1114 * @version Introduced in firmware 4.5.3.57
1115 * @param tool GoSurfaceCountersunkHole object.
1116 * @return A GoSurfaceCountersunkHoleCenterPoint center point feature.
1117 */
1119 
1120 /**
1121  * @class GoSurfaceDim
1122  * @extends GoSurfaceTool
1123  * @note Supported with G2, G3
1124  * @ingroup GoSdk-SurfaceTools
1125  * @brief Represents a Surface dimension tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1126  */
1127 typedef GoSurfaceTool GoSurfaceDim;
1128 
1129 /**
1130  * Gets the reference Surface feature.
1131  *
1132  * @public @memberof GoSurfaceDim
1133  * @note Supported with G2, G3
1134  * @version Introduced in firmware 4.4.4.14
1135  * @param tool GoSurfaceDim object.
1136  * @return The reference Surface feature object.
1137  */
1138 GoFx(GoSurfaceFeature) GoSurfaceDim_RefFeature(GoSurfaceDim tool);
1139 
1140 
1141 /**
1142  * Gets the non-reference Surface feature.
1143  *
1144  * @public @memberof GoSurfaceDim
1145  * @note Supported with G2, G3
1146  * @version Introduced in firmware 4.4.4.14
1147  * @param tool GoSurfaceDim object.
1148  * @return The non-reference Surface feature object.
1149  */
1150 GoFx(GoSurfaceFeature) GoSurfaceDim_Feature(GoSurfaceDim tool);
1151 
1152 /**
1153  * Returns a GoSurfaceDim Width measurement object.
1154  *
1155  * @public @memberof GoSurfaceDim
1156  * @note Supported with G2, G3
1157  * @version Introduced in firmware 4.4.4.14
1158  * @param tool GoSurfaceDim object.
1159  * @return A GoSurfaceDimWidth measurement.
1160  */
1161 GoFx(GoSurfaceDimWidth) GoSurfaceDim_WidthMeasurement(GoSurfaceDim tool);
1162 
1163 /**
1164  * Returns a GoSurfaceDim Height measurement object.
1165  *
1166  * @public @memberof GoSurfaceDim
1167  * @note Supported with G2, G3
1168  * @version Introduced in firmware 4.4.4.14
1169  * @param tool GoSurfaceDim object.
1170  * @return A GoSurfaceDimHeight measurement.
1171  */
1172 GoFx(GoSurfaceDimHeight) GoSurfaceDim_HeightMeasurement(GoSurfaceDim tool);
1173 
1174 /**
1175  * Returns a GoSurfaceDim Length measurement object.
1176  *
1177  * @public @memberof GoSurfaceDim
1178  * @note Supported with G2, G3
1179  * @version Introduced in firmware 4.4.4.14
1180  * @param tool GoSurfaceDim object.
1181  * @return A GoSurfaceDimLength measurement.
1182  */
1183 GoFx(GoSurfaceDimLength) GoSurfaceDim_LengthMeasurement(GoSurfaceDim tool);
1184 
1185 /**
1186  * Returns a GoSurfaceDim Distance measurement object.
1187  *
1188  * @public @memberof GoSurfaceDim
1189  * @note Supported with G2, G3
1190  * @version Introduced in firmware 4.4.4.14
1191  * @param tool GoSurfaceDim object.
1192  * @return A GoSurfaceDimDistance measurement.
1193  */
1195 
1196 /**
1197  * Returns a GoSurfaceDim Plane Distance measurement object.
1198  *
1199  * @public @memberof GoSurfaceDim
1200  * @note Supported with G2, G3
1201  * @version Introduced in firmware 4.4.4.14
1202  * @param tool GoSurfaceDim object.
1203  * @return A GoSurfaceDimPlaneDistance measurement.
1204  */
1206 
1207 /**
1208  * Returns a GoSurfaceDim Center X measurement object.
1209  *
1210  * @public @memberof GoSurfaceDim
1211  * @note Supported with G2, G3
1212  * @version Introduced in firmware 4.4.4.14
1213  * @param tool GoSurfaceDim object.
1214  * @return A GoSurfaceDimCenterX measurement.
1215  */
1216 GoFx(GoSurfaceDimCenterX) GoSurfaceDim_CenterXMeasurement(GoSurfaceDim tool);
1217 
1218 /**
1219  * Returns a GoSurfaceDim Center Y measurement object.
1220  *
1221  * @public @memberof GoSurfaceDim
1222  * @note Supported with G2, G3
1223  * @version Introduced in firmware 4.4.4.14
1224  * @param tool GoSurfaceDim object.
1225  * @return A GoSurfaceDimCenterY measurement.
1226  */
1227 GoFx(GoSurfaceDimCenterY) GoSurfaceDim_CenterYMeasurement(GoSurfaceDim tool);
1228 
1229 /**
1230 * Returns a GoSurfaceDim Center Z measurement object.
1231 *
1232 * @public @memberof GoSurfaceDim
1233 * @note Supported with G2, G3
1234 * @version Introduced in firmware 4.4.4.14
1235 * @param tool GoSurfaceDim object.
1236 * @return A GoSurfaceDimCenterZ measurement.
1237 */
1238 GoFx(GoSurfaceDimCenterZ) GoSurfaceDim_CenterZMeasurement(GoSurfaceDim tool);
1239 
1240 /**
1241 * Returns a GoSurfaceDim center point feature object.
1242 *
1243 * @public @memberof GoSurfaceDim
1244 * @note Supported with G2, G3
1245 * @version Introduced in firmware 4.4.4.14
1246 * @param tool GoSurfaceDim object.
1247 * @return A GoSurfaceDimensionCenterPoint measurement.
1248 */
1250 
1251 /**
1252  * @class GoSurfaceEllipse
1253  * @extends GoSurfaceTool
1254  * @note Supported with G2, G3
1255  * @ingroup GoSdk-SurfaceTools
1256  * @brief Represents a surface ellipse tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1257  */
1259 
1260 /**
1261  * Enables or disables the tool region.
1262  *
1263  * @public @memberof GoSurfaceEllipse
1264  * @note Supported with G2, G3
1265  * @version Introduced in firmware 4.0.10.27
1266  * @param tool GoSurfaceEllipse object.
1267  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1268  * @return Operation status.
1269  */
1270 GoFx(kStatus) GoSurfaceEllipse_EnableRegion(GoSurfaceEllipse tool, kBool enable);
1271 
1272 /**
1273  * Returns the enabled state of the tool region.
1274  *
1275  * @public @memberof GoSurfaceEllipse
1276  * @note Supported with G2, G3
1277  * @version Introduced in firmware 4.0.10.27
1278  * @param tool GoSurfaceEllipse object.
1279  * @return kTRUE if enabled and kFALSE if disabled.
1280  */
1281 GoFx(kBool) GoSurfaceEllipse_RegionEnabled(GoSurfaceEllipse tool);
1282 
1283 /**
1284  * Gets the tool region.
1285  *
1286  * @public @memberof GoSurfaceEllipse
1287  * @note Supported with G2, G3
1288  * @version Introduced in firmware 4.0.10.27
1289  * @param tool GoSurfaceEllipse object.
1290  * @return A GoRegion3d object.
1291  */
1292 GoFx(GoRegion3d) GoSurfaceEllipse_Region(GoSurfaceEllipse tool);
1293 
1294 /**
1295  * Sets the asymmetry detection type.
1296  *
1297  * @public @memberof GoSurfaceEllipse
1298  * @note Supported with G2, G3
1299  * @version Introduced in firmware 4.4.4.14
1300  * @param tool GoSurfaceEllipse object.
1301  * @param value The asymmetry detection type to set.
1302  * @return Operation status.
1303  */
1305 
1306 /**
1307  * Gets the asymmetry detection type.
1308  *
1309  * @public @memberof GoSurfaceEllipse
1310  * @note Supported with G2, G3
1311  * @version Introduced in firmware 4.4.4.14
1312  * @param tool GoSurfaceEllipse object.
1313  * @return The asymmetry detection type.
1314  */
1316 
1317 /**
1318  * Returns a GoSurfaceEllipse Major measurement object.
1319  *
1320  * @public @memberof GoSurfaceEllipse
1321  * @note Supported with G2, G3
1322  * @version Introduced in firmware 4.0.10.27
1323  * @param tool GoSurfaceEllipse object.
1324  * @return A GoSurfaceEllipse Major measurement.
1325  */
1326 GoFx(GoSurfaceEllipseMajor) GoSurfaceEllipse_MajorMeasurement(GoSurfaceEllipse tool);
1327 
1328 /**
1329  * Returns a GoSurfaceEllipse Minor measurement object.
1330  *
1331  * @public @memberof GoSurfaceEllipse
1332  * @note Supported with G2, G3
1333  * @version Introduced in firmware 4.0.10.27
1334  * @param tool GoSurfaceEllipse object.
1335  * @return A GoSurfaceEllipse Minor measurement.
1336  */
1337 GoFx(GoSurfaceEllipseMinor) GoSurfaceEllipse_MinorMeasurement(GoSurfaceEllipse tool);
1338 
1339 /**
1340  * Returns a GoSurfaceEllipse Ratio measurement object.
1341  *
1342  * @public @memberof GoSurfaceEllipse
1343  * @note Supported with G2, G3
1344  * @version Introduced in firmware 4.0.10.27
1345  * @param tool GoSurfaceEllipse object.
1346  * @return A GoSurfaceEllipse Ratio measurement.
1347  */
1348 GoFx(GoSurfaceEllipseRatio) GoSurfaceEllipse_RatioMeasurement(GoSurfaceEllipse tool);
1349 
1350 /**
1351  * Returns a GoSurfaceEllipse Z Angle measurement object.
1352  *
1353  * @public @memberof GoSurfaceEllipse
1354  * @note Supported with G2, G3
1355  * @version Introduced in firmware 4.0.10.27
1356  * @param tool GoSurfaceEllipse object.
1357  * @return A GoSurfaceEllipse Z Angle measurement.
1358  */
1359 GoFx(GoSurfaceEllipseZAngle) GoSurfaceEllipse_ZAngleMeasurement(GoSurfaceEllipse tool);
1360 
1361 /**
1362 * Returns a GoSurfaceEllipse point feature.
1363 *
1364 * @public @memberof GoSurfaceEllipse
1365 * @note Supported with G2, G3
1366 * @version Introduced in firmware 4.0.10.27
1367 * @param tool GoSurfaceEllipse object.
1368 * @return A GoSurfaceEllipseCenterPoint point feature
1369 */
1370 GoFx(GoSurfaceEllipseCenterPoint) GoSurfaceEllipse_CenterPoint(GoSurfaceEllipse tool);
1371 
1372 /**
1373 * Returns a GoSurfaceEllipse major axis line feature.
1374 *
1375 * @public @memberof GoSurfaceEllipse
1376 * @note Supported with G2, G3
1377 * @version Introduced in firmware 4.0.10.27
1378 * @param tool GoSurfaceEllipse object.
1379 * @return A GoSurfaceEllipseMajorAxisLine axis line feature..
1380 */
1382 
1383 /**
1384 * Returns a GoSurfaceEllipse major axis line feature.
1385 *
1386 * @public @memberof GoSurfaceEllipse
1387 * @note Supported with G2, G3
1388 * @version Introduced in firmware 4.0.10.27
1389 * @param tool GoSurfaceEllipse object.
1390 * @return A GoSurfaceEllipseMinorAxisLine major axis line feature.
1391 */
1393 
1394 
1395 /**
1396  * @class GoSurfaceHole
1397  * @extends GoSurfaceTool
1398  * @note Supported with G2, G3
1399  * @ingroup GoSdk-SurfaceTools
1400  * @brief Represents a surface hole tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1401  */
1402 typedef GoSurfaceTool GoSurfaceHole;
1403 
1404 /**
1405  * Gets the current nominal radius value.
1406  *
1407  * @public @memberof GoSurfaceHole
1408  * @note Supported with G2, G3
1409  * @version Introduced in firmware 4.0.10.27
1410  * @param tool GoSurfaceHole object.
1411  * @return The nominal radius value.
1412  */
1413 GoFx(k64f) GoSurfaceHole_NominalRadius(GoSurfaceHole tool);
1414 
1415 /**
1416  * Sets the nominal radius value.
1417  *
1418  * @public @memberof GoSurfaceHole
1419  * @note Supported with G2, G3
1420  * @version Introduced in firmware 4.0.10.27
1421  * @param tool GoSurfaceHole object.
1422  * @param nominalRadius Nominal radius value to set.
1423  * @return Operation status.
1424  */
1425 GoFx(kStatus) GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius);
1426 
1427 /**
1428  * Gets the current radius tolerance value.
1429  *
1430  * @public @memberof GoSurfaceHole
1431  * @note Supported with G2, G3
1432  * @version Introduced in firmware 4.0.10.27
1433  * @param tool GoSurfaceHole object.
1434  * @return The radius tolerance value.
1435  */
1436 GoFx(k64f) GoSurfaceHole_RadiusTolerance(GoSurfaceHole tool);
1437 
1438 /**
1439  * Sets the radius tolerance value.
1440  *
1441  * @public @memberof GoSurfaceHole
1442  * @note Supported with G2, G3
1443  * @version Introduced in firmware 4.0.10.27
1444  * @param tool GoSurfaceHole object.
1445  * @param radiusTolerance The radius tolerance value to set.
1446  * @return Operation status.
1447  */
1448 GoFx(kStatus) GoSurfaceHole_SetRadiusTolerance(GoSurfaceHole tool, k64f radiusTolerance);
1449 
1450 /**
1451  * Gets the enabled state of partial detection.
1452  *
1453  * @public @memberof GoSurfaceHole
1454  * @note Supported with G2, G3
1455  * @version Introduced in firmware 4.0.10.27
1456  * @param tool GoSurfaceHole object.
1457  * @return kTRUE if enabled and kFALSE if disabled.
1458  */
1459 GoFx(kBool) GoSurfaceHole_PartialDetectionEnabled(GoSurfaceHole tool);
1460 
1461 /**
1462  * Sets the enabled state of partial detection.
1463  *
1464  * @public @memberof GoSurfaceHole
1465  * @note Supported with G2, G3
1466  * @version Introduced in firmware 4.0.10.27
1467  * @param tool GoSurfaceHole object.
1468  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1469  * @return Operation status.
1470  */
1471 GoFx(kStatus) GoSurfaceHole_EnablePartialDetection(GoSurfaceHole tool, kBool enable);
1472 
1473 /**
1474  * Gets the enabled state of the tool region.
1475  *
1476  * @public @memberof GoSurfaceHole
1477  * @note Supported with G2, G3
1478  * @version Introduced in firmware 4.0.10.27
1479  * @param tool GoSurfaceHole object.
1480  * @return kTRUE if enabled and kFALSE if disabled.
1481  */
1482 GoFx(kBool) GoSurfaceHole_RegionEnabled(GoSurfaceHole tool);
1483 
1484 /**
1485  * Sets the enabled state of the tool region.
1486  *
1487  * @public @memberof GoSurfaceHole
1488  * @note Supported with G2, G3
1489  * @version Introduced in firmware 4.0.10.27
1490  * @param tool GoSurfaceHole object.
1491  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1492  * @return Operation status.
1493  */
1494 GoFx(kStatus) GoSurfaceHole_EnableRegion(GoSurfaceHole tool, kBool enable);
1495 
1496 /**
1497  * Returns the tool's region object.
1498  *
1499  * @public @memberof GoSurfaceHole
1500  * @note Supported with G2, G3
1501  * @version Introduced in firmware 4.0.10.27
1502  * @param tool GoSurfaceHole object.
1503  * @return A GoRegion3d object.
1504  */
1505 GoFx(GoRegion3d) GoSurfaceHole_Region(GoSurfaceHole tool);
1506 
1507 /**
1508  * Gets the enabled state of reference regions.
1509  *
1510  * @public @memberof GoSurfaceHole
1511  * @note Supported with G2, G3
1512  * @version Introduced in firmware 4.0.10.27
1513  * @param tool GoSurfaceHole object.
1514  * @return kTRUE if enabled and kFALSE if disabled.
1515  */
1516 GoFx(kBool) GoSurfaceHole_RefRegionsEnabled(GoSurfaceHole tool);
1517 
1518 /**
1519  * Sets the enabled state of reference regions.
1520  *
1521  * @public @memberof GoSurfaceHole
1522  * @note Supported with G2, G3
1523  * @version Introduced in firmware 4.0.10.27
1524  * @param tool GoSurfaceHole object.
1525  * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1526  * @return Operation status.
1527  */
1528 GoFx(kStatus) GoSurfaceHole_EnableRefRegions(GoSurfaceHole tool, kBool enable);
1529 
1530 /**
1531  * Gets the reference region count.
1532  *
1533  * @public @memberof GoSurfaceHole
1534  * @note Supported with G2, G3
1535  * @version Introduced in firmware 4.0.10.27
1536  * @param tool GoSurfaceHole object.
1537  * @return The reference region count.
1538  */
1539 GoFx(kSize) GoSurfaceHole_RefRegionCount(GoSurfaceHole tool);
1540 
1541 /**
1542  * Sets the reference region count.
1543  *
1544  * @public @memberof GoSurfaceHole
1545  * @note Supported with G2, G3
1546  * @version Introduced in firmware 4.0.10.27
1547  * @param tool GoSurfaceHole object.
1548  * @param count The reference region count.
1549  * @return Operation status.
1550  * @see GO_SURFACE_HOLE_MAX_REF_REGIONS
1551  */
1552 GoFx(kStatus) GoSurfaceHole_SetRefRegionCount(GoSurfaceHole tool, kSize count);
1553 
1554 /**
1555  * Gets a reference region object at the given index.
1556  *
1557  * @public @memberof GoSurfaceHole
1558  * @note Supported with G2, G3
1559  * @version Introduced in firmware 4.0.10.27
1560  * @param tool GoSurfaceHole object.
1561  * @param index The index with which to retrieve a reference region.
1562  * @return A GoSurfaceRegion2d object.
1563  * @see GoSurfaceHole_RefRegionCount
1564  */
1565 GoFx(GoSurfaceRegion2d) GoSurfaceHole_RefRegionAt(GoSurfaceHole tool, kSize index);
1566 
1567 /**
1568  * Gets the enabled state of auto-tilt.
1569  *
1570  * @public @memberof GoSurfaceHole
1571  * @note Supported with G2, G3
1572  * @version Introduced in firmware 4.0.10.27
1573  * @param tool GoSurfaceHole object.
1574  * @return kTRUE if enabled and kFALSE if disabled.
1575  */
1576 GoFx(kBool) GoSurfaceHole_AutoTiltEnabled(GoSurfaceHole tool);
1577 
1578 /**
1579  * Sets the enabled state of auto-tilt.
1580  *
1581  * @public @memberof GoSurfaceHole
1582  * @note Supported with G2, G3
1583  * @version Introduced in firmware 4.0.10.27
1584  * @param tool GoSurfaceHole object.
1585  * @param enable kTRUE to enable it and kFALSE to disable it.
1586  * @return Operation status.
1587  */
1588 GoFx(kStatus) GoSurfaceHole_EnableAutoTilt(GoSurfaceHole tool, kBool enable);
1589 
1590 /**
1591  * Gets the tilt X-angle value.
1592  *
1593  * @public @memberof GoSurfaceHole
1594  * @note Supported with G2, G3
1595  * @version Introduced in firmware 4.0.10.27
1596  * @param tool GoSurfaceHole object.
1597  * @return Tilt X-angle value.
1598  */
1599 GoFx(k64f) GoSurfaceHole_TiltXAngle(GoSurfaceHole tool);
1600 
1601 /**
1602  * Sets the tilt X-angle value.
1603  *
1604  * @public @memberof GoSurfaceHole
1605  * @note Supported with G2, G3
1606  * @version Introduced in firmware 4.0.10.27
1607  * @param tool GoSurfaceHole object.
1608  * @param value The tilt X-angle value to set.
1609  * @return Operation status.
1610  */
1611 GoFx(kStatus) GoSurfaceHole_SetTiltXAngle(GoSurfaceHole tool, k64f value);
1612 
1613 /**
1614  * Gets the tilt Y-angle value.
1615  *
1616  * @public @memberof GoSurfaceHole
1617  * @note Supported with G2, G3
1618  * @version Introduced in firmware 4.0.10.27
1619  * @param tool GoSurfaceHole object.
1620  * @return Tilt Y-angle value.
1621  */
1622 GoFx(k64f) GoSurfaceHole_TiltYAngle(GoSurfaceHole tool);
1623 
1624 /**
1625  * Sets the tilt Y-angle value.
1626  *
1627  * @public @memberof GoSurfaceHole
1628  * @note Supported with G2, G3
1629  * @version Introduced in firmware 4.0.10.27
1630  * @param tool GoSurfaceHole object.
1631  * @param value The tilt Y-angle value to set.
1632  * @return Operation status.
1633  */
1634 GoFx(kStatus) GoSurfaceHole_SetTiltYAngle(GoSurfaceHole tool, k64f value);
1635 
1636 /**
1637  * Gets the enabled state of the depth limit.
1638  *
1639  * @public @memberof GoSurfaceHole
1640  * @note Supported with G2, G3
1641  * @version Introduced in firmware 4.3.3.124
1642  * @param tool GoSurfaceHole object.
1643  * @return kTRUE if enabled and kFALSE if disabled.
1644  */
1645 GoFx(kBool) GoSurfaceHole_DepthLimitEnabled(GoSurfaceHole tool);
1646 
1647 /**
1648  * Sets the enabled state of the depth limit.
1649  *
1650  * @public @memberof GoSurfaceHole
1651  * @note Supported with G2, G3
1652  * @version Introduced in firmware 4.3.3.124
1653  * @param tool GoSurfaceHole object.
1654  * @param enable kTRUE to enable it and kFALSE to disable it.
1655  * @return Operation status.
1656  */
1657 GoFx(kStatus) GoSurfaceHole_EnableDepthLimit(GoSurfaceHole tool, kBool enable);
1658 
1659 /**
1660  * Gets the depth limit value.
1661  *
1662  * @public @memberof GoSurfaceHole
1663  * @note Supported with G2, G3
1664  * @version Introduced in firmware 4.3.3.124
1665  * @param tool GoSurfaceHole object.
1666  * @return Depth limit value.
1667 
1668  */
1669 GoFx(k64f) GoSurfaceHole_DepthLimit(GoSurfaceHole tool);
1670 
1671 /**
1672  * Sets the depth limit value.
1673  *
1674  * @public @memberof GoSurfaceHole
1675  * @note Supported with G2, G3
1676  * @version Introduced in firmware 4.3.3.124
1677  * @param tool GoSurfaceHole object.
1678  * @param value The depth limit value to set.
1679  * @return Operation status.
1680  * @see GoSurfaceHole_DepthLimitEnabled, GoSurfaceHole_EnableDepthLimit
1681  */
1682 GoFx(kStatus) GoSurfaceHole_SetDepthLimit(GoSurfaceHole tool, k64f value);
1683 
1684 /**
1685  * Returns a GoSurfaceHole X measurement object.
1686  *
1687  * @public @memberof GoSurfaceHole
1688  * @note Supported with G2, G3
1689  * @version Introduced in firmware 4.0.10.27
1690  * @param tool GoSurfaceHole object.
1691  * @return A GoSurfaceHoleX X measurement.
1692  */
1693 GoFx(GoSurfaceHoleX) GoSurfaceHole_XMeasurement(GoSurfaceHole tool);
1694 
1695 /**
1696  * Returns a GoSurfaceHole Y measurement object.
1697  *
1698  * @public @memberof GoSurfaceHole
1699  * @note Supported with G2, G3
1700  * @version Introduced in firmware 4.0.10.27
1701  * @param tool GoSurfaceHole object.
1702  * @return A GoSurfaceHoleY Y measurement.
1703  */
1704 GoFx(GoSurfaceHoleY) GoSurfaceHole_YMeasurement(GoSurfaceHole tool);
1705 
1706 /**
1707  * Returns a GoSurfaceHole Z measurement object.
1708  *
1709  * @public @memberof GoSurfaceHole
1710  * @note Supported with G2, G3
1711  * @version Introduced in firmware 4.0.10.27
1712  * @param tool GoSurfaceHole object.
1713  * @return A GoSurfaceHoleZ Z measurement.
1714  */
1715 GoFx(GoSurfaceHoleZ) GoSurfaceHole_ZMeasurement(GoSurfaceHole tool);
1716 
1717 /**
1718  * Returns a GoSurfaceHole Radius measurement object.
1719  *
1720  * @public @memberof GoSurfaceHole
1721  * @note Supported with G2, G3
1722  * @version Introduced in firmware 4.0.10.27
1723  * @param tool GoSurfaceHole object.
1724  * @return A GoSurfaceHoleRadius Radius measurement.
1725  */
1726 GoFx(GoSurfaceHoleRadius) GoSurfaceHole_RadiusMeasurement(GoSurfaceHole tool);
1727 
1728 /**
1729 * Returns a GoSurfaceHole point feature object.
1730 *
1731 * @public @memberof GoSurfaceHole
1732 * @note Supported with G2, G3
1733 * @version Introduced in firmware 4.0.10.27
1734 * @param tool GoSurfaceHole object.
1735 * @return A GoSurfaceHoleCenterPoint point feature.
1736 */
1737 GoFx(GoSurfaceHoleCenterPoint) GoSurfaceHole_Point(GoSurfaceHole tool);
1738 
1739 
1740 /**
1741  * @class GoSurfaceOpening
1742  * @extends GoSurfaceTool
1743  * @note Supported with G2, G3
1744  * @ingroup GoSdk-SurfaceTools
1745  * @brief Represents a surface opening tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1746  */
1748 
1749 GoFx(kStatus) GoSurfaceOpening_SetType(GoSurfaceOpening tool, GoSurfaceOpeningType type);
1750 
1751 /**
1752  * Gets the surface opening type.
1753  *
1754  * @public @memberof GoSurfaceOpening
1755  * @note Supported with G2, G3
1756  * @version Introduced in firmware 4.0.10.27
1757  * @param tool GoSurfaceOpening object.
1758  * @return The surface opening type.
1759  */
1760 GoFx(GoSurfaceOpeningType) GoSurfaceOpening_Type(GoSurfaceOpening tool);
1761 
1762 /**
1763  * Gets the nominal width.
1764  *
1765  * @public @memberof GoSurfaceOpening
1766  * @note Supported with G2, G3
1767  * @version Introduced in firmware 4.0.10.27
1768  * @param tool GoSurfaceOpening object.
1769  * @return The nominal width (in mm).
1770  */
1771 GoFx(k64f) GoSurfaceOpening_NominalWidth(GoSurfaceOpening tool);
1772 
1773 /**
1774  * Sets the nominal width.
1775  *
1776  * @public @memberof GoSurfaceOpening
1777  * @note Supported with G2, G3
1778  * @version Introduced in firmware 4.0.10.27
1779  * @param tool GoSurfaceOpening object.
1780  * @param value The nominal width to set (in mm).
1781  * @return Operation status.
1782  */
1783 GoFx(kStatus) GoSurfaceOpening_SetNominalWidth(GoSurfaceOpening tool, k64f value);
1784 
1785 /**
1786  * Gets the nominal length.
1787  *
1788  * @public @memberof GoSurfaceOpening
1789  * @note Supported with G2, G3
1790  * @version Introduced in firmware 4.0.10.27
1791  * @param tool GoSurfaceOpening object.
1792  * @return The nominal length (in mm).
1793  */
1794 GoFx(k64f) GoSurfaceOpening_NominalLength(GoSurfaceOpening tool);
1795 
1796 /**
1797  * Sets the nominal length.
1798  *
1799  * @public @memberof GoSurfaceOpening
1800  * @note Supported with G2, G3
1801  * @version Introduced in firmware 4.0.10.27
1802  * @param tool GoSurfaceOpening object.
1803  * @param value The nominal length to set (in mm).
1804  * @return Operation status.
1805  */
1806 GoFx(kStatus) GoSurfaceOpening_SetNominalLength(GoSurfaceOpening tool, k64f value);
1807 
1808 /**
1809  * Gets the nominal angle.
1810  *
1811  * @public @memberof GoSurfaceOpening
1812  * @note Supported with G2, G3
1813  * @version Introduced in firmware 4.0.10.27
1814  * @param tool GoSurfaceOpening object.
1815  * @return The nominal angle (in degrees).
1816  */
1817 GoFx(k64f) GoSurfaceOpening_NominalAngle(GoSurfaceOpening tool);
1818 
1819 /**
1820  * Sets the nominal angle.
1821  *
1822  * @public @memberof GoSurfaceOpening
1823  * @note Supported with G2, G3
1824  * @version Introduced in firmware 4.0.10.27
1825  * @param tool GoSurfaceOpening object.
1826  * @param value The nominal angle to set (in degrees).
1827  * @return Operation status.
1828  */
1829 GoFx(kStatus) GoSurfaceOpening_SetNominalAngle(GoSurfaceOpening tool, k64f value);
1830 
1831 /**
1832  * Gets the nominal radius.
1833  *
1834  * @public @memberof GoSurfaceOpening
1835  * @note Supported with G2, G3
1836  * @version Introduced in firmware 4.0.10.27
1837  * @param tool GoSurfaceOpening object.
1838  * @return The nominal radius (in mm).
1839  */
1840 GoFx(k64f) GoSurfaceOpening_NominalRadius(GoSurfaceOpening tool);
1841 
1842 /**
1843  * Sets the nominal radius.
1844  *
1845  * @public @memberof GoSurfaceOpening
1846  * @note Supported with G2, G3
1847  * @version Introduced in firmware 4.0.10.27
1848  * @param tool GoSurfaceOpening object.
1849  * @param value The nominal radius to set (in mm).
1850  * @return Operation status.
1851  */
1852 GoFx(kStatus) GoSurfaceOpening_SetNominalRadius(GoSurfaceOpening tool, k64f value);
1853 
1854 /**
1855  * Gets the width tolerance.
1856  *
1857  * @public @memberof GoSurfaceOpening
1858  * @note Supported with G2, G3
1859  * @version Introduced in firmware 4.0.10.27
1860  * @param tool GoSurfaceOpening object.
1861  * @return The width tolerance (in mm).
1862  */
1863 GoFx(k64f) GoSurfaceOpening_WidthTolerance(GoSurfaceOpening tool);
1864 
1865 /**
1866  * Sets the width tolerance.
1867  *
1868  * @public @memberof GoSurfaceOpening
1869  * @note Supported with G2, G3
1870  * @version Introduced in firmware 4.0.10.27
1871  * @param tool GoSurfaceOpening object.
1872  * @param value The width tolerance to set (in mm).
1873  * @return Operation status.
1874  */
1875 GoFx(kStatus) GoSurfaceOpening_SetWidthTolerance(GoSurfaceOpening tool, k64f value);
1876 
1877 /**
1878  * Gets the length tolerance.
1879  *
1880  * @public @memberof GoSurfaceOpening
1881  * @note Supported with G2, G3
1882  * @version Introduced in firmware 4.0.10.27
1883  * @param tool GoSurfaceOpening object.
1884  * @return The length tolerance (in mm).
1885  */
1886 GoFx(k64f) GoSurfaceOpening_LengthTolerance(GoSurfaceOpening tool);
1887 
1888 /**
1889  * Sets the length tolerance.
1890  *
1891  * @public @memberof GoSurfaceOpening
1892  * @note Supported with G2, G3
1893  * @version Introduced in firmware 4.0.10.27
1894  * @param tool GoSurfaceOpening object.
1895  * @param value The length tolerance to set (in mm).
1896  * @return Operation status.
1897  */
1898 GoFx(kStatus) GoSurfaceOpening_SetLengthTolerance(GoSurfaceOpening tool, k64f value);
1899 
1900 /**
1901  * Gets the angle tolerance.
1902  *
1903  * @public @memberof GoSurfaceOpening
1904  * @note Supported with G2, G3
1905  * @version Introduced in firmware 4.0.10.27
1906  * @param tool GoSurfaceOpening object.
1907  * @return The angle tolerance (in degrees).
1908  */
1909 GoFx(k64f) GoSurfaceOpening_AngleTolerance(GoSurfaceOpening tool);
1910 
1911 /**
1912  * Sets the angle tolerance.
1913  *
1914  * @public @memberof GoSurfaceOpening
1915  * @note Supported with G2, G3
1916  * @version Introduced in firmware 4.0.10.27
1917  * @param tool GoSurfaceOpening object.
1918  * @param value The angle tolerance to set (in degrees).
1919  * @return Operation status.
1920  */
1921 GoFx(kStatus) GoSurfaceOpening_SetAngleTolerance(GoSurfaceOpening tool, k64f value);
1922 
1923 /**
1924  * Gets the enabled state of partial detection.
1925  *
1926  * @public @memberof GoSurfaceOpening
1927  * @note Supported with G2, G3
1928  * @version Introduced in firmware 4.0.10.27
1929  * @param tool GoSurfaceOpening object.
1930  * @return kTRUE if partial detection is enabled and kFALSE otherwise.
1931  */
1932 GoFx(kBool) GoSurfaceOpening_PartialDetectionEnabled(GoSurfaceOpening tool);
1933 
1934 /**
1935  * Sets the enabled state of partial detection.
1936  *
1937  * @public @memberof GoSurfaceOpening
1938  * @note Supported with G2, G3
1939  * @version Introduced in firmware 4.0.10.27
1940  * @param tool GoSurfaceOpening object.
1941  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1942  * @return Operation status.
1943  */
1944 GoFx(kStatus) GoSurfaceOpening_EnablePartialDetection(GoSurfaceOpening tool, kBool enable);
1945 
1946 /**
1947  * Gets the enabled state of the tool region.
1948  *
1949  * @public @memberof GoSurfaceOpening
1950  * @note Supported with G2, G3
1951  * @version Introduced in firmware 4.0.10.27
1952  * @param tool GoSurfaceOpening object.
1953  * @return kTRUE if the tool region is enabled and kFALSE otherwise.
1954  */
1955 GoFx(kBool) GoSurfaceOpening_RegionEnabled(GoSurfaceOpening tool);
1956 
1957 /**
1958  * Sets the enabled state of the tool region.
1959  *
1960  * @public @memberof GoSurfaceOpening
1961  * @note Supported with G2, G3
1962  * @version Introduced in firmware 4.0.10.27
1963  * @param tool GoSurfaceOpening object.
1964  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1965  * @return Operation status.
1966  */
1967 GoFx(kStatus) GoSurfaceOpening_EnableRegion(GoSurfaceOpening tool, kBool enable);
1968 
1969 /**
1970  * Returns the region object for the tool.
1971  *
1972  * @public @memberof GoSurfaceOpening
1973  * @note Supported with G2, G3
1974  * @version Introduced in firmware 4.0.10.27
1975  * @param tool GoSurfaceOpening object.
1976  * @return A GoRegion3d object.
1977  */
1978 GoFx(GoRegion3d) GoSurfaceOpening_Region(GoSurfaceOpening tool);
1979 
1980 /**
1981  * Gets the enabled state of reference regions.
1982  *
1983  * @public @memberof GoSurfaceOpening
1984  * @note Supported with G2, G3
1985  * @version Introduced in firmware 4.0.10.27
1986  * @param tool GoSurfaceOpening object.
1987  * @return kTRUE if reference regions are enabled and kFALSE otherwise.
1988  */
1989 GoFx(kBool) GoSurfaceOpening_RefRegionsEnabled(GoSurfaceOpening tool);
1990 
1991 /**
1992  * Sets the enabled state of reference regions.
1993  *
1994  * @public @memberof GoSurfaceOpening
1995  * @note Supported with G2, G3
1996  * @version Introduced in firmware 4.0.10.27
1997  * @param tool GoSurfaceOpening object.
1998  * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1999  * @return Operation status.
2000  */
2001 GoFx(kStatus) GoSurfaceOpening_EnableRefRegions(GoSurfaceOpening tool, kBool enable);
2002 
2003 /**
2004  * Gets the reference region count.
2005  *
2006  * @public @memberof GoSurfaceOpening
2007  * @note Supported with G2, G3
2008  * @version Introduced in firmware 4.0.10.27
2009  * @param tool GoSurfaceOpening object.
2010  * @return The count of reference regions.
2011  */
2012 GoFx(kSize) GoSurfaceOpening_RefRegionCount(GoSurfaceOpening tool);
2013 
2014 /**
2015  * Sets the reference region count.
2016  *
2017  * @public @memberof GoSurfaceOpening
2018  * @note Supported with G2, G3
2019  * @version Introduced in firmware 4.0.10.27
2020  * @param tool GoSurfaceOpening object.
2021  * @param count The reference region count to set.
2022  * @return Operation status.
2023  * @see GO_SURFACE_OPENING_MAX_REF_REGIONS
2024  */
2025 GoFx(kStatus) GoSurfaceOpening_SetRefRegionCount(GoSurfaceOpening tool, kSize count);
2026 
2027 /**
2028  * Gets the reference region object at the specified index.
2029  *
2030  * @public @memberof GoSurfaceOpening
2031  * @note Supported with G2, G3
2032  * @version Introduced in firmware 4.0.10.27
2033  * @param tool GoSurfaceOpening object.
2034  * @param index The index with which to retrieve a reference region.
2035  * @return A GoSurfaceRegion2d object or kNULL if the index is invalid.
2036  * @see GoSurfaceOpening_RefRegionCount
2037  */
2038 GoFx(GoSurfaceRegion2d) GoSurfaceOpening_RefRegionAt(GoSurfaceOpening tool, kSize index);
2039 
2040 /**
2041  * Gets the enabled state of auto-tilt.
2042  *
2043  * @public @memberof GoSurfaceOpening
2044  * @note Supported with G2, G3
2045  * @version Introduced in firmware 4.0.10.27
2046  * @param tool GoSurfaceOpening object.
2047  * @return kTRUE if auto-tilt is enabled and kFALSE otherwise.
2048  */
2049 GoFx(kBool) GoSurfaceOpening_AutoTiltEnabled(GoSurfaceOpening tool);
2050 
2051 /**
2052  * Sets the enabled state of auto-tilt.
2053  *
2054  * @public @memberof GoSurfaceOpening
2055  * @note Supported with G2, G3
2056  * @version Introduced in firmware 4.0.10.27
2057  * @param tool GoSurfaceOpening object.
2058  * @param enable kTRUE to enable auto-tilt and kFALSE to disable it.
2059  * @return Operation status.
2060  */
2061 GoFx(kStatus) GoSurfaceOpening_EnableAutoTilt(GoSurfaceOpening tool, kBool enable);
2062 
2063 /**
2064  * Gets the tilt X-angle.
2065  *
2066  * @public @memberof GoSurfaceOpening
2067  * @note Supported with G2, G3
2068  * @version Introduced in firmware 4.0.10.27
2069  * @param tool GoSurfaceOpening object.
2070  * @return The tilt X-angle.
2071  */
2072 GoFx(k64f) GoSurfaceOpening_TiltXAngle(GoSurfaceOpening tool);
2073 
2074 /**
2075  * Sets the tilt X-angle.
2076  *
2077  * @public @memberof GoSurfaceOpening
2078  * @note Supported with G2, G3
2079  * @version Introduced in firmware 4.0.10.27
2080  * @param tool GoSurfaceOpening object.
2081  * @param value The tilt X-angle to set.
2082  * @return Operation status.
2083  */
2084 GoFx(kStatus) GoSurfaceOpening_SetTiltXAngle(GoSurfaceOpening tool, k64f value);
2085 
2086 /**
2087  * Gets the tilt Y-angle.
2088  *
2089  * @public @memberof GoSurfaceOpening
2090  * @note Supported with G2, G3
2091  * @version Introduced in firmware 4.0.10.27
2092  * @param tool GoSurfaceOpening object.
2093  * @return The tilt Y-angle.
2094  */
2095 GoFx(k64f) GoSurfaceOpening_TiltYAngle(GoSurfaceOpening tool);
2096 
2097 /**
2098  * Sets the tilt Y-angle.
2099  *
2100  * @public @memberof GoSurfaceOpening
2101  * @note Supported with G2, G3
2102  * @version Introduced in firmware 4.0.10.27
2103  * @param tool GoSurfaceOpening object.
2104  * @param value The tilt Y-angle to set.
2105  * @return Operation status.
2106  */
2107 GoFx(kStatus) GoSurfaceOpening_SetTiltYAngle(GoSurfaceOpening tool, k64f value);
2108 
2109 /**
2110  * Gets the enabled state of the depth limit.
2111  *
2112  * @public @memberof GoSurfaceOpening
2113  * @note Supported with G2, G3
2114  * @version Introduced in firmware 4.3.3.124
2115  * @param tool GoSurfaceOpening object.
2116  * @return kTRUE if enabled and kFALSE if disabled.
2117  */
2118 GoFx(kBool) GoSurfaceOpening_DepthLimitEnabled(GoSurfaceOpening tool);
2119 
2120 /**
2121  * Sets the enabled state of the depth limit.
2122  *
2123  * @public @memberof GoSurfaceOpening
2124  * @note Supported with G2, G3
2125  * @version Introduced in firmware 4.3.3.124
2126  * @param tool GoSurfaceOpening object.
2127  * @param enable kTRUE to enable it and kFALSE to disable it.
2128  * @return Operation status.
2129  */
2130 GoFx(kStatus) GoSurfaceOpening_EnableDepthLimit(GoSurfaceOpening tool, kBool enable);
2131 
2132 /**
2133  * Gets the depth limit value.
2134  *
2135  * @public @memberof GoSurfaceOpening
2136  * @note Supported with G2, G3
2137  * @version Introduced in firmware 4.3.3.124
2138  * @param tool GoSurfaceOpening object.
2139  * @return Depth limit value.
2140 
2141  */
2142 GoFx(k64f) GoSurfaceOpening_DepthLimit(GoSurfaceOpening tool);
2143 
2144 /**
2145  * Sets the depth limit value.
2146  *
2147  * @public @memberof GoSurfaceOpening
2148  * @note Supported with G2, G3
2149  * @version Introduced in firmware 4.3.3.124
2150  * @param tool GoSurfaceOpening object.
2151  * @param value The depth limit value to set.
2152  * @return Operation status.
2153  * @see GoSurfaceOpening_DepthLimitEnabled, GoSurfaceOpening_EnableDepthLimit
2154  */
2155 GoFx(kStatus) GoSurfaceOpening_SetDepthLimit(GoSurfaceOpening tool, k64f value);
2156 
2157 
2158 /**
2159  * Returns a GoSurfaceOpening X measurement object.
2160  *
2161  * @public @memberof GoSurfaceOpening
2162  * @note Supported with G2, G3
2163  * @version Introduced in firmware 4.0.10.27
2164  * @param tool GoSurfaceOpening object.
2165  * @return A GoSurfaceOpeningX X measurement.
2166  */
2167 GoFx(GoSurfaceOpeningX) GoSurfaceOpening_XMeasurement(GoSurfaceOpening tool);
2168 
2169 /**
2170  * Returns a GoSurfaceOpening Y measurement object.
2171  *
2172  * @public @memberof GoSurfaceOpening
2173  * @note Supported with G2, G3
2174  * @version Introduced in firmware 4.0.10.27
2175  * @param tool GoSurfaceOpening object.
2176  * @return A GoSurfaceOpeningY Y measurement.
2177  */
2178 GoFx(GoSurfaceOpeningY) GoSurfaceOpening_YMeasurement(GoSurfaceOpening tool);
2179 
2180 /**
2181  * Returns a GoSurfaceOpening Z measurement object.
2182  *
2183  * @public @memberof GoSurfaceOpening
2184  * @note Supported with G2, G3
2185  * @version Introduced in firmware 4.0.10.27
2186  * @param tool GoSurfaceOpening object.
2187  * @return A GoSurfaceOpening Z measurement.
2188  */
2189 GoFx(GoSurfaceOpeningZ) GoSurfaceOpening_ZMeasurement(GoSurfaceOpening tool);
2190 
2191 /**
2192  * Returns a GoSurfaceOpening Width measurement object.
2193  *
2194  * @public @memberof GoSurfaceOpening
2195  * @note Supported with G2, G3
2196  * @version Introduced in firmware 4.0.10.27
2197  * @param tool GoSurfaceOpening object.
2198  * @return A GoSurfaceOpeningWidth Width measurement.
2199  */
2200 GoFx(GoSurfaceOpeningWidth) GoSurfaceOpening_WidthMeasurement(GoSurfaceOpening tool);
2201 
2202 /**
2203  * Returns a GoSurfaceOpening Length measurement object.
2204  *
2205  * @public @memberof GoSurfaceOpening
2206  * @note Supported with G2, G3
2207  * @version Introduced in firmware 4.0.10.27
2208  * @param tool GoSurfaceOpening object.
2209  * @return A GoSurfaceOpeningLength Length measurement.
2210  */
2211 GoFx(GoSurfaceOpeningLength) GoSurfaceOpening_LengthMeasurement(GoSurfaceOpening tool);
2212 
2213 /**
2214  * Returns a GoSurfaceOpening Angle measurement object.
2215  *
2216  * @public @memberof GoSurfaceOpening
2217  * @note Supported with G2, G3
2218  * @version Introduced in firmware 4.0.10.27
2219  * @param tool GoSurfaceOpening object.
2220  * @return A GoSurfaceOpeningAngle Angle measurement.
2221  */
2222 GoFx(GoSurfaceOpeningAngle) GoSurfaceOpening_AngleMeasurement(GoSurfaceOpening tool);
2223 
2224 /**
2225 * Returns a GoSurfaceOpening center point feature object.
2226 *
2227 * @public @memberof GoSurfaceOpening
2228 * @note Supported with G2, G3
2229 * @version Introduced in firmware 4.0.10.27
2230 * @param tool GoSurfaceOpening object.
2231 * @return A GoSurfaceOpeningCenterPoint center point feature.
2232 */
2234 
2235 /**
2236  * @class GoSurfacePlane
2237  * @extends GoSurfaceTool
2238  * @note Supported with G2, G3
2239  * @ingroup GoSdk-SurfaceTools
2240  * @brief Represents a surface plane tool.all width/height/length/radius and x/y/z units are in mm, angles in degrees
2241  */
2242 typedef GoSurfaceTool GoSurfacePlane;
2243 
2244 /**
2245  * Gets the enabled state of the reference regions.
2246  *
2247  * @public @memberof GoSurfacePlane
2248  * @note Supported with G2, G3
2249  * @version Introduced in firmware 4.0.10.27
2250  * @param tool GoSurfacePlane object.
2251  * @return kTRUE if the tool region is enabled and kFALSE otherwise.
2252  */
2253 GoFx(kBool) GoSurfacePlane_RegionsEnabled(GoSurfacePlane tool);
2254 
2255 /**
2256  * Sets the enabled state of the reference regions.
2257  *
2258  * @public @memberof GoSurfacePlane
2259  * @note Supported with G2, G3
2260  * @version Introduced in firmware 4.0.10.27
2261  * @param tool GoSurfacePlane object.
2262  * @param enable kTRUE to enable regions and kFALSE to disable them.
2263  * @return Operation status.
2264  */
2265 GoFx(kStatus) GoSurfacePlane_EnableRegions(GoSurfacePlane tool, kBool enable);
2266 
2267 /**
2268  * Gets the tool's region count.
2269  *
2270  * @public @memberof GoSurfacePlane
2271  * @note Supported with G2, G3
2272  * @version Introduced in firmware 4.0.10.27
2273  * @param tool GoSurfacePlane object.
2274  * @return The number of regions in the tool.
2275  */
2276 GoFx(kSize) GoSurfacePlane_RegionCount(GoSurfacePlane tool);
2277 
2278 /**
2279  * Sets the tool region count.
2280  *
2281  * @public @memberof GoSurfacePlane
2282  * @note Supported with G2, G3
2283  * @version Introduced in firmware 4.0.10.27
2284  * @param tool GoSurfacePlane object.
2285  * @param count The region count to set.
2286  * @return Operation status.
2287  */
2288 GoFx(kStatus) GoSurfacePlane_SetRegionCount(GoSurfacePlane tool, kSize count);
2289 
2290 /**
2291  * Gets a region at the specified index.
2292  *
2293  * @public @memberof GoSurfacePlane
2294  * @note Supported with G2, G3
2295  * @version Introduced in firmware 4.0.10.27
2296  * @param tool GoSurfacePlane object.
2297  * @param index The index with which to return a tool region.
2298  * @return A GoRegion3d object or kNULL if the index is in invalid.
2299  * @see GoSurfacePlane_RegionCount
2300  */
2301 GoFx(GoRegion3d) GoSurfacePlane_RegionAt(GoSurfacePlane tool, kSize index);
2302 
2303 /**
2304  * Returns a GoSurfacePlane X Angle measurement object.
2305  *
2306  * @public @memberof GoSurfacePlane
2307  * @note Supported with G2, G3
2308  * @version Introduced in firmware 4.0.10.27
2309  * @param tool GoSurfacePlane object.
2310  * @return A GoSurfacePlaneXAngle X Angle measurement.
2311  */
2312 GoFx(GoSurfacePlaneXAngle) GoSurfacePlane_XAngleMeasurement(GoSurfacePlane tool);
2313 
2314 /**
2315  * Returns a GoSurfacePlane Y Angle measurement object.
2316  *
2317  * @public @memberof GoSurfacePlane
2318  * @note Supported with G2, G3
2319  * @version Introduced in firmware 4.0.10.27
2320  * @param tool GoSurfacePlane object.
2321  * @return A GoSurfacePlaneYAngle Y Angle measurement.
2322  */
2323 GoFx(GoSurfacePlaneYAngle) GoSurfacePlane_YAngleMeasurement(GoSurfacePlane tool);
2324 
2325 /**
2326  * Returns a GoSurfacePlane Z Offset measurement object.
2327  *
2328  * @public @memberof GoSurfacePlane
2329  * @note Supported with G2, G3
2330  * @version Introduced in firmware 4.0.10.27
2331  * @param tool GoSurfacePlane object.
2332  * @return A GoSurfacePlaneZOffset Z Offset measurement.
2333  */
2334 GoFx(GoSurfacePlaneZOffset) GoSurfacePlane_ZOffsetMeasurement(GoSurfacePlane tool);
2335 
2336 /**
2337  * Returns a GoSurfacePlane Standard Deviation measurement object.
2338  *
2339  * @public @memberof GoSurfacePlane
2340  * @note Supported with G2, G3
2341  * @version Introduced in firmware 4.4.4.14
2342  * @param tool GoSurfacePlane object.
2343  * @return A GoSurfacePlane Standard Deviation measurement.
2344  */
2345 GoFx(GoSurfacePlaneStdDev) GoSurfacePlane_StdDevMeasurement(GoSurfacePlane tool);
2346 
2347 /**
2348  * Returns a GoSurfacePlane Minimum Error measurement object.
2349  *
2350  * @public @memberof GoSurfacePlane
2351  * @note Supported with G2, G3
2352  * @version Introduced in firmware 4.4.4.14
2353  * @param tool GoSurfacePlane object.
2354  * @return A GoSurfacePlaneMinError Minimum Error measurement.
2355  */
2357 
2358 /**
2359  * Returns a GoSurfacePlane Maximum Error measurement object.
2360  *
2361  * @public @memberof GoSurfacePlane
2362  * @note Supported with G2, G3
2363  * @version Introduced in firmware 4.4.4.14
2364  * @param tool GoSurfacePlane object.
2365  * @return A GoSurfacePlaneMaxError Maximum Error measurement.
2366  */
2368 
2369 /**
2370 * Returns a GoSurfacePlane X Normal measurement object.
2371 *
2372 * @public @memberof GoSurfacePlane
2373 * @note Supported with G2, G3
2374 * @version Introduced in firmware 4.6.0.49
2375 * @param tool GoSurfacePlane object.
2376 * @return A GoSurfacePlaneXNormal X Normal measurement.
2377 */
2378 GoFx(GoSurfacePlaneXNormal) GoSurfacePlane_XNormalMeasurement(GoSurfacePlane tool);
2379 /**
2380 * Returns a GoSurfacePlane Y Normal measurement object.
2381 *
2382 * @public @memberof GoSurfacePlane
2383 * @note Supported with G2, G3
2384 * @version Introduced in firmware 4.6.0.49
2385 * @param tool GoSurfacePlane object.
2386 * @return A GoSurfacePlane Y Normal measurement.
2387 */
2388 GoFx(GoSurfacePlaneYNormal) GoSurfacePlane_YNormalMeasurement(GoSurfacePlane tool);
2389 /**
2390 * Returns a GoSurfacePlane X Normal measurement object.
2391 *
2392 * @public @memberof GoSurfacePlane
2393 * @note Supported with G2, G3
2394 * @version Introduced in firmware 4.6.0.49
2395 * @param tool GoSurfacePlane object.
2396 * @return A GoSurfacePlane X Normal measurement.
2397 */
2398 GoFx(GoSurfacePlaneZNormal) GoSurfacePlane_ZNormalMeasurement(GoSurfacePlane tool);
2399 /**
2400 * Returns a GoSurfacePlane Distance measurement object.
2401 *
2402 * @public @memberof GoSurfacePlane
2403 * @note Supported with G2, G3
2404 * @version Introduced in firmware 4.6.0.49
2405 * @param tool GoSurfacePlane object.
2406 * @return A GoSurfacePlaneDistance Distance measurement.
2407 */
2409 
2410 /**
2411 * Returns a GoSurfacePlane plane feature object.
2412 *
2413 * @public @memberof GoSurfacePlane
2414 * @note Supported with G2, G3
2415 * @version Introduced in firmware 4.7.2.x
2416 * @param tool GoSurfacePlane object.
2417 * @return A GoSurfacePlanePlane plane feature.
2418 */
2419 GoFx(GoSurfacePlanePlane) GoSurfacePlane_Plane(GoSurfacePlane tool);
2420 
2421 /**
2422  * @class GoSurfacePosition
2423  * @extends GoSurfaceTool
2424  * @note Supported with G2, G3
2425  * @ingroup GoSdk-SurfaceTools
2426  * @brief Represents a surface position tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
2427  */
2429 
2430 GoFx(GoSurfaceFeature) GoSurfacePosition_Feature(GoSurfacePosition tool);
2431 
2432 /**
2433  * Returns a GoSurfacePosition X measurement object.
2434  *
2435  * @public @memberof GoSurfacePosition
2436  * @note Supported with G2, G3
2437  * @version Introduced in firmware 4.0.10.27
2438  * @param tool GoSurfacePosition object.
2439  * @return A GoSurfacePositionX X measurement.
2440  */
2441 GoFx(GoSurfacePositionX) GoSurfacePosition_XMeasurement(GoSurfacePosition tool);
2442 
2443 /**
2444  * Returns a GoSurfacePosition Y measurement object.
2445  *
2446  * @public @memberof GoSurfacePosition
2447  * @note Supported with G2, G3
2448  * @version Introduced in firmware 4.0.10.27
2449  * @param tool GoSurfacePosition object.
2450  * @return A GoSurfacePosition Y measurement.
2451  */
2452 GoFx(GoSurfacePositionY) GoSurfacePosition_YMeasurement(GoSurfacePosition tool);
2453 
2454 /**
2455  * Returns a GoSurfacePosition Z measurement object.
2456  *
2457  * @public @memberof GoSurfacePosition
2458  * @note Supported with G2, G3
2459  * @version Introduced in firmware 4.0.10.27
2460  * @param tool GoSurfacePosition object.
2461  * @return A GoSurfacePosition Z measurement.
2462  */
2463 GoFx(GoSurfacePositionZ) GoSurfacePosition_ZMeasurement(GoSurfacePosition tool);
2464 
2465 /**
2466 * Returns a GoSurfacePosition point feature object.
2467 *
2468 * @public @memberof GoSurfacePosition
2469 * @note Supported with G2, G3
2470 * @version Introduced in firmware 4.0.10.27
2471 * @param tool GoSurfacePosition object.
2472 * @return A GoSurfacePositionPoint point feature.
2473 */
2474 GoFx(GoSurfacePositionPoint) GoSurfacePosition_Point(GoSurfaceHole tool);
2475 
2476 /**
2477 * @class GoSurfaceRivet
2478 * @extends GoSurfaceTool
2479 * @note Supported with G2, G3
2480 * @ingroup GoSdk-SurfaceTools
2481 * @brief Represents a surface rivet tool.
2482 */
2484 
2485 /**
2486  * @class GoSurfaceStud
2487  * @extends GoSurfaceTool
2488  * @note Supported with G2, G3
2489  * @ingroup GoSdk-SurfaceTools
2490  * @brief Represents a surface stud tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
2491  */
2492 typedef GoSurfaceTool GoSurfaceStud;
2493 
2494 /**
2495  * Returns the stud radius value.
2496  *
2497  * @public @memberof GoSurfaceStud
2498  * @note Supported with G2, G3
2499  * @version Introduced in firmware 4.0.10.27
2500  * @param tool GoSurfaceStud object.
2501  * @return The stud radius value.
2502  */
2503 GoFx(k64f) GoSurfaceStud_StudRadius(GoSurfaceStud tool);
2504 
2505 /**
2506  * Sets the stud radius value.
2507  *
2508  * @public @memberof GoSurfaceStud
2509  * @note Supported with G2, G3
2510  * @version Introduced in firmware 4.0.10.27
2511  * @param tool GoSurfaceStud object.
2512  * @param value The stud radius value to set.
2513  * @return Operation status.
2514  */
2515 GoFx(kStatus) GoSurfaceStud_SetStudRadius(GoSurfaceStud tool, k64f value);
2516 
2517 /**
2518  * Returns the stud height value.
2519  *
2520  * @public @memberof GoSurfaceStud
2521  * @note Supported with G2, G3
2522  * @version Introduced in firmware 4.0.10.27
2523  * @param tool GoSurfaceStud object.
2524  * @return The stud height value.
2525  */
2526 GoFx(k64f) GoSurfaceStud_StudHeight(GoSurfaceStud tool);
2527 
2528 /**
2529  * Sets the stud height value.
2530  *
2531  * @public @memberof GoSurfaceStud
2532  * @note Supported with G2, G3
2533  * @version Introduced in firmware 4.0.10.27
2534  * @param tool GoSurfaceStud object.
2535  * @param value The stud height value to set.
2536  * @return Operation status.
2537  */
2538 GoFx(kStatus) GoSurfaceStud_SetStudHeight(GoSurfaceStud tool, k64f value);
2539 
2540 /**
2541  * Returns the stud base height value.
2542  *
2543  * @public @memberof GoSurfaceStud
2544  * @note Supported with G2, G3
2545  * @version Introduced in firmware 4.0.10.27
2546  * @param tool GoSurfaceStud object.
2547  * @return The stud base height value.
2548  */
2549 GoFx(k64f) GoSurfaceStud_BaseHeight(GoSurfaceStud tool);
2550 
2551 /**
2552  * Sets the base height value.
2553  *
2554  * @public @memberof GoSurfaceStud
2555  * @note Supported with G2, G3
2556  * @version Introduced in firmware 4.0.10.27
2557  * @param tool GoSurfaceStud object.
2558  * @param value The base height value to set.
2559  * @return Operation status.
2560  */
2561 GoFx(kStatus) GoSurfaceStud_SetBaseHeight(GoSurfaceStud tool, k64f value);
2562 
2563 /**
2564  * Returns the stud tip height value.
2565  *
2566  * @public @memberof GoSurfaceStud
2567  * @note Supported with G2, G3
2568  * @version Introduced in firmware 4.0.10.27
2569  * @param tool GoSurfaceStud object.
2570  * @return The stud tip height value.
2571  */
2572 GoFx(k64f) GoSurfaceStud_TipHeight(GoSurfaceStud tool);
2573 
2574 /**
2575  * Sets the tip height value.
2576  *
2577  * @public @memberof GoSurfaceStud
2578  * @note Supported with G2, G3
2579  * @version Introduced in firmware 4.0.10.27
2580  * @param tool GoSurfaceStud object.
2581  * @param value The tip height value to set.
2582  * @return Operation status.
2583  */
2584 GoFx(kStatus) GoSurfaceStud_SetTipHeight(GoSurfaceStud tool, k64f value);
2585 
2586 /**
2587  * Gets the enabled state of the tool region.
2588  *
2589  * @public @memberof GoSurfaceStud
2590  * @note Supported with G2, G3
2591  * @version Introduced in firmware 4.0.10.27
2592  * @param tool GoSurfaceStud object.
2593  * @return kTRUE if enabled and kFALSE if disabled.
2594  */
2595 GoFx(kBool) GoSurfaceStud_RegionEnabled(GoSurfaceStud tool);
2596 
2597 /**
2598  * Sets the enabled state of the tool region.
2599  *
2600  * @public @memberof GoSurfaceStud
2601  * @note Supported with G2, G3
2602  * @version Introduced in firmware 4.0.10.27
2603  * @param tool GoSurfaceStud object.
2604  * @param enable kTRUE to enable the region and kFALSE to disable it.
2605  * @return Operation status.
2606  */
2607 GoFx(kStatus) GoSurfaceStud_EnableRegion(GoSurfaceStud tool, kBool enable);
2608 
2609 /**
2610  * Returns the tool region object.
2611  *
2612  * @public @memberof GoSurfaceStud
2613  * @note Supported with G2, G3
2614  * @version Introduced in firmware 4.0.10.27
2615  * @param tool GoSurfaceStud object.
2616  * @return A GoRegion3d object.
2617  */
2618 GoFx(GoRegion3d) GoSurfaceStud_Region(GoSurfaceStud tool);
2619 
2620 /**
2621  * Gets the enabled state of the reference regions.
2622  *
2623  * @public @memberof GoSurfaceStud
2624  * @note Supported with G2, G3
2625  * @version Introduced in firmware 4.0.10.27
2626  * @param tool GoSurfaceStud object.
2627  * @return enable kTRUE if the reference regions are enabled and kFALSE otherwise.
2628  */
2629 GoFx(kBool) GoSurfaceStud_RefRegionsEnabled(GoSurfaceStud tool);
2630 
2631 /**
2632  * Sets the enabled state of the reference regions.
2633  *
2634  * @public @memberof GoSurfaceStud
2635  * @note Supported with G2, G3
2636  * @version Introduced in firmware 4.0.10.27
2637  * @param tool GoSurfaceStud object.
2638  * @param enable kTRUE to enable the region and kFALSE to disable it.
2639  * @return Operation status.
2640  */
2641 GoFx(kStatus) GoSurfaceStud_EnableRefRegions(GoSurfaceStud tool, kBool enable);
2642 
2643 /**
2644  * Sets the reference region count.
2645  *
2646  * @public @memberof GoSurfaceStud
2647  * @note Supported with G2, G3
2648  * @version Introduced in firmware 4.0.10.27
2649  * @param tool GoSurfaceStud object.
2650  * @param count The number of reference regions to use.
2651  * @return Operation status.
2652  * @see GO_SURFACE_STUD_MAX_REF_REGIONS
2653  */
2654 GoFx(kStatus) GoSurfaceStud_SetRefRegionCount(GoSurfaceStud tool, kSize count);
2655 
2656 /**
2657  * Returns the reference region count.
2658  *
2659  * @public @memberof GoSurfaceStud
2660  * @note Supported with G2, G3
2661  * @version Introduced in firmware 4.0.10.27
2662  * @param tool GoSurfaceStud object.
2663  * @return The reference region count.
2664  */
2665 GoFx(kSize) GoSurfaceStud_RefRegionCount(GoSurfaceStud tool);
2666 
2667 /**
2668  * Returns the reference region object at the given index.
2669  *
2670  * @public @memberof GoSurfaceStud
2671  * @note Supported with G2, G3
2672  * @version Introduced in firmware 4.0.10.27
2673  * @param tool GoSurfaceStud object.
2674  * @param index The index with which to return a reference region.
2675  * @return A GoSurfaceRegion2d object.
2676  * @see GoSurfaceStud_RefRegionCount
2677  */
2678 GoFx(GoSurfaceRegion2d) GoSurfaceStud_RefRegionAt(GoSurfaceStud tool, kSize index);
2679 
2680 /**
2681  * Gets the enabled state of auto-tilt.
2682  *
2683  * @public @memberof GoSurfaceStud
2684  * @note Supported with G2, G3
2685  * @version Introduced in firmware 4.0.10.27
2686  * @param tool GoSurfaceStud object.
2687  * @return kTRUE if enabled and kFALSE if disabled.
2688  */
2689 GoFx(kBool) GoSurfaceStud_AutoTiltEnabled(GoSurfaceStud tool);
2690 
2691 /**
2692  * Sets the enabled state of auto-tilt.
2693  *
2694  * @public @memberof GoSurfaceStud
2695  * @note Supported with G2, G3
2696  * @version Introduced in firmware 4.0.10.27
2697  * @param tool GoSurfaceStud object.
2698  * @param enable kTRUE to enable the region and kFALSE to disable it.
2699  * @return Operation status.
2700  */
2701 GoFx(kStatus) GoSurfaceStud_EnableAutoTilt(GoSurfaceStud tool, kBool enable);
2702 
2703 /**
2704  * Gets the tilt X-angle value.
2705  *
2706  * @public @memberof GoSurfaceStud
2707  * @note Supported with G2, G3
2708  * @version Introduced in firmware 4.0.10.27
2709  * @param tool GoSurfaceStud object.
2710  * @return The tilt X-angle value.
2711  */
2712 GoFx(k64f) GoSurfaceStud_TiltXAngle(GoSurfaceStud tool);
2713 
2714 /**
2715  * Sets the tilt X-angle value.
2716  *
2717  * @public @memberof GoSurfaceStud
2718  * @note Supported with G2, G3
2719  * @version Introduced in firmware 4.0.10.27
2720  * @param tool GoSurfaceStud object.
2721  * @param value The tilt X-angle value to set.
2722  * @return Operation status.
2723  */
2724 GoFx(kStatus) GoSurfaceStud_SetTiltXAngle(GoSurfaceStud tool, k64f value);
2725 
2726 /**
2727  * Returns the tilt Y-angle value.
2728  *
2729  * @public @memberof GoSurfaceStud
2730  * @note Supported with G2, G3
2731  * @version Introduced in firmware 4.0.10.27
2732  * @param tool GoSurfaceStud object.
2733  * @return The tilt Y-angle value.
2734  */
2735 GoFx(k64f) GoSurfaceStud_TiltYAngle(GoSurfaceStud tool);
2736 
2737 /**
2738  * Sets the tilt Y-angle value.
2739  *
2740  * @public @memberof GoSurfaceStud
2741  * @note Supported with G2, G3
2742  * @version Introduced in firmware 4.0.10.27
2743  * @param tool GoSurfaceStud object.
2744  * @param value The tilt Y-angle value to set.
2745  * @return Operation status.
2746  */
2747 GoFx(kStatus) GoSurfaceStud_SetTiltYAngle(GoSurfaceStud tool, k64f value);
2748 
2749 /**
2750  * Returns a GoSurfaceStud Base X measurement object.
2751  *
2752  * @public @memberof GoSurfaceStud
2753  * @note Supported with G2, G3
2754  * @version Introduced in firmware 4.0.10.27
2755  * @param tool GoSurfaceStud object.
2756  * @return A GoSurfaceStudBaseX Base X measurement.
2757  */
2758 GoFx(GoSurfaceStudBaseX) GoSurfaceStud_BaseXMeasurement(GoSurfaceStud tool);
2759 
2760 /**
2761  * Returns a GoSurfaceStud Base Y measurement object.
2762  *
2763  * @public @memberof GoSurfaceStud
2764  * @note Supported with G2, G3
2765  * @version Introduced in firmware 4.0.10.27
2766  * @param tool GoSurfaceStud object.
2767  * @return A GoSurfaceStudBaseY Base Y measurement.
2768  */
2769 GoFx(GoSurfaceStudBaseY) GoSurfaceStud_BaseYMeasurement(GoSurfaceStud tool);
2770 
2771 /**
2772  * Returns a GoSurfaceStud Base Z measurement object.
2773  *
2774  * @public @memberof GoSurfaceStud
2775  * @note Supported with G2, G3
2776  * @version Introduced in firmware 4.0.10.27
2777  * @param tool GoSurfaceStud object.
2778  * @return A GoSurfaceStud Base Z measurement.
2779  */
2780 GoFx(GoSurfaceStudBaseZ) GoSurfaceStud_BaseZMeasurement(GoSurfaceStud tool);
2781 
2782 /**
2783  * Returns a GoSurfaceStud Tip X measurement object.
2784  *
2785  * @public @memberof GoSurfaceStud
2786  * @note Supported with G2, G3
2787  * @version Introduced in firmware 4.0.10.27
2788  * @param tool GoSurfaceStud object.
2789  * @return A GoSurfaceStudTipX Tip X measurement.
2790  */
2791 GoFx(GoSurfaceStudTipX) GoSurfaceStud_TipXMeasurement(GoSurfaceStud tool);
2792 
2793 /**
2794  * Returns a GoSurfaceStud Tip Y measurement object.
2795  *
2796  * @public @memberof GoSurfaceStud
2797  * @note Supported with G2, G3
2798  * @version Introduced in firmware 4.0.10.27
2799  * @param tool GoSurfaceStud object.
2800  * @return A GoSurfaceStudTipY Tip Y measurement.
2801  */
2802 GoFx(GoSurfaceStudTipY) GoSurfaceStud_TipYMeasurement(GoSurfaceStud tool);
2803 
2804 /**
2805  * Returns a GoSurfaceStud Tip Z measurement object.
2806  *
2807  * @public @memberof GoSurfaceStud
2808  * @note Supported with G2, G3
2809  * @version Introduced in firmware 4.0.10.27
2810  * @param tool GoSurfaceStud object.
2811  * @return A GoSurfaceStudTipZ Tip Z measurement.
2812  */
2813 GoFx(GoSurfaceStudTipZ) GoSurfaceStud_TipZMeasurement(GoSurfaceStud tool);
2814 
2815 /**
2816  * Returns a GoSurfaceStud Radius measurement object.
2817  *
2818  * @public @memberof GoSurfaceStud
2819  * @note Supported with G2, G3
2820  * @version Introduced in firmware 4.0.10.27
2821  * @param tool GoSurfaceStud object.
2822  * @return A GoSurfaceStudRadius Radius measurement.
2823  */
2824 GoFx(GoSurfaceStudRadius) GoSurfaceStud_RadiusMeasurement(GoSurfaceStud tool);
2825 
2826 /**
2827 * Returns a GoSurfaceStud tip point feature object.
2828 *
2829 * @public @memberof GoSurfaceStud
2830 * @note Supported with G2, G3
2831 * @version Introduced in firmware 4.0.10.27
2832 * @param tool GoSurfaceStud object.
2833 * @return A GoSurfaceStudTipPoint tip point feature .
2834 */
2835 GoFx(GoSurfaceStudTipPoint) GoSurfaceStud_TipPoint(GoSurfaceHole tool);
2836 
2837 /**
2838 * Returns a GoSurfaceStud base point feature object.
2839 *
2840 * @public @memberof GoSurfaceStud
2841 * @note Supported with G2, G3
2842 * @version Introduced in firmware 4.0.10.27
2843 * @param tool GoSurfaceStud object.
2844 * @return A GoSurfaceStudBasePoint base point feature.
2845 */
2846 GoFx(GoSurfaceStudBasePoint) GoSurfaceStud_BasePoint(GoSurfaceHole tool);
2847 
2848 /**
2849  * @class GoSurfaceVolume
2850  * @extends GoSurfaceTool
2851  * @note Supported with G2, G3
2852  * @ingroup GoSdk-SurfaceTools
2853  * @brief Represents a surface volume tool. measurements in mm, mm^2 for area and mm^3 for volume
2854  */
2856 
2857 /**
2858  * Gets the enabled state of the tool region.
2859  *
2860  * @public @memberof GoSurfaceVolume
2861  * @note Supported with G2, G3
2862  * @version Introduced in firmware 4.0.10.27
2863  * @param tool GoSurfaceVolume object.
2864  * @return kTRUE if enabled and kFALSE if disabled.
2865  */
2866 GoFx(kBool) GoSurfaceVolume_RegionEnabled(GoSurfaceVolume tool);
2867 
2868 /**
2869  * Sets the enabled state of the tool region.
2870  *
2871  * @public @memberof GoSurfaceVolume
2872  * @note Supported with G2, G3
2873  * @version Introduced in firmware 4.0.10.27
2874  * @param tool GoSurfaceVolume object.
2875  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
2876  */
2877 GoFx(kStatus) GoSurfaceVolume_EnableRegion(GoSurfaceVolume tool, kBool enable);
2878 
2879 /**
2880  * Returns the tool region object.
2881  *
2882  * @public @memberof GoSurfaceVolume
2883  * @note Supported with G2, G3
2884  * @version Introduced in firmware 4.0.10.27
2885  * @param tool GoSurfaceVolume object.
2886  * @return A GoRegion3d object.
2887  */
2888 GoFx(GoRegion3d) GoSurfaceVolume_Region(GoSurfaceVolume tool);
2889 
2890 /**
2891  * Returns a GoSurfaceVolume Volume measurement object.
2892  *
2893  * @public @memberof GoSurfaceVolume
2894  * @note Supported with G2, G3
2895  * @version Introduced in firmware 4.0.10.27
2896  * @param tool GoSurfaceVolume object.
2897  * @return A GoSurfaceVolumeVolume Volume measurement.
2898  */
2899 GoFx(GoSurfaceVolumeVolume) GoSurfaceVolume_VolumeMeasurement(GoSurfaceVolume tool);
2900 
2901 /**
2902  * Returns a GoSurfaceVolume Area measurement object.
2903  *
2904  * @public @memberof GoSurfaceVolume
2905  * @note Supported with G2, G3
2906  * @version Introduced in firmware 4.0.10.27
2907  * @param tool GoSurfaceVolume object.
2908  * @return A GoSurfaceVolumeArea Area measurement.
2909  */
2910 GoFx(GoSurfaceVolumeArea) GoSurfaceVolume_AreaMeasurement(GoSurfaceVolume tool);
2911 
2912 /**
2913  * Returns a GoSurfaceVolume Thickness measurement object.
2914  *
2915  * @public @memberof GoSurfaceVolume
2916  * @note Supported with G2, G3
2917  * @version Introduced in firmware 4.0.10.27
2918  * @param tool GoSurfaceVolume object.
2919  * @return A GoSurfaceVolumeThickness Thickness measurement.
2920  */
2922 
2923 #include <GoSdk/Tools/GoSurfaceTools.x.h>
2924 
2925 #endif
Represents a surface countersunk hole tool shape.
GoSurfacePlaneMaxError GoSurfacePlane_MaxErrorMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Maximum Error measurement object.
kSize GoSurfaceTool_ZAngleAnchorOptionCount(GoSurfaceTool tool)
Gets the Z-anchoring option list count.
kStatus GoSurfaceOpening_SetTiltYAngle(GoSurfaceOpening tool, k64f value)
Sets the tilt Y-angle.
Represents a Y-angle measurement for a Surface Plane Tool.
kStatus GoSurfaceOpening_EnablePartialDetection(GoSurfaceOpening tool, kBool enable)
Sets the enabled state of partial detection.
Represents a global Z angle measurement for a Surface Bounding Box tool.
k32s GoSurfaceTool_XAnchor(GoSurfaceTool tool)
Gets the current X-anchoring source.
k64f GoSurfaceHole_TiltXAngle(GoSurfaceHole tool)
Gets the tilt X-angle value.
kSize GoSurfaceHole_RefRegionCount(GoSurfaceHole tool)
Gets the reference region count.
Declares the base GoTool class.
GoSurfaceEllipseCenterPoint GoSurfaceEllipse_CenterPoint(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse point feature.
Represents a Z-angle measurement for a Surface Bounding Box tool.
Represents the major axis line of an Surface Ellipse tool.
k64f GoSurfaceOpening_DepthLimit(GoSurfaceOpening tool)
Gets the depth limit value.
GoSurfaceDimPlaneDistance GoSurfaceDim_PlaneDistanceMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Plane Distance measurement object.
GoSurfaceDimCenterY GoSurfaceDim_CenterYMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Center Y measurement object.
kStatus GoSurfaceCountersunkHole_SetShape(GoSurfaceCountersunkHole tool, GoSurfaceCountersunkHoleShape value)
Sets the shape.
kStatus GoSurfacePlane_SetRegionCount(GoSurfacePlane tool, kSize count)
Sets the tool region count.
GoSurfaceBoxGlobalZAngle GoSurfaceBox_GlobalZAngleMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox global Z Angle measurement object.
kSize GoSurfacePlane_RegionCount(GoSurfacePlane tool)
Gets the tool's region count.
Represents the axis line of a Surface Bounding Box tool.
kStatus GoSurfaceOpening_SetNominalAngle(GoSurfaceOpening tool, k64f value)
Sets the nominal angle.
Represents a radius measurement for a Surface Stud Tool.
Represents a point of a Surface Stud Tip tool.
k32s GoSurfaceTool_ZAngleAnchor(GoSurfaceTool tool)
Gets the ZAngle-anchoring source.
Represents the center point of a Surface Bounding Box tool.
GoSurfaceRegion2d GoSurfaceCountersunkHole_RefRegionAt(GoSurfaceCountersunkHole tool, kSize index)
Returns the reference region at the given index.
Represents a length measurement for a Surface Bounding Box tool.
Declares all surface tools and their related classes.
k32u GoSurfaceTool_SourceOptionAt(GoSurfaceTool tool, kSize index)
Gets the data source option at the given index.
Represents the Y component of the normal measurement for a Surface Plane Tool.
GoSurfaceBoxWidth GoSurfaceBox_WidthMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Width measurement object.
GoSurfacePlaneZNormal GoSurfacePlane_ZNormalMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane X Normal measurement object.
kStatus GoSurfaceCountersunkHole_EnableRegion(GoSurfaceCountersunkHole tool, kBool enable)
Enables or disables the tool region.
Represents a Standard Deviation measurement for a Surface Plane Tool.
kStatus GoSurfaceOpening_SetTiltXAngle(GoSurfaceOpening tool, k64f value)
Sets the tilt X-angle.
Represents a width value measurement for a Surface Dimension Tool.
Represents a surface bounding box tool. all width/height/length/radius and x/y/z units are in mm...
GoSurfacePositionY GoSurfacePosition_YMeasurement(GoSurfacePosition tool)
Returns a GoSurfacePosition Y measurement object.
GoSurfaceBoxZ GoSurfaceBox_ZMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Z measurement object.
Represents a Y measurement for a Surface Hole Tool.
GoSurfacePlaneYAngle GoSurfacePlane_YAngleMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Y Angle measurement object.
kStatus GoSurfaceTool_SetZAnchor(GoSurfaceTool tool, k32s id)
Sets the Z-anchoring source.
GoSurfaceCountersunkHoleAxisOrientation GoSurfaceCountersunkHole_AxisOrientation(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool axis orientation measurement object.
kStatus GoSurfaceBox_EnableRegion(GoSurfaceBox tool, kBool enable)
Enables or disables the tool region.
GoSurfacePlaneDistance GoSurfacePlane_DistanceMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Distance measurement object.
kStatus GoSurfaceTool_SetYAnchor(GoSurfaceTool tool, k32s id)
Sets the Y-anchoring source.
Represents a Z measurement for a Surface Opening Tool.
kBool GoSurfaceHole_PartialDetectionEnabled(GoSurfaceHole tool)
Gets the enabled state of partial detection.
k32u GoSurfaceTool_XAnchorOptionAt(GoSurfaceTool tool, kSize index)
Gets the X-anchoring option at the given index.
k64f GoSurfaceOpening_NominalWidth(GoSurfaceOpening tool)
Gets the nominal width.
Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
kStatus GoSurfaceHole_EnableRefRegions(GoSurfaceHole tool, kBool enable)
Sets the enabled state of reference regions.
Represents an area measurement for a Surface Volume Tool.
kStatus GoSurfaceCountersunkHole_EnableCurveFit(GoSurfaceCountersunkHole tool, kBool enable)
Enables or disables curve fitting.
Represents a Maximum Error measurement for a Surface Plane Tool.
GoSurfaceHoleY GoSurfaceHole_YMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole Y measurement object.
Represents a center X value measurement for a Surface Dimension Tool.
GoSurfaceOpeningZ GoSurfaceOpening_ZMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Z measurement object.
GoSurfaceBoxX GoSurfaceBox_XMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox X measurement object.
GoSurfaceHoleRadius GoSurfaceHole_RadiusMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole Radius measurement object.
k64f GoSurfaceOpening_NominalLength(GoSurfaceOpening tool)
Gets the nominal length.
Represents the center point of a Surface Hole tool.
k64f GoSurfaceOpening_LengthTolerance(GoSurfaceOpening tool)
Gets the length tolerance.
GoRegion3d GoSurfaceVolume_Region(GoSurfaceVolume tool)
Returns the tool region object.
Represents the bounding Ellipse part matching asymmetry detection type.
GoSurfaceHoleZ GoSurfaceHole_ZMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole Z measurement object.
Represents a Minimum Error measurement for a Surface Plane Tool.
GoSurfaceCountersunkHoleXAngle GoSurfaceCountersunkHole_XAngleMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool X Angle measurement object.
k64f GoSurfaceHole_NominalRadius(GoSurfaceHole tool)
Gets the current nominal radius value.
Represents a minor value measurement for a Surface Ellipse tool.
kStatus GoSurfaceTool_SetStream(GoSurfaceTool tool, GoDataStream stream)
Sets the data stream.
GoSurfaceCountersunkHoleY GoSurfaceCountersunkHole_YMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Y position measurement object.
GoSurfaceOpeningWidth GoSurfaceOpening_WidthMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Width measurement object.
k64f GoSurfaceCountersunkHole_NominalOuterRadius(GoSurfaceCountersunkHole tool)
Returns the nominal outer radius.
GoSurfaceCountersunkHoleBevelAngle GoSurfaceCountersunkHole_BevelAngleMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Bevel Angle measurement object.
Represents the center point of a Surface Opening tool.
Represents a Surface Counter Sunk Hole tool. all width/height/length/radius and x/y/z units are in mm...
GoSurfaceEllipseMinorAxisLine GoSurfaceEllipse_MinorAxisLine(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse major axis line feature.
Represents a base Y measurement for a Surface Stud Tool.
kStatus GoSurfaceHole_EnablePartialDetection(GoSurfaceHole tool, kBool enable)
Sets the enabled state of partial detection.
kStatus GoSurfaceOpening_EnableAutoTilt(GoSurfaceOpening tool, kBool enable)
Sets the enabled state of auto-tilt.
Represents a Z-angle measurement for a Surface Ellipse tool.
kSize GoSurfaceTool_ZAnchorOptionCount(GoSurfaceTool tool)
Gets the Z-anchoring option list count.
kStatus GoSurfaceTool_SetSource(GoSurfaceTool tool, GoDataSource source)
Sets the data source.
GoSurfacePlaneZOffset GoSurfacePlane_ZOffsetMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Z Offset measurement object.
kBool GoSurfaceBox_ZRotationEnabled(GoSurfaceBox tool)
Returns the enabled state of Z-rotation.
Represents a Z-offset measurement for a Surface Plane Tool.
Represents a point of a Surface Stud Base tool.
Represents a tip X measurement for a Surface Stud Tool.
Represents a surface hole tool. all width/height/length/radius and x/y/z units are in mm...
kBool GoSurfaceOpening_RegionEnabled(GoSurfaceOpening tool)
Gets the enabled state of the tool region.
GoSurfaceDimHeight GoSurfaceDim_HeightMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Height measurement object.
GoSurfaceStudBaseY GoSurfaceStud_BaseYMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Base Y measurement object.
GoSurfaceStudTipPoint GoSurfaceStud_TipPoint(GoSurfaceHole tool)
Returns a GoSurfaceStud tip point feature object.
GoEllipseAsymmetryType GoSurfaceEllipse_AsymmetryDetectionType(GoSurfaceEllipse tool)
Gets the asymmetry detection type.
kStatus GoSurfaceStud_SetStudHeight(GoSurfaceStud tool, k64f value)
Sets the stud height value.
Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
Represents a surface plane tool.all width/height/length/radius and x/y/z units are in mm...
GoSurfaceCountersunkHoleZ GoSurfaceCountersunkHole_ZMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Z position measurement object.
Represents a surface opening tool type.
kBool GoSurfaceBox_RegionEnabled(GoSurfaceBox tool)
Returns the enabled state of the tool region.
GoSurfaceCountersunkHoleX GoSurfaceCountersunkHole_XMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool X position measurement object.
Represents a data stream which consists of a data step and ID.
Definition: GoSdkDef.h:1249
Represents a data source.
Represents a axis orientation measurement for a Surface Counter Sunk Hole Tool.
k64f GoSurfaceOpening_TiltYAngle(GoSurfaceOpening tool)
Gets the tilt Y-angle.
GoSurfacePlaneMinError GoSurfacePlane_MinErrorMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Minimum Error measurement object.
GoSurfaceCountersunkHoleCenterPoint GoSurfaceCountersunkHole_CenterPoint(GoSurfaceCountersunkHoleCenterPoint tool)
Returns a GoSurfaceCountersunkHoleCenterPoint tool center point feature.
Represents the minor axis line of an Surface Ellipse tool.
GoSurfacePlaneXAngle GoSurfacePlane_XAngleMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane X Angle measurement object.
GoSurfaceCountersunkHoleDepth GoSurfaceCountersunkHole_DepthMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Depth measurement object.
kStatus GoSurfaceHole_SetRefRegionCount(GoSurfaceHole tool, kSize count)
Sets the reference region count.
Contains various helper functions.
GoSurfacePlaneStdDev GoSurfacePlane_StdDevMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Standard Deviation measurement object.
kStatus GoSurfaceEllipse_SetAsymmetryDetectionType(GoSurfaceEllipse tool, GoEllipseAsymmetryType value)
Sets the asymmetry detection type.
kStatus GoSurfaceCountersunkHole_SetPlaneFitRange(GoSurfaceCountersunkHole tool, k64f value)
Sets the plane fit range.
GoSurfaceRegion2d GoSurfaceHole_RefRegionAt(GoSurfaceHole tool, kSize index)
Gets a reference region object at the given index.
Represents an X measurement for a Surface Hole Tool.
kBool GoSurfaceCountersunkHole_CurveFitEnabled(GoSurfaceCountersunkHole tool)
Returns the state of auto tilt.
kStatus GoSurfaceOpening_EnableRefRegions(GoSurfaceOpening tool, kBool enable)
Sets the enabled state of reference regions.
GoSurfacePositionZ GoSurfacePosition_ZMeasurement(GoSurfacePosition tool)
Returns a GoSurfacePosition Z measurement object.
kBool GoSurfaceOpening_DepthLimitEnabled(GoSurfaceOpening tool)
Gets the enabled state of the depth limit.
kStatus GoSurfaceOpening_SetRefRegionCount(GoSurfaceOpening tool, kSize count)
Sets the reference region count.
Represents a Y measurement for a Surface Opening Tool.
k64f GoSurfaceStud_BaseHeight(GoSurfaceStud tool)
Returns the stud base height value.
kBool GoSurfaceOpening_AutoTiltEnabled(GoSurfaceOpening tool)
Gets the enabled state of auto-tilt.
k64f GoSurfaceCountersunkHole_NominalBevelAngle(GoSurfaceCountersunkHole tool)
Returns the nominal bevel angle.
kBool GoSurfaceStud_RefRegionsEnabled(GoSurfaceStud tool)
Gets the enabled state of the reference regions.
kBool GoSurfaceTool_ZAngleAnchorEnabled(GoSurfaceTool tool)
Returns a boolean value representing whether or not a valid ZAngle - anchoring source has been set fo...
GoSurfaceBoxGlobalY GoSurfaceBox_GlobalYMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox global Y measurement object.
GoSurfaceCountersunkHoleCounterboreDepth GoSurfaceCountersunkHole_CounterboreDepth(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool counterbore depth measurement object.
GoRegion3d GoSurfaceCountersunkHole_Region(GoSurfaceCountersunkHole tool)
Returns the tool region.
kBool GoSurfaceCountersunkHole_AutoTiltEnabled(GoSurfaceCountersunkHole tool)
Returns the state of auto tilt.
k64f GoSurfaceHole_TiltYAngle(GoSurfaceHole tool)
Gets the tilt Y-angle value.
k64f GoSurfaceCountersunkHole_TiltYAngle(GoSurfaceCountersunkHole tool)
Returns the tilt Y angle value.
GoSurfaceEllipseMajor GoSurfaceEllipse_MajorMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Major measurement object.
kStatus GoSurfaceHole_EnableRegion(GoSurfaceHole tool, kBool enable)
Sets the enabled state of the tool region.
Represents an X-angle measurement for a Surface Plane Tool.
kBool GoSurfaceOpening_PartialDetectionEnabled(GoSurfaceOpening tool)
Gets the enabled state of partial detection.
GoSurfaceStudBaseX GoSurfaceStud_BaseXMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Base X measurement object.
k32s GoSurfaceTool_ZAnchor(GoSurfaceTool tool)
Gets the current Z-anchoring source.
Represents a major value measurement for a Surface Ellipse tool.
kBool GoSurfaceOpening_RefRegionsEnabled(GoSurfaceOpening tool)
Gets the enabled state of reference regions.
Represents an X measurement for a Surface Position Tool.
Represents the distance measurement for a Surface Plane Tool.
GoSurfaceHoleCenterPoint GoSurfaceHole_Point(GoSurfaceHole tool)
Returns a GoSurfaceHole point feature object.
GoSurfaceOpeningX GoSurfaceOpening_XMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening X measurement object.
kStatus GoSurfaceStud_SetStudRadius(GoSurfaceStud tool, k64f value)
Sets the stud radius value.
GoRegion3d GoSurfaceBox_Region(GoSurfaceBox tool)
Gets the surface bounding box region.
GoSurfaceFeature GoSurfaceDim_RefFeature(GoSurfaceDim tool)
Gets the reference Surface feature.
GoSurfaceBoxY GoSurfaceBox_YMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Y measurement object.
GoRegion3d GoSurfaceHole_Region(GoSurfaceHole tool)
Returns the tool's region object.
Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
kBool GoSurfaceEllipse_RegionEnabled(GoSurfaceEllipse tool)
Returns the enabled state of the tool region.
GoDataSource GoSurfaceTool_Source(GoSurfaceTool tool)
Gets the data source.
kSize GoSurfaceCountersunkHole_RefRegionCount(GoSurfaceCountersunkHole tool)
Returns the reference region count.
kStatus GoSurfaceStud_SetTipHeight(GoSurfaceStud tool, k64f value)
Sets the tip height value.
kStatus GoSurfaceOpening_SetNominalLength(GoSurfaceOpening tool, k64f value)
Sets the nominal length.
Represents the X component of the normal measurement for a Surface Plane Tool.
Represents a distance value measurement for a Surface Dimension Tool.
kStatus GoSurfaceOpening_SetNominalRadius(GoSurfaceOpening tool, k64f value)
Sets the nominal radius.
k32u GoSurfaceTool_ZAngleAnchorOptionAt(GoSurfaceTool tool, kSize index)
Gets the ZAngle-anchoring option at the given index.
Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
Represents a tip Y measurement for a Surface Stud Tool.
GoSurfaceStudTipZ GoSurfaceStud_TipZMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Tip Z measurement object.
kStatus GoSurfaceVolume_EnableRegion(GoSurfaceVolume tool, kBool enable)
Sets the enabled state of the tool region.
GoSurfaceOpeningAngle GoSurfaceOpening_AngleMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Angle measurement object.
Essential SDK declarations.
kStatus GoSurfaceStud_EnableRefRegions(GoSurfaceStud tool, kBool enable)
Sets the enabled state of the reference regions.
k64f GoSurfaceCountersunkHole_BevelRadiusOffset(GoSurfaceCountersunkHole tool)
Returns the bevel radius offset.
GoSurfaceOpeningLength GoSurfaceOpening_LengthMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Length measurement object.
Represents a width measurement for a Surface Opening Tool.
Represents a distance value measurement for a Surface Dimension Tool.
GoSurfaceCountersunkHoleBevelRadius GoSurfaceCountersunkHole_BevelRadiusMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Bevel Radius measurement object.
kStatus GoSurfaceTool_SetXAnchor(GoSurfaceTool tool, k32s id)
Sets the X-anchoring source.
kSize GoSurfaceTool_StreamOptionCount(GoSurfaceTool tool)
Gets the data stream option list count.
kStatus GoSurfaceOpening_SetWidthTolerance(GoSurfaceOpening tool, k64f value)
Sets the width tolerance.
Represents the base tool class.
Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
Represents a two dimensional surface tool region.
GoSurfaceDimCenterX GoSurfaceDim_CenterXMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Center X measurement object.
GoSurfaceEllipseMinor GoSurfaceEllipse_MinorMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Minor measurement object.
kStatus GoSurfaceHole_EnableDepthLimit(GoSurfaceHole tool, kBool enable)
Sets the enabled state of the depth limit.
Represents an X measurement for a Surface Bounding Box tool.
kStatus GoSurfaceOpening_SetDepthLimit(GoSurfaceOpening tool, k64f value)
Sets the depth limit value.
Represents the Z component of the normal measurement for a Surface Plane Tool.
Represents a base X measurement for a Surface Stud Tool.
GoDataStream GoSurfaceTool_Stream(GoSurfaceTool tool)
Gets the data stream.
k64f GoSurfaceOpening_TiltXAngle(GoSurfaceOpening tool)
Gets the tilt X-angle.
Represents an X measurement for a Surface Opening Tool.
kStatus GoSurfaceStud_SetRefRegionCount(GoSurfaceStud tool, kSize count)
Sets the reference region count.
kStatus GoSurfaceOpening_SetLengthTolerance(GoSurfaceOpening tool, k64f value)
Sets the length tolerance.
Represents an X position measurement for a Surface Counter Sunk Hole Tool.
kStatus GoSurfaceCountersunkHole_SetCurveOrientation(GoSurfaceCountersunkHole tool, k64f value)
Sets the curve orientation angle.
Represents a thickness measurement for a Surface Volume Tool.
kStatus GoSurfaceOpening_SetAngleTolerance(GoSurfaceOpening tool, k64f value)
Sets the angle tolerance.
Represents a Y Angle position measurement for a Surface Counter Sunk Hole Tool.
GoSurfacePositionPoint GoSurfacePosition_Point(GoSurfaceHole tool)
Returns a GoSurfacePosition point feature object.
Represents a width measurement for a Surface Bounding Box tool.
GoSurfaceOpeningCenterPoint GoSurfaceOpening_CenterPoint(GoSurfaceHole tool)
Returns a GoSurfaceOpening center point feature object.
Represents a surface rivet tool.
Represents a global X measurement for a Surface Bounding Box tool.
GoSurfaceDimDistance GoSurfaceDim_DistanceMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Distance measurement object.
Represents an angle measurement for a Surface Opening Tool.
GoSurfaceVolumeArea GoSurfaceVolume_AreaMeasurement(GoSurfaceVolume tool)
Returns a GoSurfaceVolume Area measurement object.
GoSurfaceFeature GoSurfaceDim_Feature(GoSurfaceDim tool)
Gets the non-reference Surface feature.
GoSurfaceStudBasePoint GoSurfaceStud_BasePoint(GoSurfaceHole tool)
Returns a GoSurfaceStud base point feature object.
kStatus GoSurfaceCountersunkHole_EnableRefRegions(GoSurfaceCountersunkHole tool, kBool enable)
Enables or disables reference regions.
k64f GoSurfaceOpening_NominalAngle(GoSurfaceOpening tool)
Gets the nominal angle.
Represents a base surface tool.
k64f GoSurfaceStud_StudRadius(GoSurfaceStud tool)
Returns the stud radius value.
kStatus GoSurfaceHole_SetTiltYAngle(GoSurfaceHole tool, k64f value)
Sets the tilt Y-angle value.
kBool GoSurfaceCountersunkHole_RegionEnabled(GoSurfaceCountersunkHole tool)
Returns the state of the tool region.
Represents a Y measurement for a Surface Position Tool.
GoRegion3d GoSurfaceStud_Region(GoSurfaceStud tool)
Returns the tool region object.
Represents a three dimensional surface region.
GoSurfaceDimWidth GoSurfaceDim_WidthMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Width measurement object.
GoSurfaceOpeningType GoSurfaceOpening_Type(GoSurfaceOpening tool)
Gets the surface opening type.
GoSurfaceHoleX GoSurfaceHole_XMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole X measurement object.
Represents the center point for a Surface Dimension tool.
kStatus GoSurfaceCountersunkHole_SetNominalInnerRadius(GoSurfaceCountersunkHole tool, k64f value)
Sets the nominal inner radius.
kBool GoSurfaceHole_RegionEnabled(GoSurfaceHole tool)
Gets the enabled state of the tool region.
GoSurfaceBoxLength GoSurfaceBox_LengthMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Length measurement object.
Represents a surface opening tool. all width/height/length/radius and x/y/z units are in mm...
kBool GoSurfaceHole_DepthLimitEnabled(GoSurfaceHole tool)
Gets the enabled state of the depth limit.
kStatus GoSurfaceOpening_EnableRegion(GoSurfaceOpening tool, kBool enable)
Sets the enabled state of the tool region.
kBool GoSurfaceTool_ZAnchorEnabled(GoSurfaceTool tool)
Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anc...
k64f GoSurfaceHole_DepthLimit(GoSurfaceHole tool)
Gets the depth limit value.
Represents the center point of an Surface Ellipse tool.
GoSurfaceStudTipY GoSurfaceStud_TipYMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Tip Y measurement object.
GoSurfacePositionX GoSurfacePosition_XMeasurement(GoSurfacePosition tool)
Returns a GoSurfacePosition X measurement object.
Represents a height measurement for a Surface Bounding Box tool.
Represents a tip Z measurement for a Surface Stud Tool.
k64f GoSurfaceStud_TiltXAngle(GoSurfaceStud tool)
Gets the tilt X-angle value.
GoSurfaceRegion2d GoSurfaceOpening_RefRegionAt(GoSurfaceOpening tool, kSize index)
Gets the reference region object at the specified index.
kBool GoSurfaceHole_AutoTiltEnabled(GoSurfaceHole tool)
Gets the enabled state of auto-tilt.
kStatus GoSurfaceCountersunkHole_SetNominalOuterRadius(GoSurfaceCountersunkHole tool, k64f value)
Sets the nominal outer radius.
GoSurfaceCountersunkHoleAxisTilt GoSurfaceCountersunkHole_AxisTilt(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool axis tilt measurement object.
kSize GoSurfaceTool_YAnchorOptionCount(GoSurfaceTool tool)
Gets the Y-anchoring option list count.
kSize GoSurfaceTool_SourceOptionCount(GoSurfaceTool tool)
Gets the data source option list count.
GoSurfaceBoundingBoxAxisLine GoSurfaceBox_AxisLine(GoSurfaceBox tool)
Returns a GoSurfaceBoundingBoxAxisLine axis line feature object.
GoSurfaceBoxZAngle GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Z Angle measurement object.
kStatus GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius)
Sets the nominal radius value.
k64f GoSurfaceCountersunkHole_TiltXAngle(GoSurfaceCountersunkHole tool)
Returns the tilt X angle value.
kSize GoSurfaceOpening_RefRegionCount(GoSurfaceOpening tool)
Gets the reference region count.
Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
Represents a surface stud tool. all width/height/length/radius and x/y/z units are in mm...
GoSurfaceBoxHeight GoSurfaceBox_HeightMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Height measurement object.
Represents a center Z value measurement for a Surface Dimension Tool.
kStatus GoSurfaceOpening_EnableDepthLimit(GoSurfaceOpening tool, kBool enable)
Sets the enabled state of the depth limit.
Represents a surface ellipse tool. all width/height/length/radius and x/y/z units are in mm...
kStatus GoSurfaceHole_SetRadiusTolerance(GoSurfaceHole tool, k64f radiusTolerance)
Sets the radius tolerance value.
k32u GoSurfaceTool_YAnchorOptionAt(GoSurfaceTool tool, kSize index)
Gets the Y-anchoring option at the given index.
GoSurfaceDimensionCenterPoint GoSurfaceDim_CenterPoint(GoSurfaceDimensionCenterPoint tool)
Returns a GoSurfaceDim center point feature object.
Represents the center point of a Surface Countersunk Hole tool.
kBool GoSurfacePlane_RegionsEnabled(GoSurfacePlane tool)
Gets the enabled state of the reference regions.
kSize GoSurfaceTool_XAnchorOptionCount(GoSurfaceTool tool)
Gets the X-anchoring option list count.
Represents a Y measurement for a Surface Bounding Box tool.
Represents a height value measurement for a Surface Dimension Tool.
kStatus GoSurfaceCountersunkHole_EnablePartialDetection(GoSurfaceCountersunkHole tool, kBool enable)
Enables or disables partial counter sunk hole detection.
Represents a volume measurement for a Surface Volume Tool.
kStatus GoSurfaceStud_SetBaseHeight(GoSurfaceStud tool, k64f value)
Sets the base height value.
kStatus GoSurfaceStud_EnableRegion(GoSurfaceStud tool, kBool enable)
Sets the enabled state of the tool region.
k64f GoSurfaceCountersunkHole_PlaneFitRange(GoSurfaceCountersunkHole tool)
Returns the plane fit range.
Represents a plane for a Surface Plane tool.
Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
kStatus GoSurfaceBox_SetAsymmetryDetectionType(GoSurfaceBox tool, GoBoxAsymmetryType value)
Sets the asymmetry detection type.
GoSurfaceDimCenterZ GoSurfaceDim_CenterZMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Center Z measurement object.
kBool GoSurfaceCountersunkHole_PlaneFitRangeEnabled(GoSurfaceCountersunkHole tool)
Gets the enabled state of the plane fit range.
Represents a radius measurement for a Surface Hole Tool.
k64f GoSurfaceCountersunkHole_NominalInnerRadius(GoSurfaceCountersunkHole tool)
Returns the nominal inner radius.
GoBoxAsymmetryType GoSurfaceBox_AsymmetryDetectionType(GoSurfaceBox tool)
Gets the asymmetry detection type.
GoSurfaceBoxGlobalX GoSurfaceBox_GlobalXMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox global X measurement object.
kBool GoSurfaceHole_RefRegionsEnabled(GoSurfaceHole tool)
Gets the enabled state of reference regions.
GoSurfaceVolumeThickness GoSurfaceVolume_ThicknessMeasurement(GoSurfaceVolume tool)
Returns a GoSurfaceVolume Thickness measurement object.
k32s GoSurfaceTool_YAnchor(GoSurfaceTool tool)
Gets the current Y-anchoring source.
GoDataStream GoSurfaceTool_StreamOptionAt(GoSurfaceTool tool, kSize index)
Gets the data stream option at the given index.
Represents a global Y measurement for a Surface Bounding Box tool.
k64f GoSurfaceCountersunkHole_CurveOrientation(GoSurfaceCountersunkHole tool)
Returns the curve orientation angle value.
GoSurfaceCountersunkHoleOuterRadius GoSurfaceCountersunkHole_OuterRadiusMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Outer Radius measurement object.
GoSurfaceEllipseRatio GoSurfaceEllipse_RatioMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Ratio measurement object.
k64f GoSurfaceStud_StudHeight(GoSurfaceStud tool)
Returns the stud height value.
kStatus GoSurfaceHole_EnableAutoTilt(GoSurfaceHole tool, kBool enable)
Sets the enabled state of auto-tilt.
GoSurfaceEllipseZAngle GoSurfaceEllipse_ZAngleMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Z Angle measurement object.
kSize GoSurfaceStud_RefRegionCount(GoSurfaceStud tool)
Returns the reference region count.
kBool GoSurfaceStud_RegionEnabled(GoSurfaceStud tool)
Gets the enabled state of the tool region.
kBool GoSurfaceCountersunkHole_PartialDetectionEnabled(GoSurfaceCountersunkHole tool)
Returns the state of partial detection.
Represents a Z measurement for a Surface Position Tool.
kStatus GoSurfaceEllipse_EnableRegion(GoSurfaceEllipse tool, kBool enable)
Enables or disables the tool region.
kStatus GoSurfaceStud_SetTiltXAngle(GoSurfaceStud tool, k64f value)
Sets the tilt X-angle value.
kBool GoSurfaceCountersunkHole_RefRegionsEnabled(GoSurfaceCountersunkHole tool)
Returns the state of the tool reference regions.
GoSurfaceBoundingBoxCenterPoint GoSurfaceBox_CenterPoint(GoSurfaceBox tool)
Returns a GoSurfaceBoundingBoxCenterPoint center point feature object.
GoSurfaceVolumeVolume GoSurfaceVolume_VolumeMeasurement(GoSurfaceVolume tool)
Returns a GoSurfaceVolume Volume measurement object.
GoSurfaceOpeningY GoSurfaceOpening_YMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Y measurement object.
kStatus GoSurfaceBox_EnableZRotation(GoSurfaceBox tool, kBool enable)
Enables or disables Z-rotation.
Represents the bounding box part matching asymmetry detection type.
kStatus GoSurfaceStud_EnableAutoTilt(GoSurfaceStud tool, kBool enable)
Sets the enabled state of auto-tilt.
Represents a axis tilt measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceStudBaseZ GoSurfaceStud_BaseZMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Base Z measurement object.
GoSurfaceStudRadius GoSurfaceStud_RadiusMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Radius measurement object.
kStatus GoSurfacePlane_EnableRegions(GoSurfacePlane tool, kBool enable)
Sets the enabled state of the reference regions.
kBool GoSurfaceStud_AutoTiltEnabled(GoSurfaceStud tool)
Gets the enabled state of auto-tilt.
Represents a ratio measurement for a Surface Ellipse tool.
GoSurfaceEllipseMajorAxisLine GoSurfaceEllipse_MajorAxisLine(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse major axis line feature.
Represents a Z measurement for a Surface Hole Tool.
k64f GoSurfaceOpening_WidthTolerance(GoSurfaceOpening tool)
Gets the width tolerance.
kStatus GoSurfaceStud_SetTiltYAngle(GoSurfaceStud tool, k64f value)
Sets the tilt Y-angle value.
GoSurfacePlaneXNormal GoSurfacePlane_XNormalMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane X Normal measurement object.
kStatus GoSurfaceCountersunkHole_EnablePlaneFitRange(GoSurfaceCountersunkHole tool, kBool enable)
Sets the enabled state of the plane fit range.
Represents a length measurement for a Surface Opening Tool.
Represents a surface feature for select surface tools.
GoSurfaceCountersunkHoleShape GoSurfaceCountersunkHole_Shape(GoSurfaceCountersunkHole tool)
Returns the shape.
GoSurfaceStudTipX GoSurfaceStud_TipXMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Tip X measurement object.
kBool GoSurfaceVolume_RegionEnabled(GoSurfaceVolume tool)
Gets the enabled state of the tool region.
kStatus GoSurfaceOpening_SetNominalWidth(GoSurfaceOpening tool, k64f value)
Sets the nominal width.
kStatus GoSurfaceTool_SetZAngleAnchor(GoSurfaceTool tool, k32s id)
Sets the ZAngle-anchoring source.
Represents a Y position measurement for a Surface Counter Sunk Hole Tool.
Represents a Length value measurement for a Surface Dimension Tool.
GoRegion3d GoSurfaceEllipse_Region(GoSurfaceEllipse tool)
Gets the tool region.
kStatus GoSurfaceCountersunkHole_SetTiltXAngle(GoSurfaceCountersunkHole tool, k64f value)
Sets the tilt X angle.
GoRegion3d GoSurfacePlane_RegionAt(GoSurfacePlane tool, kSize index)
Gets a region at the specified index.
kStatus GoSurfaceCountersunkHole_SetTiltYAngle(GoSurfaceCountersunkHole tool, k64f value)
Sets the tilt Y angle.
GoSurfacePlaneYNormal GoSurfacePlane_YNormalMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane Y Normal measurement object.
Represents a center Y value measurement for a Surface Dimension Tool.
kStatus GoSurfaceHole_SetTiltXAngle(GoSurfaceHole tool, k64f value)
Sets the tilt X-angle value.
kStatus GoSurfaceHole_SetDepthLimit(GoSurfaceHole tool, k64f value)
Sets the depth limit value.
GoSurfaceDimLength GoSurfaceDim_LengthMeasurement(GoSurfaceDim tool)
Returns a GoSurfaceDim Length measurement object.
k64f GoSurfaceStud_TipHeight(GoSurfaceStud tool)
Returns the stud tip height value.
Represents a Surface dimension tool. all width/height/length/radius and x/y/z units are in mm...
kStatus GoSurfaceCountersunkHole_SetNominalBevelAngle(GoSurfaceCountersunkHole tool, k64f value)
Sets the nominal bevel angle.
GoSurfaceRegion2d GoSurfaceStud_RefRegionAt(GoSurfaceStud tool, kSize index)
Returns the reference region object at the given index.
GoRegion3d GoSurfaceOpening_Region(GoSurfaceOpening tool)
Returns the region object for the tool.
GoSurfacePlanePlane GoSurfacePlane_Plane(GoSurfacePlane tool)
Returns a GoSurfacePlane plane feature object.
Represents a surface volume tool. measurements in mm, mm^2 for area and mm^3 for volume.
kBool GoSurfaceTool_YAnchorEnabled(GoSurfaceTool tool)
Returns a boolean value representing whether or not a valid Y-anchoring source has been set for Y-anc...
Represents a Z measurement for a Surface Bounding Box tool.
kStatus GoSurfaceCountersunkHole_SetRefRegionCount(GoSurfaceCountersunkHole tool, kSize count)
Sets the reference region count.
k32u GoSurfaceTool_ZAnchorOptionAt(GoSurfaceTool tool, kSize index)
Gets the Z-anchoring option at the given index.
Represents a base Z measurement for a Surface Stud Tool.
k64f GoSurfaceStud_TiltYAngle(GoSurfaceStud tool)
Returns the tilt Y-angle value.
GoSurfaceCountersunkHoleYAngle GoSurfaceCountersunkHole_YAngleMeasurement(GoSurfaceCountersunkHole tool)
Returns a GoSurfaceCountersunkHole tool Y Angle measurement object.
Represents a surface position tool. all width/height/length/radius and x/y/z units are in mm...
k64f GoSurfaceHole_RadiusTolerance(GoSurfaceHole tool)
Gets the current radius tolerance value.
kStatus GoSurfaceCountersunkHole_EnableAutoTilt(GoSurfaceCountersunkHole tool, kBool enable)
Enables or disables automatic tilt.
Represents a point of a Surface Position tool.
k64f GoSurfaceOpening_NominalRadius(GoSurfaceOpening tool)
Gets the nominal radius.
kBool GoSurfaceTool_XAnchorEnabled(GoSurfaceTool tool)
Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anc...
kStatus GoSurfaceCountersunkHole_SetBevelRadiusOffset(GoSurfaceCountersunkHole tool, k64f value)
Sets the bevel radius offset.
k64f GoSurfaceOpening_AngleTolerance(GoSurfaceOpening tool)
Gets the angle tolerance.