Gocator API

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