Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoTools.h
Go to the documentation of this file.
1 /**
2  * @file GoTools.h
3  * @brief Declares the GoTool classes.
4  *
5  * @internal
6  * Copyright (C) 2011-2012 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_TOOLS_H
11 #define GO_TOOLS_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoTool.h>
15 
16 kBeginHeader()
17 
18 /**
19  * @class GoTools
20  * @extends kObject
21  * @ingroup GoSdk
22  * @brief Represents a ...
23  */
24 typedef kObject GoTools;
25 
26 GoFx(kSize) GoTools_ToolCount(GoTools tools);
27 GoFx(kObject) GoTools_ToolAt(GoTools tools, kSize index);
28 GoFx(GoTool) GoTools_AddTool(GoTools tools, GoToolType type);
29 GoFx(kStatus) GoTools_RemoveTool(GoTools, kSize index);
30 GoFx(kStatus) GoTools_ClearTools(GoTools tools);
31 GoFx(GoMeasurement) GoTools_FindMeasurementById(GoTool tools, k32u id);
32 
33 /**
34  * Given an enabled measurement with a negative ID, update the measurement to utilize a valid ID
35  *
36  * @public @memberof GoMeasurement
37  * @param tools GoTools object to use in order to get an available ID
38  * @param measurement GoMeasurement object to update.
39  * @return Operation status.
40  */
41 GoFx(kStatus) GoTools_AssignMeasurementId(GoTools tools, GoMeasurement measurement);
42 
43 
44 /**
45  * @class GoScript
46  * @extends GoTool
47  * @ingroup GoSdk
48  * @brief Represents a ...
49  */
50 typedef GoTool GoScript;
51 
52 /**
53  * Gets the code for the script.
54  *
55  * @public @memberof GoScript
56  * @param tool GoScript object.
57  * @param code Receives a null-terminated string containing the script code.
58  * @return Operation status.
59  */
60 GoFx(kStatus) GoScript_Code(GoScript tool, kChar** code);
61 
62 /**
63  * Sets the code for the script.
64  *
65  * @public @memberof GoScript
66  * @param tool GoScript object.
67  * @param code The code to set.
68  * @return Operation status.
69  */
70 GoFx(kStatus) GoScript_SetCode(GoScript tool, kChar* code);
71 
72 GoFx(kStatus) GoScript_AddOutput(GoScript tool, k32u id);
73 GoFx(kStatus) GoScript_RemoveOutput(GoScript tool, k32u id);
74 GoFx(kSize) GoScript_OutputCount(GoScript tool);
75 GoFx(GoMeasurement) GoScript_OutputAt(GoScript tool, kSize index);
76 
77 
78 /// @cond Gocator_1x00
79 
80 /**
81  * @class GoRangePosition
82  * @extends GoRangeTool
83  * @ingroup GoSdk
84  * @brief Represents a ...
85  */
86 typedef GoRangeTool GoRangePosition;
87 
88 /**
89  * Returns a GoRangePosition Z measurement object.
90  *
91  * @public @memberof GoRangePosition
92  * @param tool GoRangePosition object.
93  * @return A GoRangePosition Z measurement.
94  */
95 GoFx(GoMeasurement) GoRangePosition_ZMeasurement(GoRangePosition tool);
96 
97 /**
98  * @class GoRangeThickness
99  * @extends GoRangeTool
100  * @ingroup GoSdk
101  * @brief Represents a ...
102  */
103 typedef GoRangeTool GoRangeThickness;
104 
105 GoFx(kBool) GoRangeThickness_AbsoluteEnabled(GoRangeThickness tool);
106 GoFx(kStatus) GoRangeThickness_EnableAbsolute(GoRangeThickness tool, kBool enable);
107 
108 /**
109  * Returns a GoRangeThickness Thickness measurement object.
110  *
111  * @public @memberof GoRangeThickness
112  * @param tool GoRangeThickness object.
113  * @return A GoRangeThickness Thickness measurement.
114  */
115 GoFx(GoMeasurement) GoRangeThickness_ThicknessMeasurement(GoRangeThickness tool);
116 
117 /// @endcond
118 
119 
120 /// @cond Gocator_2x00
121 /**
122  * @class GoProfileArea
123  * @extends GoProfileTool
124  * @ingroup GoSdk
125  * @brief Represents a ...
126  */
128 
129 /**
130  * Gets the profile area baseline.
131  *
132  * @public @memberof GoProfileArea
133  * @param tool GoProfileArea object.
134  * @return The profile area baseline.
135  */
136 GoFx(GoProfileBaseline) GoProfileArea_Baseline(GoProfileArea tool);
137 
138 /**
139  * Sets the profile area type.
140  *
141  * @public @memberof GoProfileArea
142  * @param tool GoProfileArea object.
143  * @param type The baseline type to set.
144  * @return Operation status.
145  */
146 GoFx(kStatus) GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type);
147 
148 /**
149  * Returns a boolean representing whether the profile area baseline is used.
150  *
151  * @public @memberof GoProfileArea
152  * @param tool GoProfileArea object.
153  * @return kTRUE if the baseline is used; kFALSE otherwise.
154  */
155 GoFx(kBool) GoProfileArea_BaselineUsed(GoProfileArea tool);
156 
157 /**
158  * Gets the reference profile line.
159  *
160  * @public @memberof GoProfileArea
161  * @param tool GoProfileArea object.
162  * @return The reference profile line.
163  */
164 GoFx(GoProfileLineRegion) GoProfileArea_LineRegion(GoProfileArea tool);
165 
166 /**
167  * Gets the profile area type.
168  *
169  * @public @memberof GoProfileArea
170  * @param tool GoProfileArea object.
171  * @return The profile area type.
172  */
173 GoFx(GoProfileAreaType) GoProfileArea_Type(GoProfileArea tool);
174 
175 /**
176  * Gets the boolean representing whether the area type is used.
177  *
178  * @public @memberof GoProfileArea
179  * @param tool GoProfileArea object.
180  * @return kTRUE if profile area type is used; kFALSE otherwise.
181  */
182 GoFx(kBool) GoProfileArea_TypeUsed(GoProfileArea tool);
183 
184 /**
185  * Sets the profile area type.
186  *
187  * @public @memberof GoProfileArea
188  * @param tool GoProfileArea object.
189  * @param type GoProfileAreaType object.
190  * @return Operation status.
191  */
192 GoFx(kStatus) GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type);
193 
194 /**
195  * Gets the profile region.
196  *
197  * @public @memberof GoProfileArea
198  * @param tool GoProfileArea object.
199  * @return The profile region.
200  */
201 GoFx(GoProfileRegion) GoProfileArea_Region(GoProfileArea tool);
202 
203 /**
204  * Returns a GoProfileArea Area measurement object.
205  *
206  * @public @memberof GoProfileArea
207  * @param tool GoProfileArea object.
208  * @return A GoProfileArea Area measurement.
209  */
210 GoFx(GoMeasurement) GoProfileArea_AreaMeasurement(GoProfileArea tool);
211 
212 /**
213  * Returns a GoProfileArea CentroidX measurement object.
214  *
215  * @public @memberof GoProfileArea
216  * @param tool GoProfileArea object.
217  * @return A GoProfileArea CentroidX measurement.
218  */
219 GoFx(GoMeasurement) GoProfileArea_CentroidXMeasurement(GoProfileArea tool);
220 
221 /**
222  * Returns a GoProfileArea CentroidZ measurement object.
223  *
224  * @public @memberof GoProfileArea
225  * @param tool GoProfileArea object.
226  * @return A GoProfileArea CentroidZ measurement.
227  */
228 GoFx(GoMeasurement) GoProfileArea_CentroidZMeasurement(GoProfileArea tool);
229 
230 
231 /**
232  * @class GoProfileCircle
233  * @extends GoProfileTool
234  * @ingroup GoSdk
235  * @brief Represents a ...
236  */
238 
239 /**
240  * Gets the profile region.
241  *
242  * @public @memberof GoProfileCircle
243  * @param tool GoProfileCircle object.
244  * @return The profile region.
245  */
246 GoFx(GoProfileRegion) GoProfileCircle_Region(GoProfileCircle tool);
247 
248 /**
249  * Returns a GoProfileCircle X measurement object.
250  *
251  * @public @memberof GoProfileCircle
252  * @param tool GoProfileCircle object.
253  * @return A GoProfileCircle X measurement.
254  */
255 GoFx(GoMeasurement) GoProfileCircle_XMeasurement(GoProfileCircle tool);
256 
257 /**
258  * Returns a GoProfileCircle Z measurement object.
259  *
260  * @public @memberof GoProfileCircle
261  * @param tool GoProfileCircle object.
262  * @return A GoProfileCircle Z measurement.
263  */
264 GoFx(GoMeasurement) GoProfileCircle_ZMeasurement(GoProfileCircle tool);
265 
266 /**
267  * Returns a GoProfileCircle Radius measurement object.
268  *
269  * @public @memberof GoProfileCircle
270  * @param tool GoProfileCircle object.
271  * @return A GoProfileCircle Radius measurement.
272  */
273 GoFx(GoMeasurement) GoProfileCircle_RadiusMeasurement(GoProfileCircle tool);
274 
275 
276 /**
277  * @class GoProfileDim
278  * @extends GoProfileTool
279  * @ingroup GoSdk
280  * @brief Represents a ...
281  */
282 typedef GoProfileTool GoProfileDim;
283 
284 
285 /**
286  * Gets the reference profile feature.
287  *
288  * @public @memberof GoProfileDim
289  * @param tool GoProfileDim object.
290  * @return The profile feature.
291  */
292 GoFx(GoProfileFeature) GoProfileDim_RefFeature(GoProfileDim tool);
293 
294 /**
295  * Gets the non-reference profile feature.
296  *
297  * @public @memberof GoProfileDim
298  * @param tool GoProfileDim object.
299  * @return
300  */
301 GoFx(GoProfileFeature) GoProfileDim_Feature(GoProfileDim tool);
302 
303 /**
304  * Returns a GoProfileDim Width measurement object.
305  *
306  * @public @memberof GoProfileDim
307  * @param tool GoProfileDim object.
308  * @return A GoProfileDim Width measurement.
309  */
310 GoFx(GoMeasurement) GoProfileDim_WidthMeasurement(GoProfileDim tool);
311 
312 /**
313  * Returns a GoProfileDim Height measurement object.
314  *
315  * @public @memberof GoProfileDim
316  * @param tool GoProfileDim object.
317  * @return A GoProfileDim Height measurement.
318  */
319 GoFx(GoMeasurement) GoProfileDim_HeightMeasurement(GoProfileDim tool);
320 
321 /**
322  * Returns a GoProfileDim Distance measurement object.
323  *
324  * @public @memberof GoProfileDim
325  * @param tool GoProfileDim object.
326  * @return A GoProfileDim Distance measurement.
327  */
328 GoFx(GoMeasurement) GoProfileDim_DistanceMeasurement(GoProfileDim tool);
329 
330 /**
331  * Returns a GoProfileDim CenterX measurement object.
332  *
333  * @public @memberof GoProfileDim
334  * @param tool GoProfileDim object.
335  * @return A GoProfileDim CenterX measurement.
336  */
337 GoFx(GoMeasurement) GoProfileDim_CenterXMeasurement(GoProfileDim tool);
338 
339 /**
340  * Returns a GoProfileDim CenterZ measurement object.
341  *
342  * @public @memberof GoProfileDim
343  * @param tool GoProfileDim object.
344  * @return A GoProfileDim CenterZ measurement.
345  */
346 GoFx(GoMeasurement) GoProfileDim_CenterZMeasurement(GoProfileDim tool);
347 
348 
349 /**
350  * @class GoProfileGroove
351  * @extends GoProfileTool
352  * @ingroup GoSdk
353  * @brief Represents a ...
354  */
356 
357 GoFx(kStatus) GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement* measurement);
358 GoFx(kStatus) GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, k32u index);
359 GoFx(kSize) GoProfileGroove_MeasurementCount(GoProfileGroove tool);
360 GoFx(GoMeasurement) GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index);
361 
362 
363 /**
364  * Gets the current groove determination shape.
365  *
366  * @public @memberof GoProfileGroove
367  * @param tool GoProfileGroove object.
368  * @return The profile groove shape.
369  */
370 GoFx(GoProfileGrooveShape) GoProfileGroove_Shape(GoProfileGroove tool);
371 
372 /**
373  * Sets the groove determination shape.
374  *
375  * @public @memberof GoProfileGroove
376  * @param tool GoProfileGroove object.
377  * @param shape The intended profile groove shape.
378  * @return Operation status.
379  */
380 GoFx(kStatus) GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape);
381 
382 /**
383  * Gets the groove depth minimum.
384  *
385  * @public @memberof GoProfileGroove
386  * @param tool GoProfileGroove object.
387  * @return The groove depth minimum value.
388  */
389 GoFx(k64f) GoProfileGroove_MinDepth(GoProfileGroove tool);
390 
391 /**
392  * Sets the groove depth minimum.
393  *
394  * @public @memberof GoProfileGroove
395  * @param tool GoProfileGroove object.
396  * @param depth The minimum groove depth value to set.
397  * @return Operation status.
398  */
399 GoFx(kStatus) GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth);
400 
401 /**
402  * Gets the groove width maximum.
403  *
404  * @public @memberof GoProfileGroove
405  * @param tool GoProfileGroove object.
406  * @return The groove width maximum value.
407  */
408 GoFx(k64f) GoProfileGroove_MaxWidth(GoProfileGroove tool);
409 
410 /**
411  * Sets the groove width maximum.
412  *
413  * @public @memberof GoProfileGroove
414  * @param tool GoProfileGroove object.
415  * @param width The maximum groove width value to set.
416  * @return Operation status.
417  */
418 GoFx(kStatus) GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width);
419 
420 /**
421  * Gets the groove width minimum value.
422  *
423  * @public @memberof GoProfileGroove
424  * @param tool GoProfileGroove object.
425  * @return The groove width minimum.
426  */
427 GoFx(k64f) GoProfileGroove_MinWidth(GoProfileGroove tool);
428 
429 /**
430  * Sets the groove width minimum.
431  *
432  * @public @memberof GoProfileGroove
433  * @param tool GoProfileGroove object.
434  * @param width The minimum groove width value to set.
435  * @return Operation status.
436  */
437 GoFx(kStatus) GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width);
438 
439 /**
440  * Gets the profile region.
441  *
442  * @public @memberof GoProfileGroove
443  * @param tool GoProfileGroove object.
444  * @return The profile region.
445  */
446 GoFx(GoProfileRegion) GoProfileGroove_Region(GoProfileGroove tool);
447 
448 
449 /**
450  * @class GoProfileIntersect
451  * @extends GoProfileTool
452  * @ingroup GoSdk
453  * @brief Represents a ...
454  */
456 
457 
458 /**
459  * Gets the reference profile line type.
460  *
461  * @public @memberof GoProfileIntersect
462  * @param tool GoProfileIntersect object.
463  * @return The profile line type.
464  */
465 GoFx(GoProfileBaseline) GoProfileIntersect_RefLineType(GoProfileIntersect tool);
466 
467 /**
468  * Sets the reference line type.
469  *
470  * @public @memberof GoProfileIntersect
471  * @param tool GoProfileIntersect object.
472  * @param type The line type to set.
473  * @return
474  */
475 GoFx(kStatus) GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type);
476 
477 /**
478  * Gets the reference profile line.
479  *
480  * @public @memberof GoProfileIntersect
481  * @param tool GoProfileIntersect object.
482  * @return The reference profile line.
483  */
484 GoFx(GoProfileLineRegion) GoProfileIntersect_RefLine(GoProfileIntersect tool);
485 
486 /**
487  * Gets the non-reference profile line.
488  *
489  * @public @memberof GoProfileIntersect
490  * @param tool GoProfileIntersect object.
491  * @return The non-reference profile line.
492  */
493 GoFx(GoProfileLineRegion) GoProfileIntersect_Line(GoProfileIntersect tool);
494 
495 /**
496  * Returns a GoProfileIntersect X measurement object.
497  *
498  * @public @memberof GoProfileIntersect
499  * @param tool GoProfileIntersect object.
500  * @return A GoProfileIntersect X measurement.
501  */
502 GoFx(GoMeasurement) GoProfileIntersect_XMeasurement(GoProfileIntersect tool);
503 
504 /**
505  * Returns a GoProfileIntersect Z measurement object.
506  *
507  * @public @memberof GoProfileIntersect
508  * @param tool GoProfileIntersect object.
509  * @return A GoProfileIntersect Z measurement.
510  */
511 GoFx(GoMeasurement) GoProfileIntersect_ZMeasurement(GoProfileIntersect tool);
512 
513 /**
514  * Returns a GoProfileIntersect Angle measurement object.
515  *
516  * @public @memberof GoProfileIntersect
517  * @param tool GoProfileIntersect object.
518  * @return A GoProfileIntersect Angle measurement.
519  */
520 GoFx(GoMeasurement) GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool);
521 
522 
523 /**
524  * @class GoProfileLine
525  * @extends GoProfileTool
526  * @ingroup GoSdk
527  * @brief Represents a ...
528  */
530 
531 /**
532  * Gets the profile region.
533  *
534  * @public @memberof GoProfileDev
535  * @param tool GoProfileDev object.
536  * @return The profile region.
537  */
538 GoFx(GoProfileRegion) GoProfileLine_Region(GoProfileLine tool);
539 
540 /**
541  * Returns a GoProfileLine StdDev measurement object.
542  *
543  * @public @memberof GoProfileLine
544  * @param tool GoProfileLine object.
545  * @return A GoProfileLine StdDev measurement.
546  */
547 GoFx(GoMeasurement) GoProfileLine_StdDevMeasurement(GoProfileLine tool);
548 
549 /**
550  * Returns a GoProfileLine MaxError measurement object.
551  *
552  * @public @memberof GoProfileLine
553  * @param tool GoProfileLine object.
554  * @return A GoProfileLine MaxError measurement.
555  */
556 GoFx(GoMeasurement) GoProfileLine_MaxErrorMeasurement(GoProfileLine tool);
557 
558 /**
559  * Returns a GoProfileLine MinError measurement object.
560  *
561  * @public @memberof GoProfileLine
562  * @param tool GoProfileLine object.
563  * @return A GoProfileLine MinError measurement.
564  */
565 GoFx(GoMeasurement) GoProfileLine_MinErrorMeasurement(GoProfileLine tool);
566 
567 /**
568  * Returns a GoProfileLine Percentile measurement object.
569  *
570  * @public @memberof GoProfileLine
571  * @param tool GoProfileLine object.
572  * @return A GoProfileLine Percentile measurement.
573  */
574 GoFx(GoMeasurement) GoProfileLine_PercentileMeasurement(GoProfileLine tool);
575 
576 
577 /**
578  * @class GoProfilePanel
579  * @extends GoProfileTool
580  * @ingroup GoSdk
581  * @brief Represents a ...
582  */
584 
585 /**
586  * Gets the maximum gap width.
587  *
588  * @public @memberof GoProfilePanel
589  * @param tool GoProfilePanel object.
590  * @return The maximum gap width.
591  */
592 GoFx(k64f) GoProfilePanel_MaxGapWidth(GoProfilePanel tool);
593 
594 /**
595  * Sets the maximum gap width.
596  *
597  * @public @memberof GoProfilePanel
598  * @param tool GoProfilePanel object.
599  * @param width The maximum gap width value to set.
600  * @return Operation status.
601  */
602 GoFx(kStatus) GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width);
603 
604 /**
605  * Gets the reference edge side.
606  *
607  * @public @memberof GoProfilePanel
608  * @param tool GoProfilePanel object.
609  * @return The reference edge side.
610  */
611 GoFx(GoProfilePanelSide) GoProfilePanel_RefEdgeSide(GoProfilePanel tool);
612 
613 /**
614  * Sets the reference edge side.
615  *
616  * @public @memberof GoProfilePanel
617  * @param tool GoProfilePanel object.
618  * @param side The reference edge side.
619  * @return Operation status.
620  */
621 GoFx(kStatus) GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side);
622 
623 /**
624  * Gets the left profile edge.
625  *
626  * @public @memberof GoProfilePanel
627  * @param tool GoProfilePanel object.
628  * @return The left profile edge.
629  */
630 GoFx(GoProfileEdge) GoProfilePanel_LeftEdge(GoProfilePanel tool);
631 
632 /**
633  * Gets the right profile edge.
634  *
635  * @public @memberof GoProfilePanel
636  * @param tool GoProfilePanel object.
637  * @return The right profile edge.
638  */
639 GoFx(GoProfileEdge) GoProfilePanel_RightEdge(GoProfilePanel tool);
640 
641 /**
642  * Returns a GoProfilePanel Gap measurement object.
643  *
644  * @public @memberof GoProfilePanel
645  * @param tool GoProfilePanel object.
646  * @return A GoProfilePanel Gap measurement.
647  */
648 GoFx(GoMeasurement) GoProfilePanel_GapMeasurement(GoProfilePanel tool);
649 
650 /**
651  * Returns a GoProfilePanel Flush measurement object.
652  *
653  * @public @memberof GoProfilePanel
654  * @param tool GoProfilePanel object.
655  * @return A GoProfilePanel Flush measurement.
656  */
657 GoFx(GoMeasurement) GoProfilePanel_FlushMeasurement(GoProfilePanel tool);
658 
659 
660 /**
661  * @class GoProfilePosition
662  * @extends GoProfileTool
663  * @ingroup GoSdk
664  * @brief Represents a ...
665  */
667 
668 /**
669  * Gets the profile feature.
670  *
671  * @public @memberof GoProfilePosition
672  * @param tool GoProfilePos object.
673  * @return The profile feature.
674  */
675 GoFx(GoProfileFeature) GoProfilePosition_Feature(GoProfilePosition tool);
676 
677 /**
678  * Returns a GoProfilePosition X measurement object.
679  *
680  * @public @memberof GoProfilePosition
681  * @param tool GoProfilePosition object.
682  * @return A GoProfilePosition X measurement.
683  */
684 GoFx(GoMeasurement) GoProfilePosition_XMeasurement(GoProfilePosition tool);
685 
686 /**
687  * Returns a GoProfilePosition Z measurement object.
688  *
689  * @public @memberof GoProfilePosition
690  * @param tool GoProfilePosition object.
691  * @return A GoProfilePosition Z measurement.
692  */
693 GoFx(GoMeasurement) GoProfilePosition_ZMeasurement(GoProfilePosition tool);
694 
695 
696 /**
697  * @class GoProfileStrip
698  * @extends GoProfileTool
699  * @ingroup GoSdk
700  * @brief Represents a ...
701  */
703 
704 GoFx(kStatus) GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type);
705 GoFx(GoProfileStripBaseType) GoProfileStrip_BaseType(GoProfileStrip tool);
706 
707 GoFx(k8u) GoProfileStrip_LeftEdge(GoProfileStrip tool);
708 GoFx(kStatus) GoProfileStrip_SetLeftEdge(GoProfileStrip tool, k8u leftEdge);
709 
710 GoFx(k8u) GoProfileStrip_RightEdge(GoProfileStrip tool);
711 GoFx(kStatus) GoProfileStrip_SetRightEdge(GoProfileStrip tool, k8u rightEdge);
712 
713 GoFx(kBool) GoProfileStrip_TiltEnabled(GoProfileStrip tool);
714 GoFx(kStatus) GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable);
715 
716 GoFx(k64f) GoProfileStrip_TransitionWidth(GoProfileStrip tool);
717 GoFx(kStatus) GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value);
718 
719 GoFx(k64f) GoProfileStrip_MinWidth(GoProfileStrip tool);
720 GoFx(kStatus) GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value);
721 
722 GoFx(k64f) GoProfileStrip_MinHeight(GoProfileStrip tool);
723 GoFx(kStatus) GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value);
724 
725 GoFx(k64f) GoProfileStrip_MaxVoidWidth(GoProfileStrip tool);
726 GoFx(kStatus) GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value);
727 
728 GoFx(GoProfileRegion) GoProfileStrip_Region(GoProfileStrip tool);
729 
730 GoFx(kStatus) GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement* measurement);
731 GoFx(kStatus) GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, k32u index);
732 GoFx(kSize) GoProfileStrip_MeasurementCount(GoProfileStrip tool);
733 GoFx(GoMeasurement) GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index);
734 
735 /// @endcond
736 
737 
738 /// @cond (Gocator_2x00 || Gocator_3x00)
739 
740 /**
741  * @class GoSurfaceBox
742  * @extends GoSurfaceTool
743  * @ingroup GoSdk
744  * @brief Represents a ...
745  */
746 typedef GoSurfaceTool GoSurfaceBox;
747 
748 GoFx(kBool) GoSurfaceBox_ZRotationEnabled(GoSurfaceBox tool);
749 GoFx(kStatus) GoSurfaceBox_EnableZRotation(GoSurfaceBox tool, kBool enable);
750 GoFx(kBool) GoSurfaceBox_RegionEnabled(GoSurfaceBox tool);
751 GoFx(kStatus) GoSurfaceBox_EnableRegion(GoSurfaceBox box, kBool enable);
752 GoFx(GoRegion3d) GoSurfaceBox_Region(GoSurfaceBox box);
753 
754 /**
755  * Returns a GoSurfaceBox X measurement object.
756  *
757  * @public @memberof GoSurfaceBox
758  * @param tool GoSurfaceBox object.
759  * @return A GoSurfaceBox X measurement.
760  */
761 GoFx(GoMeasurement) GoSurfaceBox_XMeasurement(GoSurfaceBox tool);
762 
763 /**
764  * Returns a GoSurfaceBox Y measurement object.
765  *
766  * @public @memberof GoSurfaceBox
767  * @param tool GoSurfaceBox object.
768  * @return A GoSurfaceBox Y measurement.
769  */
770 GoFx(GoMeasurement) GoSurfaceBox_YMeasurement(GoSurfaceBox tool);
771 
772 /**
773  * Returns a GoSurfaceBox Z measurement object.
774  *
775  * @public @memberof GoSurfaceBox
776  * @param tool GoSurfaceBox object.
777  * @return A GoSurfaceBox Z measurement.
778  */
779 GoFx(GoMeasurement) GoSurfaceBox_ZMeasurement(GoSurfaceBox tool);
780 
781 /**
782  * Returns a GoSurfaceBox Width measurement object.
783  *
784  * @public @memberof GoSurfaceBox
785  * @param tool GoSurfaceBox object.
786  * @return A GoSurfaceBox Width measurement.
787  */
788 GoFx(GoMeasurement) GoSurfaceBox_WidthMeasurement(GoSurfaceBox tool);
789 
790 /**
791  * Returns a GoSurfaceBox Length measurement object.
792  *
793  * @public @memberof GoSurfaceBox
794  * @param tool GoSurfaceBox object.
795  * @return A GoSurfaceBox Length measurement.
796  */
797 GoFx(GoMeasurement) GoSurfaceBox_LengthMeasurement(GoSurfaceBox tool);
798 
799 /**
800  * Returns a GoSurfaceBox Height measurement object.
801  *
802  * @public @memberof GoSurfaceBox
803  * @param tool GoSurfaceBox object.
804  * @return A GoSurfaceBox Height measurement.
805  */
806 GoFx(GoMeasurement) GoSurfaceBox_HeightMeasurement(GoSurfaceBox tool);
807 
808 /**
809  * Returns a GoSurfaceBox ZAngle measurement object.
810  *
811  * @public @memberof GoSurfaceBox
812  * @param tool GoSurfaceBox object.
813  * @return A GoSurfaceBox ZAngle measurement.
814  */
815 GoFx(GoMeasurement) GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool);
816 
817 /**
818  * Returns a GoSurfaceBox global X measurement object.
819  *
820  * @public @memberof GoSurfaceBox
821  * @param tool GoSurfaceBox object.
822  * @return A GoSurfaceBox global X measurement.
823  */
824 GoFx(GoMeasurement) GoSurfaceBox_GlobalXMeasurement(GoSurfaceBox tool);
825 
826 /**
827  * Returns a GoSurfaceBox global Y measurement object.
828  *
829  * @public @memberof GoSurfaceBox
830  * @param tool GoSurfaceBox object.
831  * @return A GoSurfaceBox global Y measurement.
832  */
833 GoFx(GoMeasurement) GoSurfaceBox_GlobalYMeasurement(GoSurfaceBox tool);
834 
835 /**
836  * @class GoSurfaceEllipse
837  * @extends GoSurfaceTool
838  * @ingroup GoSdk
839  * @brief Represents a ...
840  */
842 
843 GoFx(kStatus) GoSurfaceEllipse_EnableRegion(GoSurfaceEllipse tool, kBool enable);
844 GoFx(kBool) GoSurfaceEllipse_RegionEnabled(GoSurfaceEllipse tool);
845 GoFx(GoRegion3d) GoSurfaceEllipse_Region(GoSurfaceEllipse tool);
846 
847 /**
848  * Returns a GoSurfaceEllipse Major measurement object.
849  *
850  * @public @memberof GoSurfaceEllipse
851  * @param tool GoSurfaceEllipse object.
852  * @return A GoSurfaceEllipse Major measurement.
853  */
854 GoFx(GoMeasurement) GoSurfaceEllipse_MajorMeasurement(GoSurfaceEllipse tool);
855 
856 /**
857  * Returns a GoSurfaceEllipse Minor measurement object.
858  *
859  * @public @memberof GoSurfaceEllipse
860  * @param tool GoSurfaceEllipse object.
861  * @return A GoSurfaceEllipse Minor measurement.
862  */
863 GoFx(GoMeasurement) GoSurfaceEllipse_MinorMeasurement(GoSurfaceEllipse tool);
864 
865 /**
866  * Returns a GoSurfaceEllipse Ratio measurement object.
867  *
868  * @public @memberof GoSurfaceEllipse
869  * @param tool GoSurfaceEllipse object.
870  * @return A GoSurfaceEllipse Ratio measurement.
871  */
872 GoFx(GoMeasurement) GoSurfaceEllipse_RatioMeasurement(GoSurfaceEllipse tool);
873 
874 /**
875  * Returns a GoSurfaceEllipse ZAngle measurement object.
876  *
877  * @public @memberof GoSurfaceEllipse
878  * @param tool GoSurfaceEllipse object.
879  * @return A GoSurfaceEllipse ZAngle measurement.
880  */
881 GoFx(GoMeasurement) GoSurfaceEllipse_ZAngleMeasurement(GoSurfaceEllipse tool);
882 
883 
884 /**
885  * @class GoSurfaceHole
886  * @extends GoSurfaceTool
887  * @ingroup GoSdk
888  * @brief Represents a ...
889  */
891 
892 GoFx(k64f) GoSurfaceHole_NominalRadius(GoSurfaceHole tool);
893 GoFx(kStatus) GoSurfaceHole_SetNominalRadius(GoSurfaceHole tool, k64f nominalRadius);
894 
895 GoFx(k64f) GoSurfaceHole_RadiusTolerance(GoSurfaceHole tool);
896 GoFx(kStatus) GoSurfaceHole_SetRadiusTolerance(GoSurfaceHole tool, k64f radiusTolerance);
897 
898 GoFx(kBool) GoSurfaceHole_PartialDetectionEnabled(GoSurfaceHole tool);
899 GoFx(kStatus) GoSurfaceHole_EnablePartialDetection(GoSurfaceHole tool, kBool enable);
900 
901 GoFx(kBool) GoSurfaceHole_RegionEnabled(GoSurfaceHole tool);
902 GoFx(kStatus) GoSurfaceHole_EnableRegion(GoSurfaceHole tool, kBool enable);
903 
904 GoFx(GoRegion3d) GoSurfaceHole_Region(GoSurfaceHole tool);
905 
906 GoFx(kBool) GoSurfaceHole_RefRegionsEnabled(GoSurfaceHole tool);
907 GoFx(kStatus) GoSurfaceHole_EnableRefRegions(GoSurfaceHole tool, kBool enable);
908 
909 GoFx(k16u) GoSurfaceHole_RefRegionCount(GoSurfaceHole tool);
910 GoFx(kStatus) GoSurfaceHole_SetRefRegionCount(GoSurfaceHole tool, kSize count);
911 
912 GoFx(GoSurfaceRegion2d) GoSurfaceHole_RefRegionAt(GoSurfaceHole tool, kSize index);
913 
914 GoFx(kBool) GoSurfaceHole_AutoTiltEnabled(GoSurfaceHole tool);
915 GoFx(kStatus) GoSurfaceHole_EnableAutoTilt(GoSurfaceHole tool, kBool enable);
916 
917 GoFx(k64f) GoSurfaceHole_TiltXAngle(GoSurfaceHole tool);
918 GoFx(kStatus) GoSurfaceHole_SetTiltXAngle(GoSurfaceHole tool, k64f value);
919 
920 GoFx(k64f) GoSurfaceHole_TiltYAngle(GoSurfaceHole tool);
921 GoFx(kStatus) GoSurfaceHole_SetTiltYAngle(GoSurfaceHole tool, k64f value);
922 
923 /**
924  * Returns a GoSurfaceHole X measurement object.
925  *
926  * @public @memberof GoSurfaceHole
927  * @param tool GoSurfaceHole object.
928  * @return A GoSurfaceHole X measurement.
929  */
930 GoFx(GoMeasurement) GoSurfaceHole_XMeasurement(GoSurfaceHole tool);
931 
932 /**
933  * Returns a GoSurfaceHole Y measurement object.
934  *
935  * @public @memberof GoSurfaceHole
936  * @param tool GoSurfaceHole object.
937  * @return A GoSurfaceHole Y measurement.
938  */
939 GoFx(GoMeasurement) GoSurfaceHole_YMeasurement(GoSurfaceHole tool);
940 
941 /**
942  * Returns a GoSurfaceHole Z measurement object.
943  *
944  * @public @memberof GoSurfaceHole
945  * @param tool GoSurfaceHole object.
946  * @return A GoSurfaceHole Z measurement.
947  */
948 GoFx(GoMeasurement) GoSurfaceHole_ZMeasurement(GoSurfaceHole tool);
949 
950 /**
951  * Returns a GoSurfaceHole Radius measurement object.
952  *
953  * @public @memberof GoSurfaceHole
954  * @param tool GoSurfaceHole object.
955  * @return A GoSurfaceHole Radius measurement.
956  */
957 GoFx(GoMeasurement) GoSurfaceHole_RadiusMeasurement(GoSurfaceHole tool);
958 
959 
960 /**
961  * @class GoSurfaceOpening
962  * @extends GoSurfaceTool
963  * @ingroup GoSdk
964  * @brief Represents a ...
965  */
967 
968 GoFx(GoSurfaceOpeningType) GoSurfaceOpening_Type(GoSurfaceOpening tool);
969 
970 GoFx(k64f) GoSurfaceOpening_NominalWidth(GoSurfaceOpening tool);
971 GoFx(kStatus) GoSurfaceOpening_SetNominalWidth(GoSurfaceOpening tool, k64f value);
972 
973 GoFx(k64f) GoSurfaceOpening_NominalLength(GoSurfaceOpening tool);
974 GoFx(kStatus) GoSurfaceOpening_SetNominalLength(GoSurfaceOpening tool, k64f value);
975 
976 GoFx(k64f) GoSurfaceOpening_NominalAngle(GoSurfaceOpening tool);
977 GoFx(kStatus) GoSurfaceOpening_SetNominalAngle(GoSurfaceOpening tool, k64f value);
978 
979 GoFx(k64f) GoSurfaceOpening_NominalRadius(GoSurfaceOpening tool);
980 GoFx(kStatus) GoSurfaceOpening_SetNominalRadius(GoSurfaceOpening tool, k64f value);
981 
982 GoFx(k64f) GoSurfaceOpening_WidthTolerance(GoSurfaceOpening tool);
983 GoFx(kStatus) GoSurfaceOpening_SetWidthTolerance(GoSurfaceOpening tool, k64f value);
984 
985 GoFx(k64f) GoSurfaceOpening_LengthTolerance(GoSurfaceOpening tool);
986 GoFx(kStatus) GoSurfaceOpening_SetLengthTolerance(GoSurfaceOpening tool, k64f value);
987 
988 GoFx(k64f) GoSurfaceOpening_AngleTolerance(GoSurfaceOpening tool);
989 GoFx(kStatus) GoSurfaceOpening_SetAngleTolerance(GoSurfaceOpening tool, k64f value);
990 
991 GoFx(kBool) GoSurfaceOpening_PartialDetectionEnabled(GoSurfaceOpening tool);
992 GoFx(kStatus) GoSurfaceOpening_EnablePartialDetection(GoSurfaceOpening tool, kBool enable);
993 
994 GoFx(kBool) GoSurfaceOpening_RegionEnabled(GoSurfaceOpening tool);
995 GoFx(kStatus) GoSurfaceOpening_EnableRegion(GoSurfaceOpening tool, kBool enable);
996 
997 GoFx(GoRegion3d) GoSurfaceOpening_Region(GoSurfaceOpening tool);
998 
999 GoFx(kBool) GoSurfaceOpening_RefRegionsEnabled(GoSurfaceOpening tool);
1000 GoFx(kStatus) GoSurfaceOpening_EnableRefRegions(GoSurfaceOpening tool, kBool enable);
1001 
1002 GoFx(k16u) GoSurfaceOpening_RefRegionCount(GoSurfaceOpening tool);
1003 GoFx(kStatus) GoSurfaceOpening_SetRefRegionCount(GoSurfaceOpening tool, kSize count);
1004 
1005 GoFx(GoSurfaceRegion2d) GoSurfaceOpening_RefRegionAt(GoSurfaceOpening tool, kSize index);
1006 
1007 GoFx(kBool) GoSurfaceOpening_AutoTiltEnabled(GoSurfaceOpening tool);
1008 GoFx(kStatus) GoSurfaceOpening_EnableAutoTilt(GoSurfaceOpening tool, kBool enable);
1009 
1010 GoFx(k64f) GoSurfaceOpening_TiltXAngle(GoSurfaceOpening tool);
1011 GoFx(kStatus) GoSurfaceOpening_SetTiltXAngle(GoSurfaceOpening tool, k64f value);
1012 
1013 GoFx(k64f) GoSurfaceOpening_TiltYAngle(GoSurfaceOpening tool);
1014 GoFx(kStatus) GoSurfaceOpening_SetTiltYAngle(GoSurfaceOpening tool, k64f value);
1015 
1016 /**
1017  * Returns a GoSurfaceOpening X measurement object.
1018  *
1019  * @public @memberof GoSurfaceOpening
1020  * @param tool GoSurfaceOpening object.
1021  * @return A GoSurfaceOpening X measurement.
1022  */
1023 GoFx(GoMeasurement) GoSurfaceOpening_XMeasurement(GoSurfaceOpening tool);
1024 
1025 /**
1026  * Returns a GoSurfaceOpening Y measurement object.
1027  *
1028  * @public @memberof GoSurfaceOpening
1029  * @param tool GoSurfaceOpening object.
1030  * @return A GoSurfaceOpening Y measurement.
1031  */
1032 GoFx(GoMeasurement) GoSurfaceOpening_YMeasurement(GoSurfaceOpening tool);
1033 
1034 /**
1035  * Returns a GoSurfaceOpening Z measurement object.
1036  *
1037  * @public @memberof GoSurfaceOpening
1038  * @param tool GoSurfaceOpening object.
1039  * @return A GoSurfaceOpening Z measurement.
1040  */
1041 GoFx(GoMeasurement) GoSurfaceOpening_ZMeasurement(GoSurfaceOpening tool);
1042 
1043 /**
1044  * Returns a GoSurfaceOpening Width measurement object.
1045  *
1046  * @public @memberof GoSurfaceOpening
1047  * @param tool GoSurfaceOpening object.
1048  * @return A GoSurfaceOpening Width measurement.
1049  */
1050 GoFx(GoMeasurement) GoSurfaceOpening_WidthMeasurement(GoSurfaceOpening tool);
1051 
1052 /**
1053  * Returns a GoSurfaceOpening Length measurement object.
1054  *
1055  * @public @memberof GoSurfaceOpening
1056  * @param tool GoSurfaceOpening object.
1057  * @return A GoSurfaceOpening Length measurement.
1058  */
1059 GoFx(GoMeasurement) GoSurfaceOpening_LengthMeasurement(GoSurfaceOpening tool);
1060 
1061 /**
1062  * Returns a GoSurfaceOpening Angle measurement object.
1063  *
1064  * @public @memberof GoSurfaceOpening
1065  * @param tool GoSurfaceOpening object.
1066  * @return A GoSurfaceOpening Angle measurement.
1067  */
1068 GoFx(GoMeasurement) GoSurfaceOpening_AngleMeasurement(GoSurfaceOpening tool);
1069 
1070 
1071 /**
1072  * @class GoSurfacePlane
1073  * @extends GoSurfaceTool
1074  * @ingroup GoSdk
1075  * @brief Represents a ...
1076  */
1077 typedef GoSurfaceTool GoSurfacePlane;
1078 
1079 GoFx(kBool) GoSurfacePlane_RegionsEnabled(GoSurfacePlane tool);
1080 GoFx(kStatus) GoSurfacePlane_EnableRegions(GoSurfacePlane tool, kBool enable);
1081 
1082 GoFx(k16u) GoSurfacePlane_RegionCount(GoSurfacePlane tool);
1083 GoFx(kStatus) GoSurfacePlane_SetRegionCount(GoSurfacePlane tool, kSize count);
1084 
1085 GoFx(GoRegion3d) GoSurfacePlane_RegionAt(GoSurfacePlane tool, kSize index);
1086 
1087 /**
1088  * Returns a GoSurfacePlane XAngle measurement object.
1089  *
1090  * @public @memberof GoSurfacePlane
1091  * @param tool GoSurfacePlane object.
1092  * @return A GoSurfacePlane XAngle measurement.
1093  */
1094 GoFx(GoMeasurement) GoSurfacePlane_XAngleMeasurement(GoSurfacePlane tool);
1095 
1096 /**
1097  * Returns a GoSurfacePlane YAngle measurement object.
1098  *
1099  * @public @memberof GoSurfacePlane
1100  * @param tool GoSurfacePlane object.
1101  * @return A GoSurfacePlane YAngle measurement.
1102  */
1103 GoFx(GoMeasurement) GoSurfacePlane_YAngleMeasurement(GoSurfacePlane tool);
1104 
1105 /**
1106  * Returns a GoSurfacePlane ZOffset measurement object.
1107  *
1108  * @public @memberof GoSurfacePlane
1109  * @param tool GoSurfacePlane object.
1110  * @return A GoSurfacePlane ZOffset measurement.
1111  */
1112 GoFx(GoMeasurement) GoSurfacePlane_ZOffsetMeasurement(GoSurfacePlane tool);
1113 
1114 
1115 /**
1116  * @class GoSurfacePosition
1117  * @extends GoSurfaceTool
1118  * @ingroup GoSdk
1119  * @brief Represents a ...
1120  */
1122 
1123 GoFx(GoSurfaceFeature) GoSurfacePosition_Feature(GoSurfacePosition tool);
1124 
1125 /**
1126  * Returns a GoSurfacePosition X measurement object.
1127  *
1128  * @public @memberof GoSurfacePosition
1129  * @param tool GoSurfacePosition object.
1130  * @return A GoSurfacePosition X measurement.
1131  */
1132 GoFx(GoMeasurement) GoSurfacePosition_XMeasurement(GoSurfacePosition tool);
1133 
1134 /**
1135  * Returns a GoSurfacePosition Y measurement object.
1136  *
1137  * @public @memberof GoSurfacePosition
1138  * @param tool GoSurfacePosition object.
1139  * @return A GoSurfacePosition Y measurement.
1140  */
1141 GoFx(GoMeasurement) GoSurfacePosition_YMeasurement(GoSurfacePosition tool);
1142 
1143 /**
1144  * Returns a GoSurfacePosition Z measurement object.
1145  *
1146  * @public @memberof GoSurfacePosition
1147  * @param tool GoSurfacePosition object.
1148  * @return A GoSurfacePosition Z measurement.
1149  */
1150 GoFx(GoMeasurement) GoSurfacePosition_ZMeasurement(GoSurfacePosition tool);
1151 
1152 
1153 /**
1154  * @class GoSurfaceStud
1155  * @extends GoSurfaceTool
1156  * @ingroup GoSdk
1157  * @brief Represents a ...
1158  */
1159 typedef GoSurfaceTool GoSurfaceStud;
1160 
1161 GoFx(k64f) GoSurfaceStud_StudRadius(GoSurfaceStud tool);
1162 GoFx(kStatus) GoSurfaceStud_SetStudRadius(GoSurfaceStud tool, k64f value);
1163 
1164 GoFx(k64f) GoSurfaceStud_StudHeight(GoSurfaceStud tool);
1165 GoFx(kStatus) GoSurfaceStud_SetStudHeight(GoSurfaceStud tool, k64f value);
1166 
1167 GoFx(k64f) GoSurfaceStud_BaseHeight(GoSurfaceStud tool);
1168 GoFx(kStatus) GoSurfaceStud_SetBaseHeight(GoSurfaceStud tool, k64f value);
1169 
1170 GoFx(k64f) GoSurfaceStud_TipHeight(GoSurfaceStud tool);
1171 GoFx(kStatus) GoSurfaceStud_SetTipHeight(GoSurfaceStud tool, k64f value);
1172 
1173 GoFx(kBool) GoSurfaceStud_RegionEnabled(GoSurfaceStud tool);
1174 GoFx(kStatus) GoSurfaceStud_EnableRegion(GoSurfaceStud tool, kBool enable);
1175 
1176 GoFx(GoRegion3d) GoSurfaceStud_Region(GoSurfaceStud tool);
1177 
1178 GoFx(kBool) GoSurfaceStud_RefRegionsEnabled(GoSurfaceStud tool);
1179 GoFx(kStatus) GoSurfaceStud_EnableRefRegions(GoSurfaceStud tool, kBool enable);
1180 
1181 GoFx(kStatus) GoSurfaceStud_SetRefRegionCount(GoSurfaceStud tool, kSize count);
1182 GoFx(k16u) GoSurfaceStud_RefRegionCount(GoSurfaceStud tool);
1183 GoFx(GoSurfaceRegion2d) GoSurfaceStud_RefRegionAt(GoSurfaceStud tool, kSize index);
1184 
1185 GoFx(kBool) GoSurfaceStud_AutoTiltEnabled(GoSurfaceStud tool);
1186 GoFx(kStatus) GoSurfaceStud_EnableAutoTilt(GoSurfaceStud tool, kBool enable);
1187 
1188 GoFx(k64f) GoSurfaceStud_TiltXAngle(GoSurfaceStud tool);
1189 GoFx(kStatus) GoSurfaceStud_SetTiltXAngle(GoSurfaceStud tool, k64f value);
1190 
1191 GoFx(k64f) GoSurfaceStud_TiltYAngle(GoSurfaceStud tool);
1192 GoFx(kStatus) GoSurfaceStud_SetTiltYAngle(GoSurfaceStud tool, k64f value);
1193 
1194 /**
1195  * Returns a GoSurfaceStud BaseX measurement object.
1196  *
1197  * @public @memberof GoSurfaceStud
1198  * @param tool GoSurfaceStud object.
1199  * @return A GoSurfaceStud BaseX measurement.
1200  */
1201 GoFx(GoMeasurement) GoSurfaceStud_BaseXMeasurement(GoSurfaceStud tool);
1202 
1203 /**
1204  * Returns a GoSurfaceStud BaseY measurement object.
1205  *
1206  * @public @memberof GoSurfaceStud
1207  * @param tool GoSurfaceStud object.
1208  * @return A GoSurfaceStud BaseY measurement.
1209  */
1210 GoFx(GoMeasurement) GoSurfaceStud_BaseYMeasurement(GoSurfaceStud tool);
1211 
1212 /**
1213  * Returns a GoSurfaceStud BaseZ measurement object.
1214  *
1215  * @public @memberof GoSurfaceStud
1216  * @param tool GoSurfaceStud object.
1217  * @return A GoSurfaceStud BaseZ measurement.
1218  */
1219 GoFx(GoMeasurement) GoSurfaceStud_BaseZMeasurement(GoSurfaceStud tool);
1220 
1221 /**
1222  * Returns a GoSurfaceStud TipX measurement object.
1223  *
1224  * @public @memberof GoSurfaceStud
1225  * @param tool GoSurfaceStud object.
1226  * @return A GoSurfaceStud TipX measurement.
1227  */
1228 GoFx(GoMeasurement) GoSurfaceStud_TipXMeasurement(GoSurfaceStud tool);
1229 
1230 /**
1231  * Returns a GoSurfaceStud TipY measurement object.
1232  *
1233  * @public @memberof GoSurfaceStud
1234  * @param tool GoSurfaceStud object.
1235  * @return A GoSurfaceStud TipY measurement.
1236  */
1237 GoFx(GoMeasurement) GoSurfaceStud_TipYMeasurement(GoSurfaceStud tool);
1238 
1239 /**
1240  * Returns a GoSurfaceStud TipZ measurement object.
1241  *
1242  * @public @memberof GoSurfaceStud
1243  * @param tool GoSurfaceStud object.
1244  * @return A GoSurfaceStud TipZ measurement.
1245  */
1246 GoFx(GoMeasurement) GoSurfaceStud_TipZMeasurement(GoSurfaceStud tool);
1247 
1248 /**
1249  * Returns a GoSurfaceStud Radius measurement object.
1250  *
1251  * @public @memberof GoSurfaceStud
1252  * @param tool GoSurfaceStud object.
1253  * @return A GoSurfaceStud Radius measurement.
1254  */
1255 GoFx(GoMeasurement) GoSurfaceStud_RadiusMeasurement(GoSurfaceStud tool);
1256 
1257 
1258 /**
1259  * @class GoSurfaceVolume
1260  * @extends GoSurfaceTool
1261  * @ingroup GoSdk
1262  * @brief Represents a ...
1263  */
1265 
1266 GoFx(kBool) GoSurfaceVolume_RegionEnabled(GoSurfaceVolume tool);
1267 GoFx(kStatus) GoSurfaceVolume_EnableRegion(GoSurfaceVolume tool, kBool enable);
1268 GoFx(GoRegion3d) GoSurfaceVolume_Region(GoSurfaceVolume tool);
1269 
1270 /**
1271  * Returns a GoSurfaceVolume Volume measurement object.
1272  *
1273  * @public @memberof GoSurfaceVolume
1274  * @param tool GoSurfaceVolume object.
1275  * @return A GoSurfaceVolume Volume measurement.
1276  */
1277 GoFx(GoMeasurement) GoSurfaceVolume_VolumeMeasurement(GoSurfaceVolume tool);
1278 
1279 /**
1280  * Returns a GoSurfaceVolume Area measurement object.
1281  *
1282  * @public @memberof GoSurfaceVolume
1283  * @param tool GoSurfaceVolume object.
1284  * @return A GoSurfaceVolume Area measurement.
1285  */
1286 GoFx(GoMeasurement) GoSurfaceVolume_AreaMeasurement(GoSurfaceVolume tool);
1287 
1288 /**
1289  * Returns a GoSurfaceVolume Thickness measurement object.
1290  *
1291  * @public @memberof GoSurfaceVolume
1292  * @param tool GoSurfaceVolume object.
1293  * @return A GoSurfaceVolume Thickness measurement.
1294  */
1295 GoFx(GoMeasurement) GoSurfaceVolume_ThicknessMeasurement(GoSurfaceVolume tool);
1296 
1297 /// @endcond
1298 
1299 
1300 kEndHeader()
1301 #include <GoSdk/GoTools.x.h>
1302 
1303 #endif
GoMeasurement GoProfilePanel_GapMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Gap measurement object.
GoMeasurement GoSurfaceStud_BaseYMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud BaseY measurement object.
Represents a ...
Declares the GoTool class.
GoMeasurement GoSurfaceVolume_AreaMeasurement(GoSurfaceVolume tool)
Returns a GoSurfaceVolume Area measurement object.
Represents a base tool measurement or script output.
Definition: GoMeasurement.h:15
GoMeasurement GoSurfaceOpening_YMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Y measurement object.
GoMeasurement GoProfileDim_CenterXMeasurement(GoProfileDim tool)
Returns a GoProfileDim CenterX measurement object.
GoProfileFeature GoProfileDim_RefFeature(GoProfileDim tool)
Gets the reference profile feature.
GoMeasurement GoSurfaceOpening_ZMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Z measurement object.
GoMeasurement GoSurfaceOpening_XMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening X measurement object.
GoMeasurement GoSurfaceHole_YMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole Y measurement object.
Represents a ...
kStatus GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width)
Sets the groove width minimum.
GoMeasurement GoSurfaceOpening_WidthMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Width measurement object.
GoMeasurement GoProfileIntersect_ZMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Z measurement object.
Represents a ...
GoMeasurement GoProfileCircle_ZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Z measurement object.
GoMeasurement GoProfileArea_AreaMeasurement(GoProfileArea tool)
Returns a GoProfileArea Area measurement object.
GoMeasurement GoSurfaceVolume_VolumeMeasurement(GoSurfaceVolume tool)
Returns a GoSurfaceVolume Volume measurement object.
GoMeasurement GoProfileDim_WidthMeasurement(GoProfileDim tool)
Returns a GoProfileDim Width measurement object.
GoMeasurement GoProfileDim_HeightMeasurement(GoProfileDim tool)
Returns a GoProfileDim Height measurement object.
GoMeasurement GoSurfacePlane_XAngleMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane XAngle measurement object.
GoMeasurement GoProfileCircle_RadiusMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Radius measurement object.
Represents a ...
GoProfileRegion GoProfileArea_Region(GoProfileArea tool)
Gets the profile region.
kStatus GoScript_Code(GoScript tool, kChar **code)
Gets the code for the script.
GoMeasurement GoProfileDim_CenterZMeasurement(GoProfileDim tool)
Returns a GoProfileDim CenterZ measurement object.
Represents a ...
Represents a ...
GoMeasurement GoProfileArea_CentroidXMeasurement(GoProfileArea tool)
Returns a GoProfileArea CentroidX measurement object.
Represents a ...
GoMeasurement GoSurfaceOpening_LengthMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Length measurement object.
GoProfileEdge GoProfilePanel_RightEdge(GoProfilePanel tool)
Gets the right profile edge.
Represents a ...
Represents a ...
GoMeasurement GoSurfaceStud_TipXMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud TipX measurement object.
GoMeasurement GoSurfaceEllipse_MinorMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Minor measurement object.
Represents a ...
GoMeasurement GoSurfaceBox_HeightMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Height measurement object.
GoProfileGrooveShape GoProfileGroove_Shape(GoProfileGroove tool)
Gets the current groove determination shape.
GoMeasurement GoProfileDim_DistanceMeasurement(GoProfileDim tool)
Returns a GoProfileDim Distance measurement object.
GoMeasurement GoProfileLine_MinErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine MinError measurement object.
GoMeasurement GoSurfaceEllipse_ZAngleMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse ZAngle measurement object.
Represents a ...
Represents a ...
kStatus GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width)
Sets the maximum gap width.
GoMeasurement GoSurfaceBox_GlobalXMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox global X measurement object.
Represents a profile edge type.
GoMeasurement GoSurfaceStud_TipYMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud TipY measurement object.
GoMeasurement GoProfileLine_StdDevMeasurement(GoProfileLine tool)
Returns a GoProfileLine StdDev measurement object.
Essential API declarations.
GoMeasurement GoSurfaceStud_BaseZMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud BaseZ measurement object.
GoMeasurement GoProfilePosition_ZMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition Z measurement object.
GoMeasurement GoSurfacePosition_YMeasurement(GoSurfacePosition tool)
Returns a GoSurfacePosition Y measurement object.
Represents a ...
k64f GoProfileGroove_MinDepth(GoProfileGroove tool)
Gets the groove depth minimum.
kBool GoProfileArea_TypeUsed(GoProfileArea tool)
Gets the boolean representing whether the area type is used.
GoMeasurement GoProfileArea_CentroidZMeasurement(GoProfileArea tool)
Returns a GoProfileArea CentroidZ measurement object.
Represents a ...
Definition: GoTool.h:18
Represents a ...
GoMeasurement GoSurfaceEllipse_MajorMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Major measurement object.
GoMeasurement GoSurfacePosition_ZMeasurement(GoSurfacePosition tool)
Returns a GoSurfacePosition Z measurement object.
kStatus GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type)
Sets the profile area type.
GoProfileAreaType GoProfileArea_Type(GoProfileArea tool)
Gets the profile area type.
Represents a ...
Definition: GoTools.h:16
GoMeasurement GoSurfaceOpening_AngleMeasurement(GoSurfaceOpening tool)
Returns a GoSurfaceOpening Angle measurement object.
GoMeasurement GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
GoMeasurement GoProfilePosition_XMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition X measurement object.
kStatus GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type)
Sets the profile area type.
GoMeasurement GoSurfaceStud_RadiusMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud Radius measurement object.
Represents a ...
Represents a ...
Represents a ...
GoProfileEdge GoProfilePanel_LeftEdge(GoProfilePanel tool)
Gets the left profile edge.
GoProfileFeature GoProfilePosition_Feature(GoProfilePosition tool)
Gets the profile feature.
GoProfileLineRegion GoProfileIntersect_Line(GoProfileIntersect tool)
Gets the non-reference profile line.
k64f GoProfileGroove_MinWidth(GoProfileGroove tool)
Gets the groove width minimum value.
GoProfileLineRegion GoProfileIntersect_RefLine(GoProfileIntersect tool)
Gets the reference profile line.
kStatus GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape)
Sets the groove determination shape.
GoMeasurement GoSurfaceHole_XMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole X measurement object.
Represents a ...
GoProfileRegion GoProfileGroove_Region(GoProfileGroove tool)
Gets the profile region.
GoMeasurement GoSurfaceBox_ZAngleMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox ZAngle measurement object.
GoProfileBaseline GoProfileIntersect_RefLineType(GoProfileIntersect tool)
Gets the reference profile line type.
GoMeasurement GoSurfaceBox_ZMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Z measurement object.
Represents a ...
GoMeasurement GoProfileIntersect_XMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect X measurement object.
GoMeasurement GoSurfaceHole_ZMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole Z measurement object.
GoMeasurement GoSurfaceEllipse_RatioMeasurement(GoSurfaceEllipse tool)
Returns a GoSurfaceEllipse Ratio measurement object.
Represents a ...
GoMeasurement GoSurfaceStud_TipZMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud TipZ measurement object.
kStatus GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side)
Sets the reference edge side.
GoProfilePanelSide GoProfilePanel_RefEdgeSide(GoProfilePanel tool)
Gets the reference edge side.
kStatus GoTools_AssignMeasurementId(GoTools tools, GoMeasurement measurement)
Given an enabled measurement with a negative ID, update the measurement to utilize a valid ID...
Represents a ...
GoMeasurement GoSurfaceBox_YMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Y measurement object.
GoMeasurement GoProfileLine_PercentileMeasurement(GoProfileLine tool)
Returns a GoProfileLine Percentile measurement object.
GoMeasurement GoProfilePanel_FlushMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Flush measurement object.
kStatus GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type)
Sets the reference line type.
GoMeasurement GoSurfacePlane_ZOffsetMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane ZOffset measurement object.
k64f GoProfilePanel_MaxGapWidth(GoProfilePanel tool)
Gets the maximum gap width.
GoMeasurement GoSurfaceBox_XMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox X measurement object.
kStatus GoScript_SetCode(GoScript tool, kChar *code)
Sets the code for the script.
GoMeasurement GoSurfaceBox_WidthMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Width measurement object.
GoMeasurement GoSurfaceVolume_ThicknessMeasurement(GoSurfaceVolume tool)
Returns a GoSurfaceVolume Thickness measurement object.
GoMeasurement GoSurfacePosition_XMeasurement(GoSurfacePosition tool)
Returns a GoSurfacePosition X measurement object.
k64f GoProfileGroove_MaxWidth(GoProfileGroove tool)
Gets the groove width maximum.
GoProfileRegion GoProfileCircle_Region(GoProfileCircle tool)
Gets the profile region.
GoMeasurement GoSurfaceBox_LengthMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox Length measurement object.
GoProfileFeature GoProfileDim_Feature(GoProfileDim tool)
Gets the non-reference profile feature.
Determines how to calculate profile area.
kStatus GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width)
Sets the groove width maximum.
GoMeasurement GoSurfaceBox_GlobalYMeasurement(GoSurfaceBox tool)
Returns a GoSurfaceBox global Y measurement object.
Represents a ...
GoMeasurement GoSurfacePlane_YAngleMeasurement(GoSurfacePlane tool)
Returns a GoSurfacePlane YAngle measurement object.
GoProfileLineRegion GoProfileArea_LineRegion(GoProfileArea tool)
Gets the reference profile line.
GoProfileBaseline GoProfileArea_Baseline(GoProfileArea tool)
Gets the profile area baseline.
GoMeasurement GoSurfaceHole_RadiusMeasurement(GoSurfaceHole tool)
Returns a GoSurfaceHole Radius measurement object.
Represents a ...
GoMeasurement GoSurfaceStud_BaseXMeasurement(GoSurfaceStud tool)
Returns a GoSurfaceStud BaseX measurement object.
kBool GoProfileArea_BaselineUsed(GoProfileArea tool)
Returns a boolean representing whether the profile area baseline is used.
GoMeasurement GoProfileCircle_XMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle X measurement object.
Represents a ...
GoMeasurement GoProfileLine_MaxErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine MaxError measurement object.
Represents a ...
Represents a ...
kStatus GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth)
Sets the groove depth minimum.