Gocator API
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-2019 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/GoExtTool.h>
17 #include <GoSdk/GoUtils.h>
18 
19 /**
20  * @class GoSurfaceTool
21  * @extends GoExtTool
22  * @note Supported with G2, G3
23  * @ingroup GoSdk-SurfaceTools
24  * @brief Represents a base surface tool.
25  */
26 typedef GoExtTool 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  */
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  */
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  */
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  */
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  */
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  */
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  */
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  */
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  */
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  */
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  */
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  */
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 * @class GoSurfaceCountersunkHole
565 * @extends GoSurfaceTool
566 * @note Supported with G2, G3
567 * @ingroup GoSdk-SurfaceTools
568 * @brief Represents a Surface Counter Sunk Hole tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
569 */
571 
572 /**
573  * Sets the shape.
574  *
575  * @public @memberof GoSurfaceCountersunkHole
576  * @note Supported with G2, G3
577  * @version Introduced in firmware 4.3.3.124
578  * @param tool GoSurfaceCountersunkHole object.
579  * @param value The value to set.
580  * @return Operation status.
581  */
583 
584 /**
585  * Returns the shape.
586  *
587  * @public @memberof GoSurfaceCountersunkHole
588  * @note Supported with G2, G3
589  * @version Introduced in firmware 4.3.3.124
590  * @param tool GoSurfaceCountersunkHole object.
591  * @return The nominal bevel angle.
592  */
594 
595 /**
596  * Sets the nominal bevel angle.
597  *
598  * @public @memberof GoSurfaceCountersunkHole
599  * @note Supported with G2, G3
600  * @version Introduced in firmware 4.0.10.27
601  * @param tool GoSurfaceCountersunkHole object.
602  * @param value The value to set.
603  * @return Operation status.
604  */
606 
607 /**
608  * Returns the nominal bevel angle.
609  *
610  * @public @memberof GoSurfaceCountersunkHole
611  * @note Supported with G2, G3
612  * @version Introduced in firmware 4.0.10.27
613  * @param tool GoSurfaceCountersunkHole object.
614  * @return The nominal bevel angle.
615  */
617 
618 /**
619  * Sets the nominal outer radius.
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  * @param value The value to set.
626  * @return Operation status.
627  */
629 
630 /**
631  * Returns the nominal outer radius.
632  *
633  * @public @memberof GoSurfaceCountersunkHole
634  * @note Supported with G2, G3
635  * @version Introduced in firmware 4.0.10.27
636  * @param tool GoSurfaceCountersunkHole object.
637  * @return The nominal outer radius.
638  */
640 
641 /**
642  * Sets the nominal inner 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  * @param value The value to set.
649  * @return Operation status.
650  */
652 
653 /**
654  * Returns the nominal inner radius.
655  *
656  * @public @memberof GoSurfaceCountersunkHole
657  * @note Supported with G2, G3
658  * @version Introduced in firmware 4.0.10.27
659  * @param tool GoSurfaceCountersunkHole object.
660  * @return The nominal inner radius.
661  */
663 
664 /**
665  * Sets the bevel radius offset.
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  * @param value The value to set.
672  * @return Operation status.
673  */
675 
676 /**
677  * Returns the bevel radius offset.
678  *
679  * @public @memberof GoSurfaceCountersunkHole
680  * @note Supported with G2, G3
681  * @version Introduced in firmware 4.0.10.27
682  * @param tool GoSurfaceCountersunkHole object.
683  * @return The bevel radius offset.
684  */
686 
687 /**
688  * Enables or disables partial counter sunk hole detection.
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  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
695  * @return Operation status.
696  */
698 
699 /**
700  * Returns the state of partial detection.
701  *
702  * @public @memberof GoSurfaceCountersunkHole
703  * @note Supported with G2, G3
704  * @version Introduced in firmware 4.0.10.27
705  * @param tool GoSurfaceCountersunkHole object.
706  * @return kTRUE if partial detection is enabled. kFALSE otherwise.
707  */
709 
710 /**
711  * Enables or disables the tool region.
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  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
718  * @return Operation status.
719  */
721 
722 /**
723  * Returns the state of the tool region.
724  *
725  * @public @memberof GoSurfaceCountersunkHole
726  * @note Supported with G2, G3
727  * @version Introduced in firmware 4.0.10.27
728  * @param tool GoSurfaceCountersunkHole object.
729  * @return kTRUE if the tool region is enabled. kFALSE otherwise.
730  */
732 
733 /**
734  * Returns 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 The tool region.
741  */
743 
744 /**
745  * Enables or disables reference regions.
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  * @param enable kTRUE to enable reference regions and kFALSE to disable them.
752  * @return Operation status.
753  */
755 
756 /**
757  * Returns the state of the tool reference regions.
758  *
759  * @public @memberof GoSurfaceCountersunkHole
760  * @note Supported with G2, G3
761  * @version Introduced in firmware 4.0.10.27
762  * @param tool GoSurfaceCountersunkHole object.
763  * @return kTRUE if refrence regions are enabled. kFALSE otherwise.
764  */
766 
767 /**
768  * Sets the reference region count.
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  * @param count The number of references regions to use when enabled.
775  * @return Reference region count.
776  * @see GO_SURFACE_COUNTERSUNK_HOLE_MAX_REF_REGIONS
777 
778  */
780 
781 /**
782  * Returns the reference region count.
783  *
784  * @public @memberof GoSurfaceCountersunkHole
785  * @note Supported with G2, G3
786  * @version Introduced in firmware 4.0.10.27
787  * @param tool GoSurfaceCountersunkHole object.
788  * @return Reference region count.
789  */
791 
792 /**
793  * Returns the reference region at the given index.
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  * @param index The index of the reference region to retrieve.
800  * @return A reference region.
801  */
803 
804 /**
805  * Enables or disables automatic tilt.
806  *
807  * @public @memberof GoSurfaceCountersunkHole
808  * @note Supported with G2, G3
809  * @version Introduced in firmware 4.0.10.27
810  * @param tool GoSurfaceCountersunkHole object.
811  * @param enable kTRUE to enable auto tilt and kFALSE to disable it.
812  * @return Operation status.
813  */
815 
816 /**
817  * Returns the state of auto tilt.
818  *
819  * @public @memberof GoSurfaceCountersunkHole
820  * @note Supported with G2, G3
821  * @version Introduced in firmware 4.0.10.27
822  * @param tool GoSurfaceCountersunkHole object.
823  * @return kTRUE if auto tilt is enabled. kFALSE otherwise.
824  */
826 
827 /**
828  * Sets the tilt X angle.
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  * @param value The value to set.
835  * @return Operation status.
836  */
838 
839 /**
840  * Returns the tilt X angle value.
841  *
842  * @public @memberof GoSurfaceCountersunkHole
843  * @note Supported with G2, G3
844  * @version Introduced in firmware 4.0.10.27
845  * @param tool GoSurfaceCountersunkHole object.
846  * @return Tilt X angle value.
847  */
849 
850 /**
851  * Sets the tilt Y angle.
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  * @param value The value to set.
858  * @return Operation status.
859  */
861 
862 /**
863  * Returns the tilt Y angle value.
864  *
865  * @public @memberof GoSurfaceCountersunkHole
866  * @note Supported with G2, G3
867  * @version Introduced in firmware 4.0.10.27
868  * @param tool GoSurfaceCountersunkHole object.
869  * @return Tilt Y angle value.
870  */
872 
873 /**
874  * Enables or disables curve fitting.
875  *
876  * @public @memberof GoSurfaceCountersunkHole
877  * @note Supported with G2, G3
878  * @version Introduced in firmware 4.1.3.106
879  * @param tool GoSurfaceCountersunkHole object.
880  * @param enable kTRUE to enable curve fitting and kFALSE to disable it.
881  * @return Operation status.
882  */
884 
885 
886 /**
887  * Returns the state of auto tilt.
888  *
889  * @public @memberof GoSurfaceCountersunkHole
890  * @note Supported with G2, G3
891  * @version Introduced in firmware 4.1.3.106
892  * @param tool GoSurfaceCountersunkHole object.
893  * @return kTRUE if curve fitting is enabled. kFALSE otherwise.
894  */
896 
897 /**
898  * Sets the curve orientation angle.
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  * @param value The value to set.
905  * @return Operation status.
906  */
908 
909 /**
910  * Returns the curve orientation angle value.
911  *
912  * @public @memberof GoSurfaceCountersunkHole
913  * @note Supported with G2, G3
914  * @version Introduced in firmware 4.1.3.106
915  * @param tool GoSurfaceCountersunkHole object.
916  * @return Curve orientation angle value.
917  */
919 
920 /**
921  * Sets the plane fit range.
922  *
923  * @public @memberof GoSurfaceCountersunkHole
924  * @note Supported with G2, G3
925  * @version Introduced in firmware 4.5.3.57
926  * @param tool GoSurfaceCountersunkHole object.
927  * @param value The value to set.
928  * @return Operation status.
929  */
931 
932 /**
933  * Gets the enabled state of the plane fit range.
934  *
935  * @public @memberof GoSurfaceCountersunkHole
936  * @note Supported with G2, G3
937  * @version Introduced in firmware 4.5.3.57
938  * @param tool GoSurfaceCountersunkHole object.
939  * @return kTRUE if enabled and kFALSE if disabled.
940  */
942 
943 /**
944  * Sets 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  * @param enable kTRUE to enable it and kFALSE to disable it.
951  * @return Operation status.
952  */
954 
955 /**
956  * Returns the plane fit range.
957  *
958  * @public @memberof GoSurfaceCountersunkHole
959  * @note Supported with G2, G3
960  * @version Introduced in firmware 4.5.3.57
961  * @param tool GoSurfaceCountersunkHole object.
962  * @return Plane fit range value.
963  */
965 
966 /**
967  * Returns a GoSurfaceCountersunkHole tool X position measurement object.
968  *
969  * @public @memberof GoSurfaceCountersunkHole
970  * @note Supported with G2, G3
971  * @version Introduced in firmware 4.0.10.27
972  * @param tool GoSurfaceCountersunkHole object.
973  * @return A GoSurfaceCountersunkHole X position measurement.
974  */
976 
977 /**
978  * Returns a GoSurfaceCountersunkHole tool Y 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 Y position measurement.
985  */
987 
988 /**
989  * Returns a GoSurfaceCountersunkHole tool Z 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 Z position measurement.
996  */
998 
999 /**
1000  * Returns a GoSurfaceCountersunkHole tool Outer Radius 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 GoSurfaceCountersunkHoleOuterRadius Outer Radius measurement.
1007  */
1009 
1010 /**
1011  * Returns a GoSurfaceCountersunkHole tool Depth 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 GoSurfaceCoGoSurfaceCountersunkHoleDepthuntersunkHole Depth measurement.
1018  */
1020 
1021 /**
1022  * Returns a GoSurfaceCountersunkHole tool counterbore depth measurement object.
1023  *
1024  * @public @memberof GoSurfaceCountersunkHole
1025  * @note Supported with G2, G3
1026  * @version Introduced in firmware 4.3.3.124
1027  * @param tool GoSurfaceCountersunkHole object.
1028  * @return A GoSurfaceCountersunkHoleCounterboreDepth counterbore depth measurement.
1029  */
1031 
1032 /**
1033  * Returns a GoSurfaceCountersunkHole tool Bevel Radius measurement object.
1034  *
1035  * @public @memberof GoSurfaceCountersunkHole
1036  * @note Supported with G2, G3
1037  * @version Introduced in firmware 4.0.10.27
1038  * @param tool GoSurfaceCountersunkHole object.
1039  * @return A GoSurfaceCountersunkHoleBevelRadius Bevel Radius measurement.
1040  */
1042 
1043 /**
1044  * Returns a GoSurfaceCountersunkHole tool Bevel Angle 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 GoSurfaceCountersunkHoleBevelAngle Bevel Angle measurement.
1051  */
1053 
1054 /**
1055  * Returns a GoSurfaceCountersunkHole tool X 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 GoSurfaceCountersunkHoleXAngle X angle measurement.
1062  */
1064 
1065 /**
1066  * Returns a GoSurfaceCountersunkHole tool Y 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 GoSurfaceCountersunkHoleYAngle Y angle measurement.
1073  */
1075 
1076 /**
1077  * Returns a GoSurfaceCountersunkHole tool axis tilt measurement object.
1078  *
1079  * @public @memberof GoSurfaceCountersunkHole
1080  * @note Supported with G2, G3
1081  * @version Introduced in firmware 4.5.3.57
1082  * @param tool GoSurfaceCountersunkHole object.
1083  * @return A GoSurfaceCountersunkHoleAxisTilt axis tilt measurement.
1084  */
1086 
1087 /**
1088  * Returns a GoSurfaceCountersunkHole tool axis orientation 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 GoSurfaceCountersunkHoleAxisOrientation axis orientation measurement.
1095  */
1097 
1098 /**
1099 * Returns a GoSurfaceCountersunkHoleCenterPoint tool center point feature.
1100 *
1101 * @public @memberof GoSurfaceCountersunkHoleCenterPoint
1102 * @note Supported with G2, G3
1103 * @version Introduced in firmware 4.5.3.57
1104 * @param tool GoSurfaceCountersunkHole object.
1105 * @return A GoSurfaceCountersunkHoleCenterPoint center point feature.
1106 */
1108 
1109 /**
1110  * @class GoSurfaceDim
1111  * @extends GoSurfaceTool
1112  * @note Supported with G2, G3
1113  * @ingroup GoSdk-SurfaceTools
1114  * @brief Represents a Surface dimension tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1115  */
1116 typedef GoSurfaceTool GoSurfaceDim;
1117 
1118 /**
1119  * Gets the reference Surface feature.
1120  *
1121  * @public @memberof GoSurfaceDim
1122  * @note Supported with G2, G3
1123  * @version Introduced in firmware 4.4.4.14
1124  * @param tool GoSurfaceDim object.
1125  * @return The reference Surface feature object.
1126  */
1128 
1129 
1130 /**
1131  * Gets the non-reference Surface feature.
1132  *
1133  * @public @memberof GoSurfaceDim
1134  * @note Supported with G2, G3
1135  * @version Introduced in firmware 4.4.4.14
1136  * @param tool GoSurfaceDim object.
1137  * @return The non-reference Surface feature object.
1138  */
1140 
1141 /**
1142  * Returns a GoSurfaceDim Width measurement object.
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 A GoSurfaceDimWidth measurement.
1149  */
1151 
1152 /**
1153  * Returns a GoSurfaceDim Height 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 GoSurfaceDimHeight measurement.
1160  */
1162 
1163 /**
1164  * Returns a GoSurfaceDim Length 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 GoSurfaceDimLength measurement.
1171  */
1173 
1174 /**
1175  * Returns a GoSurfaceDim Distance 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 GoSurfaceDimDistance measurement.
1182  */
1184 
1185 /**
1186  * Returns a GoSurfaceDim Plane 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 GoSurfaceDimPlaneDistance measurement.
1193  */
1195 
1196 /**
1197  * Returns a GoSurfaceDim Center X 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 GoSurfaceDimCenterX measurement.
1204  */
1206 
1207 /**
1208  * Returns a GoSurfaceDim Center Y 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 GoSurfaceDimCenterY measurement.
1215  */
1217 
1218 /**
1219 * Returns a GoSurfaceDim Center Z 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 GoSurfaceDimCenterZ measurement.
1226 */
1228 
1229 /**
1230 * Returns a GoSurfaceDim center point feature 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 GoSurfaceDimensionCenterPoint measurement.
1237 */
1239 
1240 /**
1241  * @class GoSurfaceEllipse
1242  * @extends GoSurfaceTool
1243  * @note Supported with G2, G3
1244  * @ingroup GoSdk-SurfaceTools
1245  * @brief Represents a surface ellipse tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1246  */
1248 
1249 /**
1250  * Enables or disables the tool region.
1251  *
1252  * @public @memberof GoSurfaceEllipse
1253  * @note Supported with G2, G3
1254  * @version Introduced in firmware 4.0.10.27
1255  * @param tool GoSurfaceEllipse object.
1256  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1257  * @return Operation status.
1258  */
1260 
1261 /**
1262  * Returns the enabled state of the tool region.
1263  *
1264  * @public @memberof GoSurfaceEllipse
1265  * @note Supported with G2, G3
1266  * @version Introduced in firmware 4.0.10.27
1267  * @param tool GoSurfaceEllipse object.
1268  * @return kTRUE if enabled and kFALSE if disabled.
1269  */
1271 
1272 /**
1273  * Gets 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 A GoRegion3d object.
1280  */
1282 
1283 /**
1284  * Sets the asymmetry detection type.
1285  *
1286  * @public @memberof GoSurfaceEllipse
1287  * @note Supported with G2, G3
1288  * @version Introduced in firmware 4.4.4.14
1289  * @param tool GoSurfaceEllipse object.
1290  * @param value The asymmetry detection type to set.
1291  * @return Operation status.
1292  */
1294 
1295 /**
1296  * Gets the asymmetry detection type.
1297  *
1298  * @public @memberof GoSurfaceEllipse
1299  * @note Supported with G2, G3
1300  * @version Introduced in firmware 4.4.4.14
1301  * @param tool GoSurfaceEllipse object.
1302  * @return The asymmetry detection type.
1303  */
1305 
1306 /**
1307  * Returns a GoSurfaceEllipse Major measurement object.
1308  *
1309  * @public @memberof GoSurfaceEllipse
1310  * @note Supported with G2, G3
1311  * @version Introduced in firmware 4.0.10.27
1312  * @param tool GoSurfaceEllipse object.
1313  * @return A GoSurfaceEllipse Major measurement.
1314  */
1316 
1317 /**
1318  * Returns a GoSurfaceEllipse Minor 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 Minor measurement.
1325  */
1327 
1328 /**
1329  * Returns a GoSurfaceEllipse Ratio 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 Ratio measurement.
1336  */
1338 
1339 /**
1340  * Returns a GoSurfaceEllipse Z Angle 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 Z Angle measurement.
1347  */
1349 
1350 /**
1351 * Returns a GoSurfaceEllipse point feature.
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 GoSurfaceEllipseCenterPoint point feature
1358 */
1360 
1361 /**
1362 * Returns a GoSurfaceEllipse major axis line 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 GoSurfaceEllipseMajorAxisLine axis line feature..
1369 */
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 GoSurfaceEllipseMinorAxisLine major axis line feature.
1380 */
1382 
1383 
1384 /**
1385  * @class GoSurfaceHole
1386  * @extends GoSurfaceTool
1387  * @note Supported with G2, G3
1388  * @ingroup GoSdk-SurfaceTools
1389  * @brief Represents a surface hole tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1390  */
1391 typedef GoSurfaceTool GoSurfaceHole;
1392 
1393 /**
1394  * Gets the current nominal radius value.
1395  *
1396  * @public @memberof GoSurfaceHole
1397  * @note Supported with G2, G3
1398  * @version Introduced in firmware 4.0.10.27
1399  * @param tool GoSurfaceHole object.
1400  * @return The nominal radius value.
1401  */
1403 
1404 /**
1405  * Sets the 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  * @param nominalRadius Nominal radius value to set.
1412  * @return Operation status.
1413  */
1414 GoFx(kStatus) GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius);
1415 
1416 /**
1417  * Gets the current radius tolerance value.
1418  *
1419  * @public @memberof GoSurfaceHole
1420  * @note Supported with G2, G3
1421  * @version Introduced in firmware 4.0.10.27
1422  * @param tool GoSurfaceHole object.
1423  * @return The radius tolerance value.
1424  */
1426 
1427 /**
1428  * Sets the 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  * @param radiusTolerance The radius tolerance value to set.
1435  * @return Operation status.
1436  */
1437 GoFx(kStatus) GoSurfaceHole_SetRadiusTolerance(GoSurfaceHole tool, k64f radiusTolerance);
1438 
1439 /**
1440  * Gets the enabled state of partial detection.
1441  *
1442  * @public @memberof GoSurfaceHole
1443  * @note Supported with G2, G3
1444  * @version Introduced in firmware 4.0.10.27
1445  * @param tool GoSurfaceHole object.
1446  * @return kTRUE if enabled and kFALSE if disabled.
1447  */
1449 
1450 /**
1451  * Sets 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  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1458  * @return Operation status.
1459  */
1461 
1462 /**
1463  * Gets the enabled state of the tool region.
1464  *
1465  * @public @memberof GoSurfaceHole
1466  * @note Supported with G2, G3
1467  * @version Introduced in firmware 4.0.10.27
1468  * @param tool GoSurfaceHole object.
1469  * @return kTRUE if enabled and kFALSE if disabled.
1470  */
1472 
1473 /**
1474  * Sets 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  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1481  * @return Operation status.
1482  */
1484 
1485 /**
1486  * Returns the tool's region object.
1487  *
1488  * @public @memberof GoSurfaceHole
1489  * @note Supported with G2, G3
1490  * @version Introduced in firmware 4.0.10.27
1491  * @param tool GoSurfaceHole object.
1492  * @return A GoRegion3d object.
1493  */
1495 
1496 /**
1497  * Gets the enabled state of reference regions.
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 kTRUE if enabled and kFALSE if disabled.
1504  */
1506 
1507 /**
1508  * Sets 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  * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1515  * @return Operation status.
1516  */
1518 
1519 /**
1520  * Gets the reference region count.
1521  *
1522  * @public @memberof GoSurfaceHole
1523  * @note Supported with G2, G3
1524  * @version Introduced in firmware 4.0.10.27
1525  * @param tool GoSurfaceHole object.
1526  * @return The reference region count.
1527  */
1529 
1530 /**
1531  * Sets 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  * @param count The reference region count.
1538  * @return Operation status.
1539  * @see GO_SURFACE_HOLE_MAX_REF_REGIONS
1540  */
1542 
1543 /**
1544  * Gets a reference region object at the given index.
1545  *
1546  * @public @memberof GoSurfaceHole
1547  * @note Supported with G2, G3
1548  * @version Introduced in firmware 4.0.10.27
1549  * @param tool GoSurfaceHole object.
1550  * @param index The index with which to retrieve a reference region.
1551  * @return A GoSurfaceRegion2d object.
1552  * @see GoSurfaceHole_RefRegionCount
1553  */
1555 
1556 /**
1557  * Gets the enabled state of auto-tilt.
1558  *
1559  * @public @memberof GoSurfaceHole
1560  * @note Supported with G2, G3
1561  * @version Introduced in firmware 4.0.10.27
1562  * @param tool GoSurfaceHole object.
1563  * @return kTRUE if enabled and kFALSE if disabled.
1564  */
1566 
1567 /**
1568  * Sets 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  * @param enable kTRUE to enable it and kFALSE to disable it.
1575  * @return Operation status.
1576  */
1578 
1579 /**
1580  * Gets the tilt X-angle value.
1581  *
1582  * @public @memberof GoSurfaceHole
1583  * @note Supported with G2, G3
1584  * @version Introduced in firmware 4.0.10.27
1585  * @param tool GoSurfaceHole object.
1586  * @return Tilt X-angle value.
1587  */
1589 
1590 /**
1591  * Sets 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  * @param value The tilt X-angle value to set.
1598  * @return Operation status.
1599  */
1601 
1602 /**
1603  * Gets the tilt Y-angle value.
1604  *
1605  * @public @memberof GoSurfaceHole
1606  * @note Supported with G2, G3
1607  * @version Introduced in firmware 4.0.10.27
1608  * @param tool GoSurfaceHole object.
1609  * @return Tilt Y-angle value.
1610  */
1612 
1613 /**
1614  * Sets 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  * @param value The tilt Y-angle value to set.
1621  * @return Operation status.
1622  */
1624 
1625 /**
1626  * Gets the enabled state of the depth limit.
1627  *
1628  * @public @memberof GoSurfaceHole
1629  * @note Supported with G2, G3
1630  * @version Introduced in firmware 4.3.3.124
1631  * @param tool GoSurfaceHole object.
1632  * @return kTRUE if enabled and kFALSE if disabled.
1633  */
1635 
1636 /**
1637  * Sets 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  * @param enable kTRUE to enable it and kFALSE to disable it.
1644  * @return Operation status.
1645  */
1647 
1648 /**
1649  * Gets the depth limit value.
1650  *
1651  * @public @memberof GoSurfaceHole
1652  * @note Supported with G2, G3
1653  * @version Introduced in firmware 4.3.3.124
1654  * @param tool GoSurfaceHole object.
1655  * @return Depth limit value.
1656 
1657  */
1659 
1660 /**
1661  * Sets the depth limit value.
1662  *
1663  * @public @memberof GoSurfaceHole
1664  * @note Supported with G2, G3
1665  * @version Introduced in firmware 4.3.3.124
1666  * @param tool GoSurfaceHole object.
1667  * @param value The depth limit value to set.
1668  * @return Operation status.
1669  * @see GoSurfaceHole_DepthLimitEnabled, GoSurfaceHole_EnableDepthLimit
1670  */
1672 
1673 /**
1674  * Returns a GoSurfaceHole X measurement object.
1675  *
1676  * @public @memberof GoSurfaceHole
1677  * @note Supported with G2, G3
1678  * @version Introduced in firmware 4.0.10.27
1679  * @param tool GoSurfaceHole object.
1680  * @return A GoSurfaceHoleX X measurement.
1681  */
1683 
1684 /**
1685  * Returns a GoSurfaceHole Y 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 GoSurfaceHoleY Y measurement.
1692  */
1694 
1695 /**
1696  * Returns a GoSurfaceHole Z 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 GoSurfaceHoleZ Z measurement.
1703  */
1705 
1706 /**
1707  * Returns a GoSurfaceHole Radius 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 GoSurfaceHoleRadius Radius measurement.
1714  */
1716 
1717 /**
1718 * Returns a GoSurfaceHole point feature 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 GoSurfaceHoleCenterPoint point feature.
1725 */
1727 
1728 
1729 /**
1730  * @class GoSurfaceOpening
1731  * @extends GoSurfaceTool
1732  * @note Supported with G2, G3
1733  * @ingroup GoSdk-SurfaceTools
1734  * @brief Represents a surface opening tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
1735  */
1737 
1738 GoFx(kStatus) GoSurfaceOpening_SetType(GoSurfaceOpening tool, GoSurfaceOpeningType type);
1739 
1740 /**
1741  * Gets the surface opening type.
1742  *
1743  * @public @memberof GoSurfaceOpening
1744  * @note Supported with G2, G3
1745  * @version Introduced in firmware 4.0.10.27
1746  * @param tool GoSurfaceOpening object.
1747  * @return The surface opening type.
1748  */
1750 
1751 /**
1752  * Gets the nominal width.
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 nominal width (in mm).
1759  */
1761 
1762 /**
1763  * Sets 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  * @param value The nominal width to set (in mm).
1770  * @return Operation status.
1771  */
1773 
1774 /**
1775  * Gets the nominal length.
1776  *
1777  * @public @memberof GoSurfaceOpening
1778  * @note Supported with G2, G3
1779  * @version Introduced in firmware 4.0.10.27
1780  * @param tool GoSurfaceOpening object.
1781  * @return The nominal length (in mm).
1782  */
1784 
1785 /**
1786  * Sets 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  * @param value The nominal length to set (in mm).
1793  * @return Operation status.
1794  */
1796 
1797 /**
1798  * Gets the nominal angle.
1799  *
1800  * @public @memberof GoSurfaceOpening
1801  * @note Supported with G2, G3
1802  * @version Introduced in firmware 4.0.10.27
1803  * @param tool GoSurfaceOpening object.
1804  * @return The nominal angle (in degrees).
1805  */
1807 
1808 /**
1809  * Sets 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  * @param value The nominal angle to set (in degrees).
1816  * @return Operation status.
1817  */
1819 
1820 /**
1821  * Gets the nominal radius.
1822  *
1823  * @public @memberof GoSurfaceOpening
1824  * @note Supported with G2, G3
1825  * @version Introduced in firmware 4.0.10.27
1826  * @param tool GoSurfaceOpening object.
1827  * @return The nominal radius (in mm).
1828  */
1830 
1831 /**
1832  * Sets 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  * @param value The nominal radius to set (in mm).
1839  * @return Operation status.
1840  */
1842 
1843 /**
1844  * Gets the width tolerance.
1845  *
1846  * @public @memberof GoSurfaceOpening
1847  * @note Supported with G2, G3
1848  * @version Introduced in firmware 4.0.10.27
1849  * @param tool GoSurfaceOpening object.
1850  * @return The width tolerance (in mm).
1851  */
1853 
1854 /**
1855  * Sets 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  * @param value The width tolerance to set (in mm).
1862  * @return Operation status.
1863  */
1865 
1866 /**
1867  * Gets the length tolerance.
1868  *
1869  * @public @memberof GoSurfaceOpening
1870  * @note Supported with G2, G3
1871  * @version Introduced in firmware 4.0.10.27
1872  * @param tool GoSurfaceOpening object.
1873  * @return The length tolerance (in mm).
1874  */
1876 
1877 /**
1878  * Sets 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  * @param value The length tolerance to set (in mm).
1885  * @return Operation status.
1886  */
1888 
1889 /**
1890  * Gets the angle tolerance.
1891  *
1892  * @public @memberof GoSurfaceOpening
1893  * @note Supported with G2, G3
1894  * @version Introduced in firmware 4.0.10.27
1895  * @param tool GoSurfaceOpening object.
1896  * @return The angle tolerance (in degrees).
1897  */
1899 
1900 /**
1901  * Sets 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  * @param value The angle tolerance to set (in degrees).
1908  * @return Operation status.
1909  */
1911 
1912 /**
1913  * Gets the enabled state of partial detection.
1914  *
1915  * @public @memberof GoSurfaceOpening
1916  * @note Supported with G2, G3
1917  * @version Introduced in firmware 4.0.10.27
1918  * @param tool GoSurfaceOpening object.
1919  * @return kTRUE if partial detection is enabled and kFALSE otherwise.
1920  */
1922 
1923 /**
1924  * Sets 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  * @param enable kTRUE to enable partial detection and kFALSE to disable it.
1931  * @return Operation status.
1932  */
1934 
1935 /**
1936  * Gets the enabled state of the tool region.
1937  *
1938  * @public @memberof GoSurfaceOpening
1939  * @note Supported with G2, G3
1940  * @version Introduced in firmware 4.0.10.27
1941  * @param tool GoSurfaceOpening object.
1942  * @return kTRUE if the tool region is enabled and kFALSE otherwise.
1943  */
1945 
1946 /**
1947  * Sets 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  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
1954  * @return Operation status.
1955  */
1957 
1958 /**
1959  * Returns the region object for the tool.
1960  *
1961  * @public @memberof GoSurfaceOpening
1962  * @note Supported with G2, G3
1963  * @version Introduced in firmware 4.0.10.27
1964  * @param tool GoSurfaceOpening object.
1965  * @return A GoRegion3d object.
1966  */
1968 
1969 /**
1970  * Gets the enabled state of reference regions.
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 kTRUE if reference regions are enabled and kFALSE otherwise.
1977  */
1979 
1980 /**
1981  * Sets 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  * @param enable kTRUE to enable reference regions and kFALSE to disable it.
1988  * @return Operation status.
1989  */
1991 
1992 /**
1993  * Gets the reference region count.
1994  *
1995  * @public @memberof GoSurfaceOpening
1996  * @note Supported with G2, G3
1997  * @version Introduced in firmware 4.0.10.27
1998  * @param tool GoSurfaceOpening object.
1999  * @return The count of reference regions.
2000  */
2002 
2003 /**
2004  * Sets 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  * @param count The reference region count to set.
2011  * @return Operation status.
2012  * @see GO_SURFACE_OPENING_MAX_REF_REGIONS
2013  */
2015 
2016 /**
2017  * Gets the reference region object at the specified index.
2018  *
2019  * @public @memberof GoSurfaceOpening
2020  * @note Supported with G2, G3
2021  * @version Introduced in firmware 4.0.10.27
2022  * @param tool GoSurfaceOpening object.
2023  * @param index The index with which to retrieve a reference region.
2024  * @return A GoSurfaceRegion2d object or kNULL if the index is invalid.
2025  * @see GoSurfaceOpening_RefRegionCount
2026  */
2028 
2029 /**
2030  * Gets the enabled state of auto-tilt.
2031  *
2032  * @public @memberof GoSurfaceOpening
2033  * @note Supported with G2, G3
2034  * @version Introduced in firmware 4.0.10.27
2035  * @param tool GoSurfaceOpening object.
2036  * @return kTRUE if auto-tilt is enabled and kFALSE otherwise.
2037  */
2039 
2040 /**
2041  * Sets 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  * @param enable kTRUE to enable auto-tilt and kFALSE to disable it.
2048  * @return Operation status.
2049  */
2051 
2052 /**
2053  * Gets the tilt X-angle.
2054  *
2055  * @public @memberof GoSurfaceOpening
2056  * @note Supported with G2, G3
2057  * @version Introduced in firmware 4.0.10.27
2058  * @param tool GoSurfaceOpening object.
2059  * @return The tilt X-angle.
2060  */
2062 
2063 /**
2064  * Sets 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  * @param value The tilt X-angle to set.
2071  * @return Operation status.
2072  */
2074 
2075 /**
2076  * Gets the tilt Y-angle.
2077  *
2078  * @public @memberof GoSurfaceOpening
2079  * @note Supported with G2, G3
2080  * @version Introduced in firmware 4.0.10.27
2081  * @param tool GoSurfaceOpening object.
2082  * @return The tilt Y-angle.
2083  */
2085 
2086 /**
2087  * Sets 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  * @param value The tilt Y-angle to set.
2094  * @return Operation status.
2095  */
2097 
2098 /**
2099  * Gets the enabled state of the depth limit.
2100  *
2101  * @public @memberof GoSurfaceOpening
2102  * @note Supported with G2, G3
2103  * @version Introduced in firmware 4.3.3.124
2104  * @param tool GoSurfaceOpening object.
2105  * @return kTRUE if enabled and kFALSE if disabled.
2106  */
2108 
2109 /**
2110  * Sets 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  * @param enable kTRUE to enable it and kFALSE to disable it.
2117  * @return Operation status.
2118  */
2120 
2121 /**
2122  * Gets the depth limit value.
2123  *
2124  * @public @memberof GoSurfaceOpening
2125  * @note Supported with G2, G3
2126  * @version Introduced in firmware 4.3.3.124
2127  * @param tool GoSurfaceOpening object.
2128  * @return Depth limit value.
2129 
2130  */
2132 
2133 /**
2134  * Sets the depth limit value.
2135  *
2136  * @public @memberof GoSurfaceOpening
2137  * @note Supported with G2, G3
2138  * @version Introduced in firmware 4.3.3.124
2139  * @param tool GoSurfaceOpening object.
2140  * @param value The depth limit value to set.
2141  * @return Operation status.
2142  * @see GoSurfaceOpening_DepthLimitEnabled, GoSurfaceOpening_EnableDepthLimit
2143  */
2145 
2146 
2147 /**
2148  * Returns a GoSurfaceOpening X measurement object.
2149  *
2150  * @public @memberof GoSurfaceOpening
2151  * @note Supported with G2, G3
2152  * @version Introduced in firmware 4.0.10.27
2153  * @param tool GoSurfaceOpening object.
2154  * @return A GoSurfaceOpeningX X measurement.
2155  */
2157 
2158 /**
2159  * Returns a GoSurfaceOpening Y 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 GoSurfaceOpeningY Y measurement.
2166  */
2168 
2169 /**
2170  * Returns a GoSurfaceOpening Z 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 GoSurfaceOpening Z measurement.
2177  */
2179 
2180 /**
2181  * Returns a GoSurfaceOpening Width 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 GoSurfaceOpeningWidth Width measurement.
2188  */
2190 
2191 /**
2192  * Returns a GoSurfaceOpening Length 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 GoSurfaceOpeningLength Length measurement.
2199  */
2201 
2202 /**
2203  * Returns a GoSurfaceOpening Angle 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 GoSurfaceOpeningAngle Angle measurement.
2210  */
2212 
2213 /**
2214 * Returns a GoSurfaceOpening center point feature 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 GoSurfaceOpeningCenterPoint center point feature.
2221 */
2223 
2224 /**
2225  * @class GoSurfacePlane
2226  * @extends GoSurfaceTool
2227  * @note Supported with G2, G3
2228  * @ingroup GoSdk-SurfaceTools
2229  * @brief Represents a surface plane tool.all width/height/length/radius and x/y/z units are in mm, angles in degrees
2230  */
2231 typedef GoSurfaceTool GoSurfacePlane;
2232 
2233 /**
2234  * Gets the enabled state of the reference regions.
2235  *
2236  * @public @memberof GoSurfacePlane
2237  * @note Supported with G2, G3
2238  * @version Introduced in firmware 4.0.10.27
2239  * @param tool GoSurfacePlane object.
2240  * @return kTRUE if the tool region is enabled and kFALSE otherwise.
2241  */
2243 
2244 /**
2245  * Sets 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  * @param enable kTRUE to enable regions and kFALSE to disable them.
2252  * @return Operation status.
2253  */
2255 
2256 /**
2257  * Gets the tool's region count.
2258  *
2259  * @public @memberof GoSurfacePlane
2260  * @note Supported with G2, G3
2261  * @version Introduced in firmware 4.0.10.27
2262  * @param tool GoSurfacePlane object.
2263  * @return The number of regions in the tool.
2264  */
2266 
2267 /**
2268  * Sets the tool 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  * @param count The region count to set.
2275  * @return Operation status.
2276  */
2278 
2279 /**
2280  * Gets a region at the specified index.
2281  *
2282  * @public @memberof GoSurfacePlane
2283  * @note Supported with G2, G3
2284  * @version Introduced in firmware 4.0.10.27
2285  * @param tool GoSurfacePlane object.
2286  * @param index The index with which to return a tool region.
2287  * @return A GoRegion3d object or kNULL if the index is in invalid.
2288  * @see GoSurfacePlane_RegionCount
2289  */
2291 
2292 /**
2293  * Returns a GoSurfacePlane X Angle measurement object.
2294  *
2295  * @public @memberof GoSurfacePlane
2296  * @note Supported with G2, G3
2297  * @version Introduced in firmware 4.0.10.27
2298  * @param tool GoSurfacePlane object.
2299  * @return A GoSurfacePlaneXAngle X Angle measurement.
2300  */
2302 
2303 /**
2304  * Returns a GoSurfacePlane Y 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 GoSurfacePlaneYAngle Y Angle measurement.
2311  */
2313 
2314 /**
2315  * Returns a GoSurfacePlane Z Offset 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 GoSurfacePlaneZOffset Z Offset measurement.
2322  */
2324 
2325 /**
2326  * Returns a GoSurfacePlane Standard Deviation measurement object.
2327  *
2328  * @public @memberof GoSurfacePlane
2329  * @note Supported with G2, G3
2330  * @version Introduced in firmware 4.4.4.14
2331  * @param tool GoSurfacePlane object.
2332  * @return A GoSurfacePlane Standard Deviation measurement.
2333  */
2335 
2336 /**
2337  * Returns a GoSurfacePlane Minimum Error 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 GoSurfacePlaneMinError Minimum Error measurement.
2344  */
2346 
2347 /**
2348  * Returns a GoSurfacePlane Maximum 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 GoSurfacePlaneMaxError Maximum Error measurement.
2355  */
2357 
2358 /**
2359 * Returns a GoSurfacePlane X Normal measurement object.
2360 *
2361 * @public @memberof GoSurfacePlane
2362 * @note Supported with G2, G3
2363 * @version Introduced in firmware 4.6.0.49
2364 * @param tool GoSurfacePlane object.
2365 * @return A GoSurfacePlaneXNormal X Normal measurement.
2366 */
2368 /**
2369 * Returns a GoSurfacePlane Y Normal measurement object.
2370 *
2371 * @public @memberof GoSurfacePlane
2372 * @note Supported with G2, G3
2373 * @version Introduced in firmware 4.6.0.49
2374 * @param tool GoSurfacePlane object.
2375 * @return A GoSurfacePlane Y Normal measurement.
2376 */
2378 /**
2379 * Returns a GoSurfacePlane X Normal measurement object.
2380 *
2381 * @public @memberof GoSurfacePlane
2382 * @note Supported with G2, G3
2383 * @version Introduced in firmware 4.6.0.49
2384 * @param tool GoSurfacePlane object.
2385 * @return A GoSurfacePlane X Normal measurement.
2386 */
2388 /**
2389 * Returns a GoSurfacePlane Distance measurement object.
2390 *
2391 * @public @memberof GoSurfacePlane
2392 * @note Supported with G2, G3
2393 * @version Introduced in firmware 4.6.0.49
2394 * @param tool GoSurfacePlane object.
2395 * @return A GoSurfacePlaneDistance Distance measurement.
2396 */
2398 
2399 /**
2400 * Returns a GoSurfacePlane plane feature object.
2401 *
2402 * @public @memberof GoSurfacePlane
2403 * @note Supported with G2, G3
2404 * @version Introduced in firmware 4.7.2.x
2405 * @param tool GoSurfacePlane object.
2406 * @return A GoSurfacePlanePlane plane feature.
2407 */
2409 
2410 /**
2411  * @class GoSurfacePosition
2412  * @extends GoSurfaceTool
2413  * @note Supported with G2, G3
2414  * @ingroup GoSdk-SurfaceTools
2415  * @brief Represents a surface position tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
2416  */
2418 
2419 GoFx(GoSurfaceFeature) GoSurfacePosition_Feature(GoSurfacePosition tool);
2420 
2421 /**
2422  * Returns a GoSurfacePosition X measurement object.
2423  *
2424  * @public @memberof GoSurfacePosition
2425  * @note Supported with G2, G3
2426  * @version Introduced in firmware 4.0.10.27
2427  * @param tool GoSurfacePosition object.
2428  * @return A GoSurfacePositionX X measurement.
2429  */
2431 
2432 /**
2433  * Returns a GoSurfacePosition Y 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 GoSurfacePosition Y measurement.
2440  */
2442 
2443 /**
2444  * Returns a GoSurfacePosition Z 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 Z measurement.
2451  */
2453 
2454 /**
2455 * Returns a GoSurfacePosition point feature 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 GoSurfacePositionPoint point feature.
2462 */
2464 
2465 /**
2466 * @class GoSurfaceRivet
2467 * @extends GoSurfaceTool
2468 * @note Supported with G2, G3
2469 * @ingroup GoSdk-SurfaceTools
2470 * @brief Represents a surface rivet tool.
2471 */
2473 
2474 /**
2475  * @class GoSurfaceStud
2476  * @extends GoSurfaceTool
2477  * @note Supported with G2, G3
2478  * @ingroup GoSdk-SurfaceTools
2479  * @brief Represents a surface stud tool. all width/height/length/radius and x/y/z units are in mm, angles in degrees
2480  */
2481 typedef GoSurfaceTool GoSurfaceStud;
2482 
2483 /**
2484  * Returns the stud radius value.
2485  *
2486  * @public @memberof GoSurfaceStud
2487  * @note Supported with G2, G3
2488  * @version Introduced in firmware 4.0.10.27
2489  * @param tool GoSurfaceStud object.
2490  * @return The stud radius value.
2491  */
2493 
2494 /**
2495  * Sets 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  * @param value The stud radius value to set.
2502  * @return Operation status.
2503  */
2505 
2506 /**
2507  * Returns the stud height value.
2508  *
2509  * @public @memberof GoSurfaceStud
2510  * @note Supported with G2, G3
2511  * @version Introduced in firmware 4.0.10.27
2512  * @param tool GoSurfaceStud object.
2513  * @return The stud height value.
2514  */
2516 
2517 /**
2518  * Sets 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  * @param value The stud height value to set.
2525  * @return Operation status.
2526  */
2528 
2529 /**
2530  * Returns the stud base height value.
2531  *
2532  * @public @memberof GoSurfaceStud
2533  * @note Supported with G2, G3
2534  * @version Introduced in firmware 4.0.10.27
2535  * @param tool GoSurfaceStud object.
2536  * @return The stud base height value.
2537  */
2539 
2540 /**
2541  * Sets the 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  * @param value The base height value to set.
2548  * @return Operation status.
2549  */
2551 
2552 /**
2553  * Returns the stud tip height value.
2554  *
2555  * @public @memberof GoSurfaceStud
2556  * @note Supported with G2, G3
2557  * @version Introduced in firmware 4.0.10.27
2558  * @param tool GoSurfaceStud object.
2559  * @return The stud tip height value.
2560  */
2562 
2563 /**
2564  * Sets the 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  * @param value The tip height value to set.
2571  * @return Operation status.
2572  */
2574 
2575 /**
2576  * Gets the enabled state of the tool region.
2577  *
2578  * @public @memberof GoSurfaceStud
2579  * @note Supported with G2, G3
2580  * @version Introduced in firmware 4.0.10.27
2581  * @param tool GoSurfaceStud object.
2582  * @return kTRUE if enabled and kFALSE if disabled.
2583  */
2585 
2586 /**
2587  * Sets 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  * @param enable kTRUE to enable the region and kFALSE to disable it.
2594  * @return Operation status.
2595  */
2597 
2598 /**
2599  * Returns the tool region object.
2600  *
2601  * @public @memberof GoSurfaceStud
2602  * @note Supported with G2, G3
2603  * @version Introduced in firmware 4.0.10.27
2604  * @param tool GoSurfaceStud object.
2605  * @return A GoRegion3d object.
2606  */
2608 
2609 /**
2610  * Gets the enabled state of the reference regions.
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 enable kTRUE if the reference regions are enabled and kFALSE otherwise.
2617  */
2619 
2620 /**
2621  * Sets 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  * @param enable kTRUE to enable the region and kFALSE to disable it.
2628  * @return Operation status.
2629  */
2631 
2632 /**
2633  * Sets the reference region count.
2634  *
2635  * @public @memberof GoSurfaceStud
2636  * @note Supported with G2, G3
2637  * @version Introduced in firmware 4.0.10.27
2638  * @param tool GoSurfaceStud object.
2639  * @param count The number of reference regions to use.
2640  * @return Operation status.
2641  * @see GO_SURFACE_STUD_MAX_REF_REGIONS
2642  */
2644 
2645 /**
2646  * Returns the reference region count.
2647  *
2648  * @public @memberof GoSurfaceStud
2649  * @note Supported with G2, G3
2650  * @version Introduced in firmware 4.0.10.27
2651  * @param tool GoSurfaceStud object.
2652  * @return The reference region count.
2653  */
2655 
2656 /**
2657  * Returns the reference region object at the given index.
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  * @param index The index with which to return a reference region.
2664  * @return A GoSurfaceRegion2d object.
2665  * @see GoSurfaceStud_RefRegionCount
2666  */
2668 
2669 /**
2670  * Gets the enabled state of auto-tilt.
2671  *
2672  * @public @memberof GoSurfaceStud
2673  * @note Supported with G2, G3
2674  * @version Introduced in firmware 4.0.10.27
2675  * @param tool GoSurfaceStud object.
2676  * @return kTRUE if enabled and kFALSE if disabled.
2677  */
2679 
2680 /**
2681  * Sets 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  * @param enable kTRUE to enable the region and kFALSE to disable it.
2688  * @return Operation status.
2689  */
2691 
2692 /**
2693  * Gets the tilt X-angle value.
2694  *
2695  * @public @memberof GoSurfaceStud
2696  * @note Supported with G2, G3
2697  * @version Introduced in firmware 4.0.10.27
2698  * @param tool GoSurfaceStud object.
2699  * @return The tilt X-angle value.
2700  */
2702 
2703 /**
2704  * Sets 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  * @param value The tilt X-angle value to set.
2711  * @return Operation status.
2712  */
2714 
2715 /**
2716  * Returns the tilt Y-angle value.
2717  *
2718  * @public @memberof GoSurfaceStud
2719  * @note Supported with G2, G3
2720  * @version Introduced in firmware 4.0.10.27
2721  * @param tool GoSurfaceStud object.
2722  * @return The tilt Y-angle value.
2723  */
2725 
2726 /**
2727  * Sets 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  * @param value The tilt Y-angle value to set.
2734  * @return Operation status.
2735  */
2737 
2738 /**
2739  * Returns a GoSurfaceStud Base X measurement object.
2740  *
2741  * @public @memberof GoSurfaceStud
2742  * @note Supported with G2, G3
2743  * @version Introduced in firmware 4.0.10.27
2744  * @param tool GoSurfaceStud object.
2745  * @return A GoSurfaceStudBaseX Base X measurement.
2746  */
2748 
2749 /**
2750  * Returns a GoSurfaceStud Base Y 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 GoSurfaceStudBaseY Base Y measurement.
2757  */
2759 
2760 /**
2761  * Returns a GoSurfaceStud Base Z 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 GoSurfaceStud Base Z measurement.
2768  */
2770 
2771 /**
2772  * Returns a GoSurfaceStud Tip X 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 GoSurfaceStudTipX Tip X measurement.
2779  */
2781 
2782 /**
2783  * Returns a GoSurfaceStud Tip Y 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 GoSurfaceStudTipY Tip Y measurement.
2790  */
2792 
2793 /**
2794  * Returns a GoSurfaceStud Tip Z 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 GoSurfaceStudTipZ Tip Z measurement.
2801  */
2803 
2804 /**
2805  * Returns a GoSurfaceStud Radius 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 GoSurfaceStudRadius Radius measurement.
2812  */
2814 
2815 /**
2816 * Returns a GoSurfaceStud tip point feature 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 GoSurfaceStudTipPoint tip point feature .
2823 */
2825 
2826 /**
2827 * Returns a GoSurfaceStud base 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 GoSurfaceStudBasePoint base point feature.
2834 */
2836 
2837 /**
2838  * @class GoSurfaceVolume
2839  * @extends GoSurfaceTool
2840  * @note Supported with G2, G3
2841  * @ingroup GoSdk-SurfaceTools
2842  * @brief Represents a surface volume tool. measurements in mm, mm^2 for area and mm^3 for volume
2843  */
2845 
2846 /**
2847  * Gets the enabled state of the tool region.
2848  *
2849  * @public @memberof GoSurfaceVolume
2850  * @note Supported with G2, G3
2851  * @version Introduced in firmware 4.0.10.27
2852  * @param tool GoSurfaceVolume object.
2853  * @return kTRUE if enabled and kFALSE if disabled.
2854  */
2856 
2857 /**
2858  * Sets 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  * @param enable kTRUE to enable the tool region and kFALSE to disable it.
2865  */
2867 
2868 /**
2869  * Returns the tool region object.
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  * @return A GoRegion3d object.
2876  */
2878 
2879 /**
2880  * Returns a GoSurfaceVolume Volume measurement 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 GoSurfaceVolumeVolume Volume measurement.
2887  */
2889 
2890 /**
2891  * Returns a GoSurfaceVolume Area 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 GoSurfaceVolumeArea Area measurement.
2898  */
2900 
2901 /**
2902  * Returns a GoSurfaceVolume Thickness 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 GoSurfaceVolumeThickness Thickness measurement.
2909  */
2911 
2912 #include <GoSdk/Tools/GoSurfaceTools.x.h>
2913 
2914 #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.
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.
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.
Declares the base GoExtTool class.
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:1213
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 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.
GoSurfaceBoxZAngle GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Z Angle measurement object.
kStatus GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius)
Sets the nominal radius value.
Represents an extensible tool.
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.
GoSurfaceBoundingBoxCenterPoint GoSurfaceBox_CenterPoint(GoSurfaceBoundingBoxCenterPoint tool)
Returns a GoSurfaceBoundingBoxCenterPoint center point feature 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.
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.