Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoProfileTools.h
Go to the documentation of this file.
1 /**
2 * @file GoProfileTools.h
3 * @brief Declares all profile tools and their related classes.
4 *
5 * @internal
6 * Copyright (C) 2016-2022 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_PROFILE_TOOLS_H
11 #define GO_PROFILE_TOOLS_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoTool.h>
15 #include <GoSdk/Tools/GoProfileToolUtils.h>
16 #include <GoSdk/GoUtils.h>
17
18 /**
19 * @class GoProfileTool
20 * @extends GoTool
21 * @ingroup GoSdk-ProfileTools
22 * @brief Represents a base profile tool.
23 */
24 typedef GoTool GoProfileTool;
25
26
27 /**
28 * Sets the data stream. Note that stream validation will only occur if tool
29 * is in the tool options list.
30 *
31 * @public @memberof GoProfileTool
32 * @version Introduced in firmware 4.4.4.14
33 * @param tool GoProfileTool object.
34 * @param stream GoDataStream value.
35 * @return Operation status.
36 * @see GoProfileTool_StreamOptionCount, GoProfileTool_StreamOptionAt
37 */
38 GoFx(kStatus) GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream);
39
40 /**
41 * Gets the data stream.
42 *
43 * @public @memberof GoProfileTool
44 * @version Introduced in firmware 4.4.4.14
45 * @param tool GoProfileTool object.
46 * @return The current profile tool data stream value.
47 */
48 GoFx(GoDataStream) GoProfileTool_Stream(GoProfileTool tool);
49
50 /**
51 * Gets the data stream option list count.
52 *
53 * @public @memberof GoProfileTool
54 * @version Introduced in firmware 4.4.4.14
55 * @param tool GoProfileTool object.
56 * @return The current profile tool data stream option list count.
57 */
58 GoFx(kSize) GoProfileTool_StreamOptionCount(GoProfileTool tool);
59
60 /**
61 * Gets the data stream option at the given index.
62 *
63 * @public @memberof GoProfileTool
64 * @version Introduced in firmware 4.4.4.14
65 * @param tool GoProfileTool object.
66 * @param index The index of the option list to access.
67 * @return The profile tool data stream option at the given index, or k32U_MAX if an invalid index is given.
68 */
69 GoFx(GoDataStream) GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index);
70
71 /**
72 * Sets the data source. Note that source validation will only occur if tool
73 * is in the tool options list.
74 *
75 * @public @memberof GoProfileTool
76 * @version Introduced in firmware 4.0.10.27
77 * @param tool GoProfileTool object.
78 * @param source GoDataSource object.
79 * @return Operation status.
80 * @see GoTools_ToolOptionCount, GoTools_ToolOptionAt
81 */
82 GoFx(kStatus) GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source);
83
84 /**
85 * Gets the data source.
86 *
87 * @public @memberof GoProfileTool
88 * @version Introduced in firmware 4.0.10.27
89 * @param tool GoProfileTool object.
90 * @return The current profile tool data source.
91 */
92 GoFx(GoDataSource) GoProfileTool_Source(GoProfileTool tool);
93
94 /**
95 * Gets the data source option list count.
96 *
97 * @public @memberof GoProfileTool
98 * @version Introduced in firmware 4.0.10.27
99 * @param tool GoProfileTool object.
100 * @return The current profile tool data source option list count.
101 */
102 GoFx(kSize) GoProfileTool_SourceOptionCount(GoProfileTool tool);
103
104 /**
105 * Gets the data source option at the given index.
106 *
107 * @public @memberof GoProfileTool
108 * @version Introduced in firmware 4.0.10.27
109 * @param tool GoProfileTool object.
110 * @param index The index of the option list to access.
111 * @return The profile tool data source option at the given index, or k32U_MAX if an invalid index is given.
112 */
113 GoFx(GoDataSource) GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index);
114
115 /**
116 * Gets the X-anchoring option list count.
117 *
118 * @public @memberof GoProfileTool
119 * @version Introduced in firmware 4.0.10.27
120 * @param tool GoProfileTool object.
121 * @return The X-anchoring option list count.
122 */
123 GoFx(kSize) GoProfileTool_XAnchorOptionCount(GoProfileTool tool);
124
125 /**
126 * Gets the X-anchoring option at the given index.
127 *
128 * @public @memberof GoProfileTool
129 * @version Introduced in firmware 4.0.10.27
130 * @param tool GoProfileTool object.
131 * @param index The index of the option list to access.
132 * @return The X-anchoring option at the given index or k32U_MAX if invalid.
133 */
134 GoFx(k32u) GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index);
135
136 /**
137 * Gets the current X-anchoring source.
138 *
139 * @public @memberof GoProfileTool
140 * @version Introduced in firmware 4.0.10.27
141 * @param tool GoProfileTool object.
142 * @return The X-anchoring source or -1 if no source is currently set.
143 */
144 GoFx(k32s) GoProfileTool_XAnchor(GoProfileTool tool);
145
146 /**
147 * Sets the X-anchoring source.
148 *
149 * @public @memberof GoProfileTool
150 * @version Introduced in firmware 4.0.10.27
151 * @param tool GoProfileTool object.
152 * @param id The measurement ID of a valid X-anchoring source.
153 * @return Operation status.
154 */
155 GoFx(kStatus) GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id);
156
157 /**
158 * Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
159 *
160 * @public @memberof GoProfileTool
161 * @version Introduced in firmware 4.0.10.27
162 * @param tool GoProfileTool object.
163 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
164 */
165 GoFx(kBool) GoProfileTool_XAnchorEnabled(GoProfileTool tool);
166
167 /**
168 * Gets the Z-anchoring option list count.
169 *
170 * @public @memberof GoProfileTool
171 * @version Introduced in firmware 4.0.10.27
172 * @param tool GoProfileTool object.
173 * @return The X-anchoring option list count.
174 */
175 GoFx(kSize) GoProfileTool_ZAnchorOptionCount(GoProfileTool tool);
176
177 /**
178 * Gets the Z-anchoring option at the given index.
179 *
180 * @public @memberof GoProfileTool
181 * @version Introduced in firmware 4.0.10.27
182 * @param tool GoProfileTool object.
183 * @param index The index of the option list to access.
184 * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
185 */
186 GoFx(k32u) GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index);
187
188 /**
189 * Gets the current Z-anchoring source.
190 *
191 * @public @memberof GoProfileTool
192 * @version Introduced in firmware 4.0.10.27
193 * @param tool GoProfileTool object.
194 * @return The Z-anchoring source or -1 if no source is currently set.
195 */
196 GoFx(k32s) GoProfileTool_ZAnchor(GoProfileTool tool);
197
198 /**
199 * Sets the Z-anchoring source.
200 *
201 * @public @memberof GoProfileTool
202 * @version Introduced in firmware 4.0.10.27
203 * @param tool GoProfileTool object.
204 * @param id The measurement ID of a valid Z-anchoring source.
205 * @return Operation status.
206 */
207 GoFx(kStatus) GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id);
208
209 /**
210 * Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
211 *
212 * @public @memberof GoProfileTool
213 * @version Introduced in firmware 4.0.10.27
214 * @param tool GoProfileTool object.
215 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
216 */
217 GoFx(kBool) GoProfileTool_ZAnchorEnabled(GoProfileTool tool);
218
219 /**
220 * @class GoProfileArea
221 * @extends GoProfileTool
222 * @ingroup GoSdk-ProfileTools
223 * @brief Represents a profile area tool.
224 */
225 typedef GoProfileTool GoProfileArea;
226
227 /**
228 * Gets the profile area baseline.
229 *
230 * @public @memberof GoProfileArea
231 * @version Introduced in firmware 4.0.10.27
232 * @param tool GoProfileArea object.
233 * @return The profile area baseline.
234 */
235 GoFx(GoProfileBaseline) GoProfileArea_Baseline(GoProfileArea tool);
236
237 /**
238 * Sets the profile area type.
239 *
240 * @public @memberof GoProfileArea
241 * @version Introduced in firmware 4.0.10.27
242 * @param tool GoProfileArea object.
243 * @param type The baseline type to set.
244 * @return Operation status.
245 */
246 GoFx(kStatus) GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type);
247
248 /**
249 * Returns a boolean representing whether the profile area baseline is used.
250 *
251 * @public @memberof GoProfileArea
252 * @version Introduced in firmware 4.0.10.27
253 * @param tool GoProfileArea object.
254 * @return kTRUE if the baseline is used; kFALSE otherwise.
255 */
256 GoFx(kBool) GoProfileArea_BaselineUsed(GoProfileArea tool);
257
258 /**
259 * Gets the reference profile line.
260 *
261 * @public @memberof GoProfileArea
262 * @version Introduced in firmware 4.0.10.27
263 * @param tool GoProfileArea object.
264 * @return The reference profile line.
265 */
266 GoFx(GoProfileLineRegion) GoProfileArea_LineRegion(GoProfileArea tool);
267
268 /**
269 * Gets the profile area type.
270 *
271 * @public @memberof GoProfileArea
272 * @version Introduced in firmware 4.0.10.27
273 * @param tool GoProfileArea object.
274 * @return The profile area type.
275 */
276 GoFx(GoProfileAreaType) GoProfileArea_Type(GoProfileArea tool);
277
278 /**
279 * Gets the boolean representing whether the area type is used.
280 *
281 * @public @memberof GoProfileArea
282 * @version Introduced in firmware 4.0.10.27
283 * @param tool GoProfileArea object.
284 * @return kTRUE if profile area type is used; kFALSE otherwise.
285 */
286 GoFx(kBool) GoProfileArea_TypeUsed(GoProfileArea tool);
287
288 /**
289 * Sets the profile area type.
290 *
291 * @public @memberof GoProfileArea
292 * @version Introduced in firmware 4.0.10.27
293 * @param tool GoProfileArea object.
294 * @param type GoProfileAreaType object.
295 * @return Operation status.
296 */
297 GoFx(kStatus) GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type);
298
299 /**
300 * Gets the profile region.
301 *
302 * @public @memberof GoProfileArea
303 * @version Introduced in firmware 4.0.10.27
304 * @param tool GoProfileArea object.
305 * @return The profile region.
306 */
307 GoFx(GoProfileRegion) GoProfileArea_Region(GoProfileArea tool);
308
309 /**
310 * Indicates whether the region is enabled.
311 *
312 * @public @memberof GoProfileArea
313 * @version Introduced in firmware 4.4.4.14
314 * @param tool GoProfileArea object.
315 * @return kTRUE if enabled and kFALSE otherwise.
316 */
317 GoFx(kBool) GoProfileArea_RegionEnabled(GoProfileArea tool);
318
319 /**
320 * Enables or disables the region.
321 *
322 * @public @memberof GoProfileArea
323 * @version Introduced in firmware 4.4.4.14
324 * @param tool GoProfileArea object.
325 * @param enable kTRUE to enable the region and kFALSE to disable it.
326 * @return Operation status.
327 */
328 GoFx(kStatus) GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable);
329
330 /**
331 * Returns a GoProfileArea Area measurement object.
332 *
333 * @public @memberof GoProfileArea
334 * @version Introduced in firmware 4.0.10.27
335 * @param tool GoProfileArea object.
336 * @return A GoProfileAreaArea measurement.
337 */
338 GoFx(GoProfileAreaArea) GoProfileArea_AreaMeasurement(GoProfileArea tool);
339
340 /**
341 * Returns a GoProfileArea Centroid X measurement object.
342 *
343 * @public @memberof GoProfileArea
344 * @version Introduced in firmware 4.0.10.27
345 * @param tool GoProfileArea object.
346 * @return A GoProfileAreaCentroidX measurement.
347 */
348 GoFx(GoProfileAreaCentroidX) GoProfileArea_CentroidXMeasurement(GoProfileArea tool);
349
350 /**
351 * Returns a GoProfileArea Centroid Z measurement object.
352 *
353 * @public @memberof GoProfileArea
354 * @version Introduced in firmware 4.0.10.27
355 * @param tool GoProfileArea object.
356 * @return A GoProfileAreaCentroidZ measurement.
357 */
358 GoFx(GoProfileAreaCentroidZ) GoProfileArea_CentroidZMeasurement(GoProfileArea tool);
359
360 /**
361 * Returns a GoProfileArea Center point feature object.
362 *
363 * @public @memberof GoProfileArea
364 * @version Introduced in firmware 4.6.4.9
365 * @param tool GoProfileArea object.
366 * @return A GoProfileAreaCenterPoint Center point feature.
367 */
368 GoFx(GoProfileAreaCenterPoint) GoProfileArea_CenterPoint(GoProfileArea tool);
369
370 /**
371 * @class GoProfileBox
372 * @extends GoProfileTool
373 * @ingroup GoSdk-ProfileTools
374 * @brief Represents a profile bounding box tool.
375 */
376 typedef GoProfileTool GoProfileBox;
377
378 /**
379 * Returns the enabled state of the tool region.
380 *
381 * @public @memberof GoProfileBox
382 * @version Introduced in firmware 4.2.4.7
383 * @param tool GoProfileBox object.
384 * @return kTRUE if enabled and kFALSE if disabled.
385 */
386 GoFx(kBool) GoProfileBox_RegionEnabled(GoProfileBox tool);
387
388 /**
389 * Enables or disables the tool region.
390 *
391 * @public @memberof GoProfileBox
392 * @version Introduced in firmware 4.2.4.7
393 * @param tool GoProfileBox object.
394 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
395 * @return Operation status.
396 */
397 GoFx(kStatus) GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable);
398
399 /**
400 * Gets the profile bounding box region.
401 *
402 * @public @memberof GoProfileBox
403 * @version Introduced in firmware 4.2.4.7
404 * @param tool GoProfileBox object.
405 * @return A GoRegion3d object.
406 */
407 GoFx(GoProfileRegion) GoProfileBox_Region(GoProfileBox tool);
408
409 /**
410 * Returns a GoProfileBox X measurement object.
411 *
412 * @public @memberof GoProfileBox
413 * @version Introduced in firmware 4.2.4.7
414 * @param tool GoProfileBox object.
415 * @return A GoProfileBox X measurement. (mm)
416 */
417 GoFx(GoProfileBoxX) GoProfileBox_XMeasurement(GoProfileBox tool);
418
419 /**
420 * Returns a GoProfileBox Z measurement object.
421 *
422 * @public @memberof GoProfileBox
423 * @version Introduced in firmware 4.2.4.7
424 * @param tool GoProfileBox object.
425 * @return A GoProfileBox Z measurement. (mm)
426 */
427 GoFx(GoProfileBoxZ) GoProfileBox_ZMeasurement(GoProfileBox tool);
428
429 /**
430 * Returns a GoProfileBox Width measurement object.
431 *
432 * @public @memberof GoProfileBox
433 * @version Introduced in firmware 4.2.4.7
434 * @param tool GoProfileBox object.
435 * @return A GoProfileBox Width measurement. (mm)
436 */
437 GoFx(GoProfileBoxWidth) GoProfileBox_WidthMeasurement(GoProfileBox tool);
438
439 /**
440 * Returns a GoProfileBox Height measurement object.
441 *
442 * @public @memberof GoProfileBox
443 * @version Introduced in firmware 4.2.4.7
444 * @param tool GoProfileBox object.
445 * @return A GoProfileBox Height measurement. (mm)
446 */
447 GoFx(GoProfileBoxHeight) GoProfileBox_HeightMeasurement(GoProfileBox tool);
448
449 /**
450 * Returns a GoProfileBox global X measurement object.
451 *
452 * @public @memberof GoProfileBox
453 * @version Introduced in firmware 4.2.4.7
454 * @param tool GoProfileBox object.
455 * @return A GoProfileBox global X measurement. (mm)
456 */
457 GoFx(GoProfileBoxGlobalX) GoProfileBox_GlobalXMeasurement(GoProfileBox tool);
458
459 /**
460 * Returns a GoProfileBox global Y measurement object.
461 *
462 * @public @memberof GoProfileBox
463 * @version Introduced in firmware 4.4.4.14
464 * @param tool GoProfileBox object.
465 * @return A GoProfileBox global Y measurement. (mm)
466 */
467 GoFx(GoProfileBoxGlobalY) GoProfileBox_GlobalYMeasurement(GoProfileBox tool);
468
469 /**
470 * Returns a GoProfileBox global Angle measurement object.
471 *
472 * @public @memberof GoProfileBox
473 * @version Introduced in firmware 4.4.4.14
474 * @param tool GoProfileBox object.
475 * @return A GoProfileBox global angle measurement. (degrees)
476 */
477 GoFx(GoProfileBoxGlobalAngle) GoProfileBox_GlobalAngleMeasurement(GoProfileBox tool);
478
479 /**
480 * Returns a GoProfileBox corner point feature object.
481 *
482 * @public @memberof GoProfileBox
483 * @version Introduced in firmware 4.4.4.14
484 * @param tool GoProfileBox object.
485 * @return A GoProfileBoundingBoxCornerPoint global angle measurement. (degrees)
486 */
487 GoFx(GoProfileBoundingBoxCornerPoint) GoProfileBox_CornerPoint(GoProfileBox tool);
488
489 /**
490 * Returns a GoProfileBox center point feature object.
491 *
492 * @public @memberof GoProfileBox
493 * @version Introduced in firmware 4.4.4.14
494 * @param tool GoProfileBox object.
495 * @return A GoProfileBoundingBoxCenterPoint center point feature.
496 */
497 GoFx(GoProfileBoundingBoxCenterPoint) GoProfileBox_CenterPoint(GoProfileBox tool);
498
499 /**
500 * @class GoProfileBridgeValue
501 * @extends GoProfileTool
502 * @ingroup GoSdk-ProfileTools
503 * @brief Represents a profile bridge value tool.
504 */
505 typedef GoProfileTool GoProfileBridgeValue;
506
507 /**
508 * Returns the enabled state of the tool region.
509 *
510 * @public @memberof GoProfileBridgeValue
511 * @version Introduced in firmware 4.3.3.124
512 * @param tool GoProfileBridgeValue object.
513 * @return kTRUE if enabled and kFALSE if disabled.
514 */
515 GoFx(kBool) GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool);
516
517 /**
518 * Enables or disables the tool region.
519 *
520 * @public @memberof GoProfileBridgeValue
521 * @version Introduced in firmware 4.3.3.124
522 * @param tool GoProfileBridgeValue object.
523 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
524 * @return Operation status.
525 */
526 GoFx(kStatus) GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable);
527
528 /**
529 * Gets the bridge value profile region.
530 *
531 * @public @memberof GoProfileBridgeValue
532 * @version Introduced in firmware 4.3.3.124
533 * @param tool GoProfileArea object.
534 * @return The profile region.
535 */
536 GoFx(GoProfileRegion) GoProfileBridgeValue_Region(GoProfileBridgeValue tool);
537
538
539 /**
540 * Returns the enabled state of normalization.
541 *
542 * @public @memberof GoProfileBridgeValue
543 * @version Introduced in firmware 4.3.3.124
544 * @param tool GoProfileBridgeValue object.
545 * @return kTRUE if enabled and kFALSE if disabled.
546 */
547 GoFx(kBool) GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool);
548
549 /**
550 * Enables or disables normalization.
551 *
552 * @public @memberof GoProfileBridgeValue
553 * @version Introduced in firmware 4.3.3.124
554 * @param tool GoProfileBridgeValue object.
555 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
556 * @return Operation status.
557 */
558 GoFx(kStatus) GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable);
559
560 /**
561 * Sets the profile X-Line tool window size percentage.
562 *
563 * @public @memberof GoProfileBridgeValue
564 * @version Introduced in firmware 4.3.3.124
565 * @param tool GoProfileBridgeValue object.
566 * @param value The value to set.
567 * @return Operation status.
568 */
569 GoFx(kStatus) GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value);
570
571 /**
572 * Gets the profile X-Line tool window size percentage.
573 *
574 * @public @memberof GoProfileBridgeValue
575 * @version Introduced in firmware 4.3.3.124
576 * @param tool GoProfileBridgeValue object.
577 * @return The window size.
578 */
579 GoFx(k64f) GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool);
580
581 /**
582 * Sets the profile X-Line tool window skip percentage.
583 *
584 * @public @memberof GoProfileBridgeValue
585 * @version Introduced in firmware 4.3.3.124
586 * @param tool GoProfileBridgeValue object.
587 * @param value The value to set.
588 * @return Operation status.
589 */
590 GoFx(kStatus) GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value);
591
592 /**
593 * Gets the profile X-Line tool window skip percentage.
594 *
595 * @public @memberof GoProfileBridgeValue
596 * @version Introduced in firmware 4.3.3.124
597 * @param tool GoProfileBridgeValue object.
598 * @return The window size.
599 */
600 GoFx(k64f) GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool);
601
602 /**
603 * Sets the profile X-Line tool max invalid percentage.
604 *
605 * @public @memberof GoProfileBridgeValue
606 * @version Introduced in firmware 4.3.3.124
607 * @param tool GoProfileBridgeValue object.
608 * @param value The value to set.
609 * @return Operation status.
610 */
611 GoFx(kStatus) GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value);
612
613 /**
614 * Gets the profile X-Line tool max invalid percentage.
615 *
616 * @public @memberof GoProfileBridgeValue
617 * @version Introduced in firmware 4.3.3.124
618 * @param tool GoProfileBridgeValue object.
619 * @return The window size.
620 */
621 GoFx(k64f) GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool);
622
623 /**
624 * Sets the profile X-Line tool max differential.
625 *
626 * @public @memberof GoProfileBridgeValue
627 * @version Introduced in firmware 4.3.3.124
628 * @param tool GoProfileBridgeValue object.
629 * @param value The value to set.
630 * @return Operation status.
631 */
632 GoFx(kStatus) GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value);
633
634 /**
635 * Gets the profile X-Line tool max differential.
636 *
637 * @public @memberof GoProfileBridgeValue
638 * @version Introduced in firmware 4.3.3.124
639 * @param tool GoProfileBridgeValue object.
640 * @return The max differential.
641 */
642 GoFx(k64f) GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool);
643
644 /**
645 * Gets the profile X-Line tool max differential maximum value limit.
646 *
647 * @public @memberof GoProfileBridgeValue
648 * @version Introduced in firmware 4.3.3.124
649 * @param tool GoProfileBridgeValue object.
650 * @return The max differential maximum value limit.
651 */
652 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool);
653
654 /**
655 * Gets the profile X-Line tool max differential minimum value limit.
656 * NOTE: A value of 0 will result in an automated differential determination.
657 *
658 * @public @memberof GoProfileBridgeValue
659 * @version Introduced in firmware 4.3.3.124
660 * @param tool GoProfileBridgeValue object.
661 * @return The max differential minimum value limit.
662 */
663 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool);
664
665 /**
666 * Returns a GoProfileBridgeValue bridge value measurement object.
667 *
668 * @public @memberof GoProfileBridgeValue
669 * @version Introduced in firmware 4.3.3.124
670 * @param tool GoProfileBridgeValue object.
671 * @return A GoProfileBridgeValue bridge value measurement.
672 */
673 GoFx(GoProfileBridgeValueBridgeValue) GoProfileBridgeValue_BridgeValueMeasurement(GoProfileBridgeValue tool);
674
675 /**
676 * Returns a GoProfileBridgeValue angle measurement object.
677 *
678 * @public @memberof GoProfileBridgeValue
679 * @version Introduced in firmware 4.3.3.124
680 * @param tool GoProfileBridgeValue object.
681 * @return A GoProfileBridgeValue angle measurement. (degrees)
682 */
683 GoFx(GoProfileBridgeValueAngle) GoProfileBridgeValue_AngleMeasurement(GoProfileBridgeValue tool);
684
685 /**
686 * Returns a GoProfileBridgeValue window measurement object.
687 *
688 * @public @memberof GoProfileBridgeValue
689 * @version Introduced in firmware 4.3.3.124
690 * @param tool GoProfileBridgeValue object.
691 * @return A GoProfileBridgeValue window measurement.
692 */
693 GoFx(GoProfileBridgeValueWindow) GoProfileBridgeValue_WindowMeasurement(GoProfileBridgeValue tool);
694
695 /**
696 * Returns a GoProfileBridgeValue standard deviation measurement object.
697 *
698 * @public @memberof GoProfileBridgeValue
699 * @version Introduced in firmware 4.3.3.124
700 * @param tool GoProfileBridgeValue object.
701 * @return A GoProfileBridgeValue standard deviation measurement.
702 */
703 GoFx(GoProfileBridgeValueStdDev) GoProfileBridgeValue_StdDevMeasurement(GoProfileBridgeValue tool);
704
705
706 /**
707 * @class GoProfileCircle
708 * @extends GoProfileTool
709 * @ingroup GoSdk-ProfileTools
710 * @brief Represents a profile circle tool.
711 */
712 typedef GoProfileTool GoProfileCircle;
713
714 /**
715 * Gets the profile region.
716 *
717 * @public @memberof GoProfileCircle
718 * @version Introduced in firmware 4.0.10.27
719 * @param tool GoProfileCircle object.
720 * @return The profile region.
721 */
722 GoFx(GoProfileRegion) GoProfileCircle_Region(GoProfileCircle tool);
723
724 /**
725 * Indicates whether the region is enabled.
726 *
727 * @public @memberof GoProfileCircle
728 * @version Introduced in firmware 4.4.4.14
729 * @param tool GoProfileCircle object.
730 * @return kTRUE if enabled and kFALSE otherwise.
731 */
732 GoFx(kBool) GoProfileCircle_RegionEnabled(GoProfileCircle tool);
733
734 /**
735 * Enables or disables the region.
736 *
737 * @public @memberof GoProfileCircle
738 * @version Introduced in firmware 4.4.4.14
739 * @param tool GoProfileCircle object.
740 * @param enable kTRUE to enable the region and kFALSE to disable it.
741 * @return Operation status.
742 */
743 GoFx(kStatus) GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable);
744
745 /**
746 * Returns a GoProfileCircle X measurement object.
747 *
748 * @public @memberof GoProfileCircle
749 * @version Introduced in firmware 4.0.10.27
750 * @param tool GoProfileCircle object.
751 * @return A GoProfileCircleX measurement. (mm)
752 */
753 GoFx(GoProfileCircleX) GoProfileCircle_XMeasurement(GoProfileCircle tool);
754
755 /**
756 * Returns a GoProfileCircle Z measurement object.
757 *
758 * @public @memberof GoProfileCircle
759 * @version Introduced in firmware 4.0.10.27
760 * @param tool GoProfileCircle object.
761 * @return A GoProfileCircleZ measurement. (mm)
762 */
763 GoFx(GoProfileCircleZ) GoProfileCircle_ZMeasurement(GoProfileCircle tool);
764
765 /**
766 * Returns a GoProfileCircle Radius measurement object.
767 *
768 * @public @memberof GoProfileCircle
769 * @version Introduced in firmware 4.0.10.27
770 * @param tool GoProfileCircle object.
771 * @return A GoProfileCircleRadius Radius measurement.(mm)
772 */
773 GoFx(GoProfileCircleRadius) GoProfileCircle_RadiusMeasurement(GoProfileCircle tool);
774
775 /**
776 * Returns a GoProfileCircle StdDev measurement object.
777 *
778 * @public @memberof GoProfileCircle
779 * @version Introduced in firmware 5.2.18.3
780 * @param tool GoProfileCircle object.
781 * @return A GoProfileCircleRadius StdDev measurement (mm).
782 */
783 GoFx(GoProfileCircleRadius) GoProfileCircle_StdDevMeasurement(GoProfileCircle tool);
784
785 /**
786 * Returns a GoProfileCircle Min Error measurement object.
787 *
788 * @public @memberof GoProfileCircle
789 * @version Introduced in firmware 5.2.18.3
790 * @param tool GoProfileCircle object.
791 * @return A GoProfileCircleRadius Min Error measurement (mm).
792 */
793 GoFx(GoProfileCircleRadius) GoProfileCircle_MinErrorMeasurement(GoProfileCircle tool);
794
795 /**
796 * Returns a GoProfileCircle Min Error X measurement object.
797 *
798 * @public @memberof GoProfileCircle
799 * @version Introduced in firmware 5.2.18.3
800 * @param tool GoProfileCircle object.
801 * @return A GoProfileCircleRadius Min Error X measurement (mm).
802 */
803 GoFx(GoProfileCircleRadius) GoProfileCircle_MinErrorXMeasurement(GoProfileCircle tool);
804
805 /**
806 * Returns a GoProfileCircle Min Error Z measurement object.
807 *
808 * @public @memberof GoProfileCircle
809 * @version Introduced in firmware 5.2.18.3
810 * @param tool GoProfileCircle object.
811 * @return A GoProfileCircleRadius Min Error Z measurement (mm).
812 */
813 GoFx(GoProfileCircleRadius) GoProfileCircle_MinErrorZMeasurement(GoProfileCircle tool);
814
815 /**
816 * Returns a GoProfileCircle Max Error measurement object.
817 *
818 * @public @memberof GoProfileCircle
819 * @version Introduced in firmware 5.2.18.3
820 * @param tool GoProfileCircle object.
821 * @return A GoProfileCircleRadius Max Error measurement (mm).
822 */
823 GoFx(GoProfileCircleRadius) GoProfileCircle_MaxErrorMeasurement(GoProfileCircle tool);
824
825 /**
826 * Returns a GoProfileCircle Max Error X measurement object.
827 *
828 * @public @memberof GoProfileCircle
829 * @version Introduced in firmware 5.2.18.3
830 * @param tool GoProfileCircle object.
831 * @return A GoProfileCircleRadius Max Error X measurement (mm).
832 */
833 GoFx(GoProfileCircleRadius) GoProfileCircle_MaxErrorXMeasurement(GoProfileCircle tool);
834
835 /**
836 * Returns a GoProfileCircle Max Error Z measurement object.
837 *
838 * @public @memberof GoProfileCircle
839 * @version Introduced in firmware 5.2.18.3
840 * @param tool GoProfileCircle object.
841 * @return A GoProfileCircleRadius Max Error Z measurement (mm).
842 */
843 GoFx(GoProfileCircleRadius) GoProfileCircle_MaxErrorZMeasurement(GoProfileCircle tool);
844
845
846 /**
847 * Returns a GoProfileCircle center point feature object.
848 *
849 * @public @memberof GoProfileCircle
850 * @version Introduced in firmware 4.0.10.27
851 * @param tool GoProfileCircle object.
852 * @return A GoProfileCircleCenterPoint center point feature .
853 */
854 GoFx(GoProfileCircleCenterPoint) GoProfileCircle_CenterPoint(GoProfileCircle tool);
855
856 /**
857 * @class GoProfileDim
858 * @extends GoProfileTool
859 * @ingroup GoSdk-ProfileTools
860 * @brief Represents a profile dimension tool.
861 */
862 typedef GoProfileTool GoProfileDim;
863
864
865 /**
866 * Gets the reference profile feature.
867 *
868 * @public @memberof GoProfileDim
869 * @version Introduced in firmware 4.0.10.27
870 * @param tool GoProfileDim object.
871 * @return The reference profile feature object.
872 */
873 GoFx(GoProfileFeature) GoProfileDim_RefFeature(GoProfileDim tool);
874
875 /**
876 * Gets the non-reference profile feature.
877 *
878 * @public @memberof GoProfileDim
879 * @version Introduced in firmware 4.0.10.27
880 * @param tool GoProfileDim object.
881 * @return The profile feature object.
882 */
883 GoFx(GoProfileFeature) GoProfileDim_Feature(GoProfileDim tool);
884
885 /**
886 * Returns a GoProfileDim Width measurement object.
887 *
888 * @public @memberof GoProfileDim
889 * @version Introduced in firmware 4.0.10.27
890 * @param tool GoProfileDim object.
891 * @return A GoProfileDimWidth measurement.(mm)
892 */
893 GoFx(GoProfileDimWidth) GoProfileDim_WidthMeasurement(GoProfileDim tool);
894
895 /**
896 * Returns a GoProfileDim Height measurement object.
897 *
898 * @public @memberof GoProfileDim
899 * @version Introduced in firmware 4.0.10.27
900 * @param tool GoProfileDim object.
901 * @return A GoProfileDimHeight measurement.(mm)
902 */
903 GoFx(GoProfileDimHeight) GoProfileDim_HeightMeasurement(GoProfileDim tool);
904
905 /**
906 * Returns a GoProfileDim Distance measurement object.
907 *
908 * @public @memberof GoProfileDim
909 * @version Introduced in firmware 4.0.10.27
910 * @param tool GoProfileDim object.
911 * @return A GoProfileDimDistance measurement.(mm)
912 */
913 GoFx(GoProfileDimDistance) GoProfileDim_DistanceMeasurement(GoProfileDim tool);
914
915 /**
916 * Returns a GoProfileDim Center X measurement object.
917 *
918 * @public @memberof GoProfileDim
919 * @version Introduced in firmware 4.0.10.27
920 * @param tool GoProfileDim object.
921 * @return A GoProfileDimCenterX measurement.
922 */
923 GoFx(GoProfileDimCenterX) GoProfileDim_CenterXMeasurement(GoProfileDim tool);
924
925 /**
926 * Returns a GoProfileDim Center Z measurement object.
927 *
928 * @public @memberof GoProfileDim
929 * @version Introduced in firmware 4.0.10.27
930 * @param tool GoProfileDim object.
931 * @return A GoProfileDimCenterZ measurement.
932 */
933 GoFx(GoProfileDimCenterZ) GoProfileDim_CenterZMeasurement(GoProfileDim tool);
934
935 /**
936 * Returns a GoProfileDim Center point feature object.
937 *
938 * @public @memberof GoProfileDim
939 * @version Introduced in firmware 4.0.10.27
940 * @param tool GoProfileDim object.
941 * @return A GoProfileDimensionCenterPoint Center point feature.
942 */
943 GoFx(GoProfileDimensionCenterPoint) GoProfileDim_CenterPoint(GoProfileDim tool);
944
945 /**
946 * @class GoProfileGroove
947 * @extends GoProfileTool
948 * @ingroup GoSdk-ProfileTools
949 * @brief Represents a profile groove tool.
950 */
951 typedef GoProfileTool GoProfileGroove;
952
953 /**
954 * Adds an additional profile groove tool measurement.
955 *
956 * @public @memberof GoProfileGroove
957 * @version Introduced in firmware 4.0.10.27
958 * @param tool GoProfileGroove object.
959 * @param type The measurement type to add. It must be a valid profile groove tool type.
960 * @param measurement A reference to the new GoMeasurement handle. Can be kNULL if you do not wish to do anything immediate with the new measurement.
961 * @return Operation status.
962 */
963 GoFx(kStatus) GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement* measurement);
964
965 /**
966 * Removes a measurement from the tool at the given index.
967 *
968 * @public @memberof GoProfileGroove
969 * @version Introduced in firmware 4.0.10.27
970 * @param tool GoProfileGroove object.
971 * @param index The index with which to remove a measurement.
972 * @return Operation status.
973 */
974 GoFx(kStatus) GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index);
975
976 /**
977 * Returns the measurement count for the given tool.
978 *
979 * @public @memberof GoProfileGroove
980 * @version Introduced in firmware 4.0.10.27
981 * @param tool GoProfileGroove object.
982 * @return Tool measurement count.
983 */
984 GoFx(kSize) GoProfileGroove_MeasurementCount(GoProfileGroove tool);
985
986 /**
987 * Returns a measurement object at the given index.
988 *
989 * @public @memberof GoProfileGroove
990 * @version Introduced in firmware 4.0.10.27
991 * @param tool GoProfileGroove object.
992 * @param index The index with which to return a measurement object.
993 * @return A profile groove tool measurement or kNULL if the index is invalid.
994 */
995 GoFx(GoMeasurement) GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index);
996
997 /**
998 * Gets the current groove determination shape.
999 *
1000 * @public @memberof GoProfileGroove
1001 * @version Introduced in firmware 4.0.10.27
1002 * @param tool GoProfileGroove object.
1003 * @return The profile groove shape.
1004 */
1005 GoFx(GoProfileGrooveShape) GoProfileGroove_Shape(GoProfileGroove tool);
1006
1007 /**
1008 * Sets the groove determination shape.
1009 *
1010 * @public @memberof GoProfileGroove
1011 * @version Introduced in firmware 4.0.10.27
1012 * @param tool GoProfileGroove object.
1013 * @param shape The intended profile groove shape.
1014 * @return Operation status.
1015 */
1016 GoFx(kStatus) GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape);
1017
1018 /**
1019 * Gets the groove depth minimum.
1020 *
1021 * @public @memberof GoProfileGroove
1022 * @version Introduced in firmware 4.0.10.27
1023 * @param tool GoProfileGroove object.
1024 * @return The groove depth minimum value.(mm)
1025 */
1026 GoFx(k64f) GoProfileGroove_MinDepth(GoProfileGroove tool);
1027
1028 /**
1029 * Sets the groove depth minimum.
1030 *
1031 * @public @memberof GoProfileGroove
1032 * @version Introduced in firmware 4.0.10.27
1033 * @param tool GoProfileGroove object.
1034 * @param depth The minimum groove depth value to set.(mm)
1035 * @return Operation status.
1036 */
1037 GoFx(kStatus) GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth);
1038
1039 /**
1040 * Gets the groove width maximum.
1041 *
1042 * @public @memberof GoProfileGroove
1043 * @version Introduced in firmware 4.0.10.27
1044 * @param tool GoProfileGroove object.
1045 * @return The groove width maximum value.(mm)
1046 */
1047 GoFx(k64f) GoProfileGroove_MaxWidth(GoProfileGroove tool);
1048
1049 /**
1050 * Sets the groove width maximum.
1051 *
1052 * @public @memberof GoProfileGroove
1053 * @version Introduced in firmware 4.0.10.27
1054 * @param tool GoProfileGroove object.
1055 * @param width The maximum groove width value to set.(mm)
1056 * @return Operation status.
1057 */
1058 GoFx(kStatus) GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width);
1059
1060 /**
1061 * Gets the groove width minimum value.
1062 *
1063 * @public @memberof GoProfileGroove
1064 * @version Introduced in firmware 4.0.10.27
1065 * @param tool GoProfileGroove object.
1066 * @return The groove width minimum.(mm)
1067 */
1068 GoFx(k64f) GoProfileGroove_MinWidth(GoProfileGroove tool);
1069
1070 /**
1071 * Sets the groove width minimum.
1072 *
1073 * @public @memberof GoProfileGroove
1074 * @version Introduced in firmware 4.0.10.27
1075 * @param tool GoProfileGroove object.
1076 * @param width The minimum groove width value to set.(mm)
1077 * @return Operation status.
1078 */
1079 GoFx(kStatus) GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width);
1080
1081 /**
1082 * Gets the profile region.
1083 *
1084 * @public @memberof GoProfileGroove
1085 * @version Introduced in firmware 4.0.10.27
1086 * @param tool GoProfileGroove object.
1087 * @return The profile region.
1088 */
1089 GoFx(GoProfileRegion) GoProfileGroove_Region(GoProfileGroove tool);
1090
1091 /**
1092 * Indicates whether the region is enabled.
1093 *
1094 * @public @memberof GoProfileGroove
1095 * @version Introduced in firmware 4.4.4.14
1096 * @param tool GoProfileGroove object.
1097 * @return kTRUE if enabled and kFALSE otherwise.
1098 */
1099 GoFx(kBool) GoProfileGroove_RegionEnabled(GoProfileGroove tool);
1100
1101 /**
1102 * Enables or disables the region.
1103 *
1104 * @public @memberof GoProfileGroove
1105 * @version Introduced in firmware 4.4.4.14
1106 * @param tool GoProfileGroove object.
1107 * @param enable kTRUE to enable the region and kFALSE to disable it.
1108 * @return Operation status.
1109 */
1110 GoFx(kStatus) GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable);
1111
1112 /**
1113 * @class GoProfileIntersect
1114 * @extends GoProfileTool
1115 * @ingroup GoSdk-ProfileTools
1116 * @brief Represents a profile intersect tool.
1117 */
1118 typedef GoProfileTool GoProfileIntersect;
1119
1120 /**
1121 * Gets the reference profile line type.
1122 *
1123 * @public @memberof GoProfileIntersect
1124 * @version Introduced in firmware 4.0.10.27
1125 * @param tool GoProfileIntersect object.
1126 * @return The profile line type.
1127 */
1128 GoFx(GoProfileBaseline) GoProfileIntersect_RefLineType(GoProfileIntersect tool);
1129
1130 /**
1131 * Sets the reference line type.
1132 *
1133 * @public @memberof GoProfileIntersect
1134 * @version Introduced in firmware 4.0.10.27
1135 * @param tool GoProfileIntersect object.
1136 * @param type The line type to set.
1137 * @return
1138 */
1139 GoFx(kStatus) GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type);
1140
1141 /**
1142 * Gets the reference profile line.
1143 *
1144 * @public @memberof GoProfileIntersect
1145 * @version Introduced in firmware 4.0.10.27
1146 * @param tool GoProfileIntersect object.
1147 * @return The reference profile line.
1148 */
1149 GoFx(GoProfileLineRegion) GoProfileIntersect_RefLine(GoProfileIntersect tool);
1150
1151 /**
1152 * Gets the non-reference profile line.
1153 *
1154 * @public @memberof GoProfileIntersect
1155 * @version Introduced in firmware 4.0.10.27
1156 * @param tool GoProfileIntersect object.
1157 * @return The non-reference profile line.
1158 */
1159 GoFx(GoProfileLineRegion) GoProfileIntersect_Line(GoProfileIntersect tool);
1160
1161 /**
1162 * Returns a GoProfileIntersect X measurement object.
1163 *
1164 * @public @memberof GoProfileIntersect
1165 * @version Introduced in firmware 4.0.10.27
1166 * @param tool GoProfileIntersect object.
1167 * @return A GoProfileIntersect X measurement. (mm)
1168 */
1169 GoFx(GoProfileIntersectX) GoProfileIntersect_XMeasurement(GoProfileIntersect tool);
1170
1171 /**
1172 * Returns a GoProfileIntersect Z measurement object.
1173 *
1174 * @public @memberof GoProfileIntersect
1175 * @version Introduced in firmware 4.0.10.27
1176 * @param tool GoProfileIntersect object.
1177 * @return A GoProfileIntersect Z measurement.(mm)
1178 */
1179 GoFx(GoProfileIntersectZ) GoProfileIntersect_ZMeasurement(GoProfileIntersect tool);
1180
1181 /**
1182 * Returns a GoProfileIntersect Angle measurement object.
1183 *
1184 * @public @memberof GoProfileIntersect
1185 * @version Introduced in firmware 4.0.10.27
1186 * @param tool GoProfileIntersect object.
1187 * @return A GoProfileIntersect Angle measurement.(degrees)
1188 */
1189 GoFx(GoProfileIntersectAngle) GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool);
1190
1191 /**
1192 * Returns a GoProfileIntersect Angle measurement object.
1193 *
1194 * @public @memberof GoProfileIntersect
1195 * @version Introduced in firmware 4.0.10.27
1196 * @param tool GoProfileIntersect object.
1197 * @return A GoProfileIntersect Angle measurement.(degrees)
1198 */
1199 GoFx(GoProfileIntersectIntersectPoint) GoProfileIntersect_PointFeature(GoProfileIntersect tool);
1200
1201 /**
1202 * Returns a GoProfileIntersectLine Feature object.
1203 *
1204 * @public @memberof GoProfileIntersect
1205 * @version Introduced in firmware 4.6.4.10
1206 * @param tool GoProfileIntersect object.
1207 * @return A GoProfileIntersectLine feature object.
1208 */
1209 GoFx(GoProfileIntersectLine) GoProfileIntersect_LineFeature(GoProfileIntersect tool);
1210
1211 /**
1212 * Returns a GoProfileIntersectBaseLine Feature object.
1213 *
1214 * @public @memberof GoProfileIntersect
1215 * @version Introduced in firmware 4.6.4.10
1216 * @param tool GoProfileIntersect object.
1217 * @return A GoProfileIntersectBaseLine feature object.
1218 */
1219 GoFx(GoProfileIntersectBaseLine) GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool);
1220
1221 /**
1222 * @class GoProfileLine
1223 * @extends GoProfileTool
1224 * @ingroup GoSdk-ProfileTools
1225 * @brief Represents a profile line tool.
1226 */
1227 typedef GoProfileTool GoProfileLine;
1228
1229 /**
1230 * Gets the measurement region.
1231 *
1232 * @public @memberof GoProfileDev
1233 * @version Introduced in firmware 4.0.10.27
1234 * @param tool GoProfileDev object.
1235 * @return The profile Line Measurement region.
1236 */
1237 GoFx(GoProfileRegion) GoProfileLine_Region(GoProfileLine tool);
1238
1239 /**
1240 * Indicates whether the region is enabled.
1241 *
1242 * @public @memberof GoProfileLine
1243 * @version Introduced in firmware 4.4.4.14
1244 * @param tool GoProfileLine object.
1245 * @return kTRUE if enabled and kFALSE otherwise.
1246 */
1247 GoFx(kBool) GoProfileLine_RegionEnabled(GoProfileLine tool);
1248
1249 /**
1250 * Enables or disables the region.
1251 *
1252 * @public @memberof GoProfileLine
1253 * @version Introduced in firmware 4.4.4.14
1254 * @param tool GoProfileLine object.
1255 * @param enable kTRUE to enable the region and kFALSE to disable it.
1256 * @return Operation status.
1257 */
1258 GoFx(kStatus) GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable);
1259
1260 /**
1261 * Gets the fitting regions.
1262 *
1263 * @public @memberof GoProfileDev
1264 * @version Introduced in firmware 4.6.0.95
1265 * @param tool GoProfileLine object.
1266 * @return The profile Line fitting regions.
1267 */
1268 GoFx(GoProfileLineRegion) GoProfileLine_FittingRegions(GoProfileLine tool);
1269
1270 /**
1271 * Indicates whether the fitting regions are enabled.
1272 *
1273 * @public @memberof GoProfileLine
1274 * @version Introduced in firmware 4.6.0.147
1275 * @param tool GoProfileLine object.
1276 * @return kTRUE if enabled and kFALSE otherwise.
1277 */
1278 GoFx(kBool) GoProfileLine_FittingRegionsEnabled(GoProfileLine tool);
1279
1280 /**
1281 * Enables or disables the fitting regions.
1282 *
1283 * @public @memberof GoProfileLine
1284 * @version Introduced in firmware 4.6.0.147
1285 * @param tool GoProfileLine object.
1286 * @param enable Boolean enable or disable fitting regions.
1287 * @return kTRUE if enabled and kFALSE otherwise.
1288 */
1289 GoFx(kStatus) GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable);
1290
1291 /**
1292 * Returns a GoProfileLine Standard Deviation measurement object.
1293 *
1294 * @public @memberof GoProfileLine
1295 * @version Introduced in firmware 4.0.10.27
1296 * @param tool GoProfileLine object.
1297 * @return A GoProfileLine Standard Deviation measurement.
1298 */
1299 GoFx(GoProfileLineStdDev) GoProfileLine_StdDevMeasurement(GoProfileLine tool);
1300
1301 /**
1302 * Returns a GoProfileLine Maximum Error measurement object.
1303 *
1304 * @public @memberof GoProfileLine
1305 * @version Introduced in firmware 4.0.10.27
1306 * @param tool GoProfileLine object.
1307 * @return A GoProfileLine Maximum Error measurement.
1308 */
1309 GoFx(GoProfileLineMaxError) GoProfileLine_MaxErrorMeasurement(GoProfileLine tool);
1310
1311 /**
1312 * Returns a GoProfileLine Minimum Error measurement object.
1313 *
1314 * @public @memberof GoProfileLine
1315 * @version Introduced in firmware 4.0.10.27
1316 * @param tool GoProfileLine object.
1317 * @return A GoProfileLine Minimum Error measurement.
1318 */
1319 GoFx(GoProfileLineMinError) GoProfileLine_MinErrorMeasurement(GoProfileLine tool);
1320
1321 /**
1322 * Returns a GoProfileLine Percentile measurement object.
1323 *
1324 * @public @memberof GoProfileLine
1325 * @version Introduced in firmware 4.0.10.27
1326 * @param tool GoProfileLine object.
1327 * @return A GoProfileLine Percentile measurement.
1328 */
1329 GoFx(GoProfileLinePercentile) GoProfileLine_PercentileMeasurement(GoProfileLine tool);
1330
1331 /**
1332 * Returns a GoProfileLine Offset measurement object.
1333 *
1334 * @public @memberof GoProfileLine
1335 * @version Introduced in firmware 4.6.0.49
1336 * @param tool GoProfileLine object.
1337 * @return A GoProfileLine Offset measurement.
1338 */
1339 GoFx(GoProfileLineOffset) GoProfileLine_OffsetMeasurement(GoProfileLine tool);
1340
1341 /**
1342 * Returns a GoProfileLine Angle measurement object.
1343 *
1344 * @public @memberof GoProfileLine
1345 * @version Introduced in firmware 4.6.0.49
1346 * @param tool GoProfileLine object.
1347 * @return A GoProfileLine Angle measurement.
1348 */
1349 GoFx(GoProfileLineAngle) GoProfileLine_AngleMeasurement(GoProfileLine tool);
1350
1351 /**
1352 * Returns a GoProfileLine Minimum X Error measurement object.
1353 *
1354 * @public @memberof GoProfileLine
1355 * @version Introduced in firmware 4.6.0.49
1356 * @param tool GoProfileLine object.
1357 * @return A GoProfileLine Minimum X Error measurement.
1358 */
1359 GoFx(GoProfileLineMinErrorX) GoProfileLine_MinErrorXMeasurement(GoProfileLine tool);
1360
1361 /**
1362 * Returns a GoProfileLine Minimum Z Error measurement object.
1363 *
1364 * @public @memberof GoProfileLine
1365 * @version Introduced in firmware 4.6.0.49
1366 * @param tool GoProfileLine object.
1367 * @return A GoProfileLine Minimum Z Error measurement.
1368 */
1369 GoFx(GoProfileLineMinErrorZ) GoProfileLine_MinErrorZMeasurement(GoProfileLine tool);
1370
1371 /**
1372 * Returns a GoProfileLine Maximum X Error measurement object.
1373 *
1374 * @public @memberof GoProfileLine
1375 * @version Introduced in firmware 4.6.0.49
1376 * @param tool GoProfileLine object.
1377 * @return A GoProfileLine Maximum X Error measurement.
1378 */
1379 GoFx(GoProfileLineMaxErrorX) GoProfileLine_MaxErrorXMeasurement(GoProfileLine tool);
1380
1381 /**
1382 * Returns a GoProfileLine Maximum Z Error measurement object.
1383 *
1384 * @public @memberof GoProfileLine
1385 * @version Introduced in firmware 4.6.0.49
1386 * @param tool GoProfileLine object.
1387 * @return A GoProfileLine Maximum Z Error measurement.
1388 */
1389 GoFx(GoProfileLineMaxErrorZ) GoProfileLine_MaxErrorZMeasurement(GoProfileLine tool);
1390
1391 /**
1392 * Returns a GoProfileLine line feature object.
1393 *
1394 * @public @memberof GoProfileLine
1395 * @version Introduced in firmware 4.6.0.49
1396 * @param tool GoProfileLine object.
1397 * @return A GoProfileLineLine line feature.
1398 */
1399 GoFx(GoProfileLineLine) GoProfileLine_Line(GoProfileLine tool);
1400
1401 /**
1402 * Returns a GoProfileLine Maximum Z Error measurement object.
1403 *
1404 * @public @memberof GoProfileLine
1405 * @version Introduced in firmware 4.6.0.49
1406 * @param tool GoProfileLineMinErrorPoint object.
1407 * @return A GoProfileLineMinErrorPoint min error point feature.
1408 */
1409 GoFx(GoProfileLineMinErrorPoint) GoProfileLine_MinErrorPoint(GoProfileLine tool);
1410
1411 /**
1412 * Returns a GoProfileLine min error point feature object.
1413 *
1414 * @public @memberof GoProfileLine
1415 * @version Introduced in firmware 4.6.0.49
1416 * @param tool GoProfileLineMaxErrorPoint object.
1417 * @return A GoProfileLineMaxErrorPoint min error point feature.
1418 */
1419 GoFx(GoProfileLineMaxErrorPoint) GoProfileLine_MaxErrorPoint(GoProfileLine tool);
1420
1421 /**
1422 * @class GoProfilePanel
1423 * @extends GoProfileTool
1424 * @ingroup GoSdk-ProfileTools
1425 * @brief Represents a profile panel tool.
1426 */
1427 typedef GoProfileTool GoProfilePanel;
1428
1429 /**
1430 * Gets the maximum gap width.
1431 *
1432 * @public @memberof GoProfilePanel
1433 * @version Introduced in firmware 4.0.10.27
1434 * @param tool GoProfilePanel object.
1435 * @return The maximum gap width.(mm)
1436 */
1437 GoFx(k64f) GoProfilePanel_MaxGapWidth(GoProfilePanel tool);
1438
1439 /**
1440 * Sets the maximum gap width.
1441 *
1442 * @public @memberof GoProfilePanel
1443 * @version Introduced in firmware 4.0.10.27
1444 * @param tool GoProfilePanel object.
1445 * @param width The maximum gap width value to set.(mm)
1446 * @return Operation status.
1447 */
1448 GoFx(kStatus) GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width);
1449
1450 /**
1451 * Gets the reference edge side.
1452 *
1453 * @public @memberof GoProfilePanel
1454 * @version Introduced in firmware 4.0.10.27
1455 * @param tool GoProfilePanel object.
1456 * @return The reference edge side.
1457 */
1458 GoFx(GoProfilePanelSide) GoProfilePanel_RefEdgeSide(GoProfilePanel tool);
1459
1460 /**
1461 * Sets the reference edge side.
1462 *
1463 * @public @memberof GoProfilePanel
1464 * @version Introduced in firmware 4.0.10.27
1465 * @param tool GoProfilePanel object.
1466 * @param side The reference edge side.
1467 * @return Operation status.
1468 */
1469 GoFx(kStatus) GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side);
1470
1471 /**
1472 * Gets the left profile edge.
1473 *
1474 * @public @memberof GoProfilePanel
1475 * @version Introduced in firmware 4.0.10.27
1476 * @param tool GoProfilePanel object.
1477 * @return The left profile edge.
1478 */
1479 GoFx(GoProfileEdge) GoProfilePanel_LeftEdge(GoProfilePanel tool);
1480
1481 /**
1482 * Gets the right profile edge.
1483 *
1484 * @public @memberof GoProfilePanel
1485 * @version Introduced in firmware 4.0.10.27
1486 * @param tool GoProfilePanel object.
1487 * @return The right profile edge.
1488 */
1489 GoFx(GoProfileEdge) GoProfilePanel_RightEdge(GoProfilePanel tool);
1490
1491 /**
1492 * Returns a GoProfilePanel Gap measurement object.
1493 *
1494 * @public @memberof GoProfilePanel
1495 * @version Introduced in firmware 4.0.10.27
1496 * @param tool GoProfilePanel object.
1497 * @return A GoProfilePanel Gap measurement.
1498 */
1499 GoFx(GoProfilePanelGap) GoProfilePanel_GapMeasurement(GoProfilePanel tool);
1500
1501 /**
1502 * Returns a GoProfilePanel Flush measurement object.
1503 *
1504 * @public @memberof GoProfilePanel
1505 * @version Introduced in firmware 4.0.10.27
1506 * @param tool GoProfilePanel object.
1507 * @return A GoProfilePanel Flush measurement.
1508 */
1509 GoFx(GoProfilePanelFlush) GoProfilePanel_FlushMeasurement(GoProfilePanel tool);
1510
1511 /**
1512 * Returns a GoProfilePanel Left Gap X measurement object.
1513 *
1514 * @public @memberof GoProfilePanel
1515 * @version Introduced in firmware 4.0.10.27
1516 * @param tool GoProfilePanel object.
1517 * @return A GoProfilePanel Left Gap X measurement.
1518 */
1519 GoFx(GoProfilePanelLeftGapX) GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool);
1520
1521 /**
1522 * Returns a GoProfilePanel Left Gap Z measurement object.
1523 *
1524 * @public @memberof GoProfilePanel
1525 * @version Introduced in firmware 4.0.10.27
1526 * @param tool GoProfilePanel object.
1527 * @return A GoProfilePanel Left Gap Z measurement.
1528 */
1529 GoFx(GoProfilePanelLeftGapZ) GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool);
1530
1531 /**
1532 * Returns a GoProfilePanel Left Flush X measurement object.
1533 *
1534 * @public @memberof GoProfilePanel
1535 * @version Introduced in firmware 4.0.10.27
1536 * @param tool GoProfilePanel object.
1537 * @return A GoProfilePanel Left Flush X measurement.
1538 */
1539 GoFx(GoProfilePanelLeftFlushX) GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool);
1540
1541 /**
1542 * Returns a GoProfilePanel Left Flush Z measurement object.
1543 *
1544 * @public @memberof GoProfilePanel
1545 * @version Introduced in firmware 4.0.10.27
1546 * @param tool GoProfilePanel object.
1547 * @return A GoProfilePanel Left Flush Z measurement.
1548 */
1549 GoFx(GoProfilePanelLeftFlushZ) GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool);
1550
1551 /**
1552 * Returns a GoProfilePanel Left Surface Angle measurement object.
1553 *
1554 * @public @memberof GoProfilePanel
1555 * @version Introduced in firmware 4.0.10.27
1556 * @param tool GoProfilePanel object.
1557 * @return A GoProfilePanel Left Surface Angle measurement.
1558 */
1559 GoFx(GoProfilePanelLeftSurfaceAngle) GoProfilePanel_LeftSurfaceAngleMeasurement(GoProfilePanel tool);
1560
1561 /**
1562 * Returns a GoProfilePanel Right Gap X measurement object.
1563 *
1564 * @public @memberof GoProfilePanel
1565 * @version Introduced in firmware 4.0.10.27
1566 * @param tool GoProfilePanel object.
1567 * @return A GoProfilePanel Right Gap X measurement.
1568 */
1569 GoFx(GoProfilePanelRightGapX) GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool);
1570
1571 /**
1572 * Returns a GoProfilePanel Right Gap Z measurement object.
1573 *
1574 * @public @memberof GoProfilePanel
1575 * @version Introduced in firmware 4.0.10.27
1576 * @param tool GoProfilePanel object.
1577 * @return A GoProfilePanel Right Gap Z measurement.
1578 */
1579 GoFx(GoProfilePanelRightGapZ) GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool);
1580
1581 /**
1582 * Returns a GoProfilePanel Right Flush Z measurement object.
1583 *
1584 * @public @memberof GoProfilePanel
1585 * @version Introduced in firmware 4.0.10.27
1586 * @param tool GoProfilePanel object.
1587 * @return A GoProfilePanel Right Flush Z measurement.
1588 */
1589 GoFx(GoProfilePanelRightFlushZ) GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool);
1590
1591 /**
1592 * Returns a GoProfilePanel Right Surface Angle measurement object.
1593 *
1594 * @public @memberof GoProfilePanel
1595 * @version Introduced in firmware 4.0.10.27
1596 * @param tool GoProfilePanel object.
1597 * @return A GoProfilePanel Right Surface Angle measurement.
1598 */
1599 GoFx(GoProfilePanelRightSurfaceAngle) GoProfilePanel_RightSurfaceAngleMeasurement(GoProfilePanel tool);
1600
1601 /**
1602 * @class GoProfilePosition
1603 * @extends GoProfileTool
1604 * @ingroup GoSdk-ProfileTools
1605 * @brief Represents a profile position tool.
1606 */
1607 typedef GoProfileTool GoProfilePosition;
1608
1609 /**
1610 * Indicates whether the region is enabled.
1611 *
1612 * @public @memberof GoProfilePosition
1613 * @version Introduced in firmware 4.8.2.76
1614 * @param tool GoProfilePosition object.
1615 * @return kTRUE if enabled and kFALSE otherwise.
1616 */
1617 GoFx(kBool) GoProfilePosition_RegionEnabled(GoProfilePosition tool);
1618
1619 /**
1620 * Enables or disables the region.
1621 *
1622 * @public @memberof GoProfilePosition
1623 * @version Introduced in firmware 4.8.2.76
1624 * @param tool GoProfilePosition object.
1625 * @param enable kTRUE to enable the region and kFALSE to disable it.
1626 * @return Operation status.
1627 */
1628 GoFx(kStatus) GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable);
1629 /**
1630 * Gets the profile feature.
1631 *
1632 * @public @memberof GoProfilePosition
1633 * @version Introduced in firmware 4.0.10.27
1634 * @param tool GoProfilePos object.
1635 * @return The profile feature.
1636 */
1637 GoFx(GoProfileFeature) GoProfilePosition_Feature(GoProfilePosition tool);
1638
1639 /**
1640 * Returns a GoProfilePosition X measurement object.
1641 *
1642 * @public @memberof GoProfilePosition
1643 * @version Introduced in firmware 4.0.10.27
1644 * @param tool GoProfilePosition object.
1645 * @return A GoProfilePosition X measurement.(mm)
1646 */
1647 GoFx(GoProfilePositionX) GoProfilePosition_XMeasurement(GoProfilePosition tool);
1648
1649 /**
1650 * Returns a GoProfilePosition Z measurement object.
1651 *
1652 * @public @memberof GoProfilePosition
1653 * @version Introduced in firmware 4.0.10.27
1654 * @param tool GoProfilePosition object.
1655 * @return A GoProfilePosition Z measurement.(mm)
1656 */
1657 GoFx(GoProfilePositionZ) GoProfilePosition_ZMeasurement(GoProfilePosition tool);
1658
1659 /**
1660 * Returns a GoProfilePosition point feature object.
1661 *
1662 * @public @memberof GoProfilePosition
1663 * @version Introduced in firmware 4.0.10.27
1664 * @param tool GoProfilePosition object.
1665 * @return A GoProfilePosition point feature.
1666 */
1667 GoFx(GoProfilePositionPoint) GoProfilePosition_Point(GoProfilePosition tool);
1668
1669 /**
1670 * @class GoProfileStrip
1671 * @extends GoProfileTool
1672 * @ingroup GoSdk-ProfileTools
1673 * @brief Represents a profile strip tool.
1674 */
1675 typedef GoProfileTool GoProfileStrip;
1676
1677 /**
1678 * Sets the strip base type.
1679 *
1680 * @public @memberof GoProfileStrip
1681 * @version Introduced in firmware 4.0.10.27
1682 * @param tool GoProfileStrip object.
1683 * @param type The strip base type.
1684 * @return Operation status.
1685 */
1686 GoFx(kStatus) GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type);
1687
1688 /**
1689 * Gets the strip base type.
1690 *
1691 * @public @memberof GoProfileStrip
1692 * @version Introduced in firmware 4.0.10.27
1693 * @param tool GoProfileStrip object.
1694 * @return The strip base type.
1695 */
1696 GoFx(GoProfileStripBaseType) GoProfileStrip_BaseType(GoProfileStrip tool);
1697
1698 /**
1699 * Gets the left edge value.
1700 *
1701 * @public @memberof GoProfileStrip
1702 * @version Introduced in firmware 4.0.10.27
1703 * @param tool GoProfileStrip object.
1704 * @return The left edge value.
1705 */
1706 GoFx(GoProfileStripEdgeType) GoProfileStrip_LeftEdge(GoProfileStrip tool);
1707
1708 /**
1709 * Sets the left edge.
1710 *
1711 * @public @memberof GoProfileStrip
1712 * @version Introduced in firmware 4.0.10.27
1713 * @param tool GoProfileStrip object.
1714 * @param leftEdge Left edge value.
1715 * @return Operation status.
1716 */
1717 GoFx(kStatus) GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge);
1718
1719 /**
1720 * Gets the right edge value.
1721 *
1722 * @public @memberof GoProfileStrip
1723 * @version Introduced in firmware 4.0.10.27
1724 * @param tool GoProfileStrip object.
1725 * @return The right edge value.
1726 */
1727 GoFx(GoProfileStripEdgeType) GoProfileStrip_RightEdge(GoProfileStrip tool);
1728
1729 /**
1730 * Sets the right edge.
1731 *
1732 * @public @memberof GoProfileStrip
1733 * @version Introduced in firmware 4.0.10.27
1734 * @param tool GoProfileStrip object.
1735 * @param rightEdge Right edge value.
1736 * @return Operation status.
1737 */
1738 GoFx(kStatus) GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge);
1739
1740 /**
1741 * Gets the tilt enabled state.
1742 *
1743 * @public @memberof GoProfileStrip
1744 * @version Introduced in firmware 4.0.10.27
1745 * @param tool GoProfileStrip object.
1746 * @return kTRUE if tilt is enabled, kFALSE otherwise.
1747 */
1748 GoFx(kBool) GoProfileStrip_TiltEnabled(GoProfileStrip tool);
1749
1750 /**
1751 * Enables or disables tilt.
1752 *
1753 * @public @memberof GoProfileStrip
1754 * @version Introduced in firmware 4.0.10.27
1755 * @param tool GoProfileStrip object.
1756 * @param enable kTRUE to enable tilt, kFALSE to disable it.
1757 * @return Operation status.
1758 */
1759 GoFx(kStatus) GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable);
1760
1761
1762 /**
1763 * Gets the support width.
1764 *
1765 * @public @memberof GoProfileStrip
1766 * @version Introduced in firmware 4.5.3.57
1767 * @param tool GoProfileStrip object.
1768 * @return The support width (in mm).
1769 */
1770 GoFx(k64f) GoProfileStrip_SupportWidth(GoProfileStrip tool);
1771
1772 /**
1773 * Sets the support width.
1774 *
1775 * @public @memberof GoProfileStrip
1776 * @version Introduced in firmware 4.5.3.57
1777 * @param tool GoProfileStrip object.
1778 * @param value The support width (in mm).
1779 * @return Operation status.
1780 */
1781 GoFx(kStatus) GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value);
1782
1783
1784 /**
1785 * Gets the transition width limit minimum.
1786 *
1787 * @public @memberof GoProfileStrip
1788 * @version Introduced in firmware 4.5.3.57
1789 * @param tool GoProfileStrip object.
1790 * @return The minimum permissible transition width (in mm).
1791 */
1792 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool);
1793
1794 /**
1795 * Gets the transition width limit maximum.
1796 *
1797 * @public @memberof GoProfileStrip
1798 * @version Introduced in firmware 4.5.3.57
1799 * @param tool GoProfileStrip object.
1800 * @return The maximum permissible transition width (in mm).
1801 */
1802 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool);
1803
1804 /**
1805 * Gets the transition width.
1806 *
1807 * @public @memberof GoProfileStrip
1808 * @version Introduced in firmware 4.0.10.27
1809 * @param tool GoProfileStrip object.
1810 * @return The transition width (in mm).
1811 */
1812 GoFx(k64f) GoProfileStrip_TransitionWidth(GoProfileStrip tool);
1813
1814 /**
1815 * Sets the transition width.
1816 *
1817 * @public @memberof GoProfileStrip
1818 * @version Introduced in firmware 4.0.10.27
1819 * @param tool GoProfileStrip object.
1820 * @param value The transition width (in mm).
1821 * @return Operation status.
1822 */
1823 GoFx(kStatus) GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value);
1824
1825 /**
1826 * Gets the minimum width.
1827 *
1828 * @public @memberof GoProfileStrip
1829 * @version Introduced in firmware 4.0.10.27
1830 * @param tool GoProfileStrip object.
1831 * @return The minimum width (in mm).
1832 */
1833 GoFx(k64f) GoProfileStrip_MinWidth(GoProfileStrip tool);
1834
1835 /**
1836 * Sets the minimum width.
1837 *
1838 * @public @memberof GoProfileStrip
1839 * @version Introduced in firmware 4.0.10.27
1840 * @param tool GoProfileStrip object.
1841 * @param value The minimum width (in mm).
1842 * @return Operation status.
1843 */
1844 GoFx(kStatus) GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value);
1845
1846 /**
1847 * Gets the minimum height.
1848 *
1849 * @public @memberof GoProfileStrip
1850 * @version Introduced in firmware 4.0.10.27
1851 * @param tool GoProfileStrip object.
1852 * @return The minimum height (in mm).
1853 */
1854 GoFx(k64f) GoProfileStrip_MinHeight(GoProfileStrip tool);
1855
1856 /**
1857 * Sets the transition height.
1858 *
1859 * @public @memberof GoProfileStrip
1860 * @version Introduced in firmware 4.0.10.27
1861 * @param tool GoProfileStrip object.
1862 * @param value The minimum height (in mm).
1863 * @return Operation status.
1864 */
1865 GoFx(kStatus) GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value);
1866
1867 /**
1868 * Gets the maximum void width.
1869 *
1870 * @public @memberof GoProfileStrip
1871 * @version Introduced in firmware 4.0.10.27
1872 * @param tool GoProfileStrip object.
1873 * @return The maximum void width (in mm).
1874 */
1875 GoFx(k64f) GoProfileStrip_MaxVoidWidth(GoProfileStrip tool);
1876
1877 /**
1878 * Sets the maximum void width.
1879 *
1880 * @public @memberof GoProfileStrip
1881 * @version Introduced in firmware 4.0.10.27
1882 * @param tool GoProfileStrip object.
1883 * @param value The maximum void width (in mm).
1884 * @return Operation status.
1885 */
1886 GoFx(kStatus) GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value);
1887
1888 /**
1889 * Gets the profile strip tool region.
1890 *
1891 * @public @memberof GoProfileStrip
1892 * @version Introduced in firmware 4.0.10.27
1893 * @param tool GoProfileStrip object.
1894 * @return A GoProfileRegion object.
1895 */
1896 GoFx(GoProfileRegion) GoProfileStrip_Region(GoProfileStrip tool);
1897
1898 /**
1899 * Indicates whether the region is enabled.
1900 *
1901 * @public @memberof GoProfileStrip
1902 * @version Introduced in firmware 4.4.4.14
1903 * @param tool GoProfileStrip object.
1904 * @return kTRUE if enabled and kFALSE otherwise.
1905 */
1906 GoFx(kBool) GoProfileStrip_RegionEnabled(GoProfileStrip tool);
1907
1908 /**
1909 * Enables or disables the region.
1910 *
1911 * @public @memberof GoProfileStrip
1912 * @version Introduced in firmware 4.4.4.14
1913 * @param tool GoProfileStrip object.
1914 * @param enable kTRUE to enable the region and kFALSE to disable it.
1915 * @return Operation status.
1916 */
1917 GoFx(kStatus) GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable);
1918
1919 /**
1920 * Adds an additional profile strip tool measurement.
1921 *
1922 * @public @memberof GoProfileStrip
1923 * @version Introduced in firmware 4.0.10.27
1924 * @param tool GoProfileStrip object.
1925 * @param type The measurement type to add. It must be a valid profile strip tool type.
1926 * @param measurement A reference to the new GoMeasurement handle. Can be kNULL if you do not wish to do anything immediate with the new measurement.
1927 * @return Operation status.
1928 */
1929 GoFx(kStatus) GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement* measurement);
1930
1931 /**
1932 * Removes a measurement from the tool at the given index.
1933 *
1934 * @public @memberof GoProfileStrip
1935 * @version Introduced in firmware 4.0.10.27
1936 * @param tool GoProfileStrip object.
1937 * @param index The index with which to remove a measurement.
1938 * @return Operation status.
1939 */
1940 GoFx(kStatus) GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index);
1941
1942 /**
1943 * Returns the measurement count for the given tool.
1944 *
1945 * @public @memberof GoProfileStrip
1946 * @version Introduced in firmware 4.0.10.27
1947 * @param tool GoProfileStrip object.
1948 * @return Tool measurement count.
1949 */
1950 GoFx(kSize) GoProfileStrip_MeasurementCount(GoProfileStrip tool);
1951
1952 /**
1953 * Returns a measurement object at the given index.
1954 *
1955 * @public @memberof GoProfileStrip
1956 * @version Introduced in firmware 4.0.10.27
1957 * @param tool GoProfileStrip object.
1958 * @param index The index with which to return a measurement object.
1959 * @return A profile strip tool measurement or kNULL if the index is invalid.
1960 */
1961 GoFx(GoMeasurement) GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index);
1962
1963
1964 /**
1965 * @class GoProfileXLine
1966 * @extends GoProfileTool
1967 * @ingroup GoSdk-ProfileTools
1968 * @brief Represents a profile X-Line tool.
1969 */
1970 typedef GoProfileTool GoProfileXLine;
1971
1972 /**
1973 * Returns the enabled state of the tool region.
1974 *
1975 * @public @memberof GoProfileXLine
1976 * @version Introduced in firmware 4.3.3.124
1977 * @param tool GoProfileXLine object.
1978 * @return kTRUE if enabled and kFALSE if disabled.
1979 */
1980 GoFx(kBool) GoProfileXLine_RegionEnabled(GoProfileXLine tool);
1981
1982 /**
1983 * Enables or disables the tool region.
1984 *
1985 * @public @memberof GoProfileXLine
1986 * @version Introduced in firmware 4.3.3.124
1987 * @param tool GoProfileXLine object.
1988 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1989 * @return Operation status.
1990 */
1991 GoFx(kStatus) GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable);
1992
1993 /**
1994 * Gets the profile X-Line tool region.
1995 *
1996 * @public @memberof GoProfileXLine
1997 * @version Introduced in firmware 4.3.3.124
1998 * @param tool GoProfileXLine object.
1999 * @return A GoRegion3d object.
2000 */
2001 GoFx(GoProfileRegion) GoProfileXLine_Region(GoProfileXLine tool);
2002
2003 /**
2004 * Sets the profile X-Line tool maximum tracking speed.
2005 *
2006 * @public @memberof GoProfileXLine
2007 * @version Introduced in firmware 4.3.3.124
2008 * @param tool GoProfileXLine object.
2009 * @param value The value to set.
2010 * @return Operation status.
2011 */
2012 GoFx(kStatus) GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value);
2013
2014 /**
2015 * Gets the profile X-Line tool maximum tracking speed.
2016 *
2017 * @public @memberof GoProfileXLine
2018 * @version Introduced in firmware 4.3.3.124
2019 * @param tool GoProfileXLine object.
2020 * @return The maximum tracking speed.(mm/s)
2021 */
2022 GoFx(k64f) GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool);
2023
2024 /**
2025 * Returns a GoProfileXLine Z measurement object.
2026 *
2027 * @public @memberof GoProfileXLine
2028 * @version Introduced in firmware 4.3.3.124
2029 * @param tool GoProfileXLine object.
2030 * @return A GoProfileXLine Z measurement. (mm)
2031 */
2032 GoFx(GoProfileXLineZ) GoProfileXLine_ZMeasurement(GoProfileXLine tool);
2033
2034 /**
2035 * Returns a GoProfileXLine Validity measurement object.
2036 *
2037 * @public @memberof GoProfileXLine
2038 * @version Introduced in firmware 4.3.3.124
2039 * @param tool GoProfileXLine object.
2040 * @return A GoProfileXLine Validity measurement.
2041 */
2042 GoFx(GoProfileXLineZ) GoProfileXLine_ValidityMeasurement(GoProfileXLine tool);
2043
2044
2045
2046 /**
2047 * @class GoProfileRoundCorner
2048 * @extends GoProfileTool
2049 * @ingroup GoSdk-ProfileTools
2050 * @brief Represents a profile round corner tool.
2051 */
2052 typedef GoProfileTool GoProfileRoundCorner;
2053
2054 /**
2055 * Returns a GoProfileRoundCorner X measurement object.
2056 *
2057 * @public @memberof GoProfileRoundCorner
2058 * @version Introduced in firmware 4.0.10.27
2059 * @param tool GoProfileRoundCorner object.
2060 * @return A GoProfileRoundCorner X measurement.(mm)
2061 */
2062 GoFx(GoProfileRoundCornerX) GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool);
2063
2064 /**
2065 * Returns a GoProfileRoundCorner Z measurement object.
2066 *
2067 * @public @memberof GoProfileRoundCorner
2068 * @version Introduced in firmware 4.0.10.27
2069 * @param tool GoProfileRoundCorner object.
2070 * @return A GoProfileRoundCorner Z measurement.(mm)
2071 */
2072 GoFx(GoProfileRoundCornerZ) GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool);
2073
2074 /**
2075 * Returns a GoProfileRoundCorner Angle measurement object.
2076 *
2077 * @public @memberof GoProfileRoundCorner
2078 * @version Introduced in firmware 4.0.10.27
2079 * @param tool GoProfileRoundCorner object.
2080 * @return A GoProfileRoundCorner Angle measurement.(degrees)
2081 */
2082 GoFx(GoProfileRoundCornerAngle) GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool);
2083
2084 /**
2085 * Gets the edge.
2086 *
2087 * @public @memberof GoProfileRoundCorner
2088 * @version Introduced in firmware 4.0.10.27
2089 * @param tool GoProfileRoundCorner object.
2090 * @return The edge.
2091 */
2092 GoFx(GoProfileEdge) GoProfileRoundCorner_Edge(GoProfileRoundCorner tool);
2093
2094 /**
2095 * Sets the edge.
2096 *
2097 * @public @memberof GoProfileRoundCorner
2098 * @version Introduced in firmware 4.0.10.27
2099 * @param tool GoProfileRoundCorner object.
2100 * @param edge The edge.
2101 * @return Operation status.
2102 */
2103 GoFx(kStatus) GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge);
2104
2105 /**
2106 * Gets the reference direction.
2107 *
2108 * @public @memberof GoProfileRoundCorner
2109 * @version Introduced in firmware 4.0.10.27
2110 * @param tool GoProfileRoundCorner object.
2111 * @return The reference direction.
2112 */
2113 GoFx(GoProfileRoundCornerDirection) GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool);
2114
2115 /**
2116 * Sets the reference direction.
2117 *
2118 * @public @memberof GoProfileRoundCorner
2119 * @version Introduced in firmware 4.0.10.27
2120 * @param tool GoProfileRoundCorner object.
2121 * @param direction The reference direction.
2122 * @return Operation status.
2123 */
2124 GoFx(kStatus) GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction);
2125
2126 /**
2127 *
2128 *
2129 * @public @memberof GoProfileRoundCorner
2130 * @version Introduced in firmware 4.0.10.27
2131 * @param tool GoProfileRoundCorner object.
2132 * @return A GoProfileRoundCornerPoint point feature
2133 */
2134 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_Point(GoProfileRoundCorner tool);
2135
2136 /**
2137 * gets the round corner edge point
2138 *
2139 * @public @memberof GoProfileRoundCorner
2140 * @version Introduced in firmware 4.8.1.80
2141 * @param tool GoProfileRoundCorner object.
2142 * @return A GoProfileRoundCornerEdgePoint point feature
2143 */
2144 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool);
2145
2146 /**
2147 * gets the round corner center point
2148 *
2149 * @public @memberof GoProfileRoundCorner
2150 * @version Introduced in firmware 4.8.1.80
2151 * @param tool GoProfileRoundCorner object.
2152 * @return A GoProfileRoundCornerCenterPoint point feature
2153 */
2154 GoFx(GoProfileRoundCornerCenterPoint) GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool);
2155
2156 #include <GoSdk/Tools/GoProfileTools.x.h>
2157
2158 #endif
GoProfileBox::GoProfileBox_WidthMeasurement
GoProfileBoxWidth GoProfileBox_WidthMeasurement(GoProfileBox tool)
Returns a GoProfileBox Width measurement object.
GoProfileLine::GoProfileLine_MinErrorZMeasurement
GoProfileLineMinErrorZ GoProfileLine_MinErrorZMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Z Error measurement object.
GoProfileRoundCornerPoint
Represents a round corner point of a Profile Round tool.
GoProfileTool::GoProfileTool_ZAnchorEnabled
kBool GoProfileTool_ZAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anc...
GoProfilePosition::GoProfilePosition_Point
GoProfilePositionPoint GoProfilePosition_Point(GoProfilePosition tool)
Returns a GoProfilePosition point feature object.
GoProfileXLine::GoProfileXLine_EnableRegion
kStatus GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable)
Enables or disables the tool region.
GoProfileLine
Represents a profile line tool.
k32u
GoProfileStrip::GoProfileStrip_SetMinHeight
kStatus GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value)
Sets the transition height.
GoTool.h
Declares the base GoTool class.
GoProfileStrip::GoProfileStrip_Region
GoProfileRegion GoProfileStrip_Region(GoProfileStrip tool)
Gets the profile strip tool region.
GoProfileStrip::GoProfileStrip_SetRightEdge
kStatus GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge)
Sets the right edge.
GoProfileCircleX
Represents an X value measurement for a Profile Circle Tool.
GoProfileBox::GoProfileBox_HeightMeasurement
GoProfileBoxHeight GoProfileBox_HeightMeasurement(GoProfileBox tool)
Returns a GoProfileBox Height measurement object.
GoProfileIntersect::GoProfileIntersect_ZMeasurement
GoProfileIntersectZ GoProfileIntersect_ZMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Z measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_BridgeValueMeasurement
GoProfileBridgeValueBridgeValue GoProfileBridgeValue_BridgeValueMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue bridge value measurement object.
GoProfileBox::GoProfileBox_CenterPoint
GoProfileBoundingBoxCenterPoint GoProfileBox_CenterPoint(GoProfileBox tool)
Returns a GoProfileBox center point feature object.
GoMeasurement
Represents the base class for a tool measurement or script output.
GoProfileBoundingBoxCornerPoint
Represents a corner point for a Profile Bounding Box tool.
GoProfileLine::GoProfileLine_AngleMeasurement
GoProfileLineAngle GoProfileLine_AngleMeasurement(GoProfileLine tool)
Returns a GoProfileLine Angle measurement object.
GoProfileBox::GoProfileBox_RegionEnabled
kBool GoProfileBox_RegionEnabled(GoProfileBox tool)
Returns the enabled state of the tool region.
GoProfilePosition::GoProfilePosition_RegionEnabled
kBool GoProfilePosition_RegionEnabled(GoProfilePosition tool)
Indicates whether the region is enabled.
GoProfileBoxZ
Represents a Z measurement for a Profile Bounding Box tool.
GoProfilePanel::GoProfilePanel_LeftFlushXMeasurement
GoProfilePanelLeftFlushX GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush X measurement object.
GoProfileIntersect::GoProfileIntersect_SetRefLineType
kStatus GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type)
Sets the reference line type.
GoProfileRoundCornerCenterPoint
Represents a round corner circle center point of a Profile Round tool.
GoProfileStrip::GoProfileStrip_EnableRegion
kStatus GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable)
Enables or disables the region.
GoProfileGroove::GoProfileGroove_Region
GoProfileRegion GoProfileGroove_Region(GoProfileGroove tool)
Gets the profile region.
GoProfileLine::GoProfileLine_EnableFittingRegions
kStatus GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable)
Enables or disables the fitting regions.
GoProfileLine::GoProfileLine_Line
GoProfileLineLine GoProfileLine_Line(GoProfileLine tool)
Returns a GoProfileLine line feature object.
GoProfileIntersect::GoProfileIntersect_BaseLineFeature
GoProfileIntersectBaseLine GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool)
Returns a GoProfileIntersectBaseLine Feature object.
GoProfileCircle::GoProfileCircle_RadiusMeasurement
GoProfileCircleRadius GoProfileCircle_RadiusMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Radius measurement object.
GoProfileIntersect::GoProfileIntersect_RefLine
GoProfileLineRegion GoProfileIntersect_RefLine(GoProfileIntersect tool)
Gets the reference profile line.
GoProfileBox::GoProfileBox_XMeasurement
GoProfileBoxX GoProfileBox_XMeasurement(GoProfileBox tool)
Returns a GoProfileBox X measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_SetMaxInvalid
kStatus GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max invalid percentage.
GoProfileGroove::GoProfileGroove_MaxWidth
k64f GoProfileGroove_MaxWidth(GoProfileGroove tool)
Gets the groove width maximum.
GoProfileGroove::GoProfileGroove_SetMaxWidth
kStatus GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width)
Sets the groove width maximum.
GoProfileRoundCorner::GoProfileRoundCorner_Point
GoProfileRoundCornerPoint GoProfileRoundCorner_Point(GoProfileRoundCorner tool)
GoProfileRoundCorner::GoProfileRoundCorner_Edge
GoProfileEdge GoProfileRoundCorner_Edge(GoProfileRoundCorner tool)
Gets the edge.
GoProfileGroove::GoProfileGroove_SetMinDepth
kStatus GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth)
Sets the groove depth minimum.
GoProfilePanel::GoProfilePanel_LeftFlushZMeasurement
GoProfilePanelLeftFlushZ GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush Z measurement object.
GoProfilePanelGap
Represents a gap measurement for a Profile Panel Tool.
GoProfileBridgeValue::GoProfileBridgeValue_EnableRegion
kStatus GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable)
Enables or disables the tool region.
GoProfileTool::GoProfileTool_XAnchorOptionCount
kSize GoProfileTool_XAnchorOptionCount(GoProfileTool tool)
Gets the X-anchoring option list count.
GoMeasurementType
Lists all measurement types.
GoProfileGroove::GoProfileGroove_AddMeasurement
kStatus GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile groove tool measurement.
GoProfileDim
Represents a profile dimension tool.
GoProfilePanel::GoProfilePanel_RightFlushZMeasurement
GoProfilePanelRightFlushZ GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Flush Z measurement object.
GoProfileArea::GoProfileArea_LineRegion
GoProfileLineRegion GoProfileArea_LineRegion(GoProfileArea tool)
Gets the reference profile line.
GoProfileXLine::GoProfileXLine_SetMaxTrackingSpeed
kStatus GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value)
Sets the profile X-Line tool maximum tracking speed.
GoProfilePanelLeftSurfaceAngle
Represents a Left Surface Angle measurement for a Profile Panel tool.
GoProfileTool::GoProfileTool_StreamOptionAt
GoDataStream GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index)
Gets the data stream option at the given index.
GoProfilePanel::GoProfilePanel_LeftGapZMeasurement
GoProfilePanelLeftGapZ GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap Z measurement object.
GoProfileDimCenterX
Represents a center X value measurement for a Profile Dimension Tool.
GoProfilePanelFlush
Represents a flush measurement for a Profile Panel Tool.
GoProfileBridgeValue::GoProfileBridgeValue_Region
GoProfileRegion GoProfileBridgeValue_Region(GoProfileBridgeValue tool)
Gets the bridge value profile region.
GoProfileBox
Represents a profile bounding box tool.
GoProfileLine::GoProfileLine_MaxErrorPoint
GoProfileLineMaxErrorPoint GoProfileLine_MaxErrorPoint(GoProfileLine tool)
Returns a GoProfileLine min error point feature object.
GoProfileLine::GoProfileLine_MinErrorMeasurement
GoProfileLineMinError GoProfileLine_MinErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Error measurement object.
GoProfileCircle::GoProfileCircle_MinErrorXMeasurement
GoProfileCircleRadius GoProfileCircle_MinErrorXMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Min Error X measurement object.
GoProfileLineLine
Represents a point of a Profile Line tool.
GoProfileGroove::GoProfileGroove_EnableRegion
kStatus GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable)
Enables or disables the region.
GoProfilePosition::GoProfilePosition_Feature
GoProfileFeature GoProfilePosition_Feature(GoProfilePosition tool)
Gets the profile feature.
GoProfileBoundingBoxCenterPoint
ReprRepresents a center point for a Profile Bounding Box tool.
GoProfileBox::GoProfileBox_CornerPoint
GoProfileBoundingBoxCornerPoint GoProfileBox_CornerPoint(GoProfileBox tool)
Returns a GoProfileBox corner point feature object.
GoProfileGroove::GoProfileGroove_SetShape
kStatus GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape)
Sets the groove determination shape.
GoProfileArea::GoProfileArea_EnableRegion
kStatus GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable)
Enables or disables the region.
GoProfileLineMaxErrorZ
Represents a Maximum Z Error measurement for a Profile Line Tool.
GoProfileLine::GoProfileLine_MaxErrorZMeasurement
GoProfileLineMaxErrorZ GoProfileLine_MaxErrorZMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Z Error measurement object.
GoProfileCircle::GoProfileCircle_MaxErrorXMeasurement
GoProfileCircleRadius GoProfileCircle_MaxErrorXMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Max Error X measurement object.
GoProfilePanel::GoProfilePanel_SetRefEdgeSide
kStatus GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side)
Sets the reference edge side.
GoProfileIntersectIntersectPoint
Represents a point of intersection for a Profile Intersect tool.
kSize
GoProfileCircle::GoProfileCircle_MaxErrorMeasurement
GoProfileCircleRadius GoProfileCircle_MaxErrorMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Max Error measurement object.
GoProfileBridgeValueStdDev
Represents an standard deviation measurement for a Profile Bridge Value tool.
GoProfileStrip::GoProfileStrip_MinWidth
k64f GoProfileStrip_MinWidth(GoProfileStrip tool)
Gets the minimum width.
GoProfileCircle::GoProfileCircle_Region
GoProfileRegion GoProfileCircle_Region(GoProfileCircle tool)
Gets the profile region.
GoProfileBridgeValue::GoProfileBridgeValue_WindowSkip
k64f GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool)
Gets the profile X-Line tool window skip percentage.
GoProfileGroove::GoProfileGroove_MeasurementAt
GoMeasurement GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index)
Returns a measurement object at the given index.
GoProfileStrip::GoProfileStrip_RemoveMeasurement
kStatus GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index)
Removes a measurement from the tool at the given index.
GoProfileStrip::GoProfileStrip_RightEdge
GoProfileStripEdgeType GoProfileStrip_RightEdge(GoProfileStrip tool)
Gets the right edge value.
GoProfileArea::GoProfileArea_SetType
kStatus GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type)
Sets the profile area type.
GoProfileBox::GoProfileBox_Region
GoProfileRegion GoProfileBox_Region(GoProfileBox tool)
Gets the profile bounding box region.
GoProfileTool::GoProfileTool_ZAnchor
k32s GoProfileTool_ZAnchor(GoProfileTool tool)
Gets the current Z-anchoring source.
GoProfileStrip::GoProfileStrip_MeasurementCount
kSize GoProfileStrip_MeasurementCount(GoProfileStrip tool)
Returns the measurement count for the given tool.
GoProfileIntersect
Represents a profile intersect tool.
GoProfileRoundCornerZ
Represents an Z measurement for a Profile Round Corner tool.
GoProfileLineMinErrorZ
Represents a Minimum Z Error measurement for a Profile Line Tool.
GoProfileIntersect::GoProfileIntersect_LineFeature
GoProfileIntersectLine GoProfileIntersect_LineFeature(GoProfileIntersect tool)
Returns a GoProfileIntersectLine Feature object.
GoProfileTool::GoProfileTool_SetSource
kStatus GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source)
Sets the data source.
GoProfileBox::GoProfileBox_GlobalXMeasurement
GoProfileBoxGlobalX GoProfileBox_GlobalXMeasurement(GoProfileBox tool)
Returns a GoProfileBox global X measurement object.
GoProfileDimWidth
Represents a width value measurement for a Profile Dimension Tool.
GoProfileTool::GoProfileTool_StreamOptionCount
kSize GoProfileTool_StreamOptionCount(GoProfileTool tool)
Gets the data stream option list count.
GoDataStream
Represents a data stream which consists of a data step and ID.
Definition: GoSdkDef.h:1228
GoDataSource
Represents a data source.
GoProfileBridgeValueAngle
Represents an angle measurement for a Profile Bridge Value tool.
GoProfileArea
Represents a profile area tool.
GoProfileStrip::GoProfileStrip_SetTransitionWidth
kStatus GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value)
Sets the transition width.
GoProfileGroove::GoProfileGroove_MinDepth
k64f GoProfileGroove_MinDepth(GoProfileGroove tool)
Gets the groove depth minimum.
GoProfileCircle::GoProfileCircle_MinErrorZMeasurement
GoProfileCircleRadius GoProfileCircle_MinErrorZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Min Error Z measurement object.
GoProfilePanel::GoProfilePanel_FlushMeasurement
GoProfilePanelFlush GoProfilePanel_FlushMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Flush measurement object.
GoProfileArea::GoProfileArea_CenterPoint
GoProfileAreaCenterPoint GoProfileArea_CenterPoint(GoProfileArea tool)
Returns a GoProfileArea Center point feature object.
GoProfileStrip::GoProfileStrip_TiltEnabled
kBool GoProfileStrip_TiltEnabled(GoProfileStrip tool)
Gets the tilt enabled state.
GoUtils.h
Contains various helper functions.
GoProfileRoundCorner::GoProfileRoundCorner_RefDirection
GoProfileRoundCornerDirection GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool)
Gets the reference direction.
GoProfileIntersectX
Represents an intersect X measurement for a Profile Intersect Tool.
GoProfileEdge
Represents a profile edge used in various profile tools.
GoProfilePanel
Represents a profile panel tool.
GoProfileIntersect::GoProfileIntersect_Line
GoProfileLineRegion GoProfileIntersect_Line(GoProfileIntersect tool)
Gets the non-reference profile line.
GoProfileBridgeValue::GoProfileBridgeValue_NormalizeEnabled
kBool GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool)
Returns the enabled state of normalization.
GoProfileLineMaxError
Represents a maximum error measurement for a Profile Line Tool.
GoProfileArea::GoProfileArea_Type
GoProfileAreaType GoProfileArea_Type(GoProfileArea tool)
Gets the profile area type.
GoProfileGroove
Represents a profile groove tool.
GoProfileXLine::GoProfileXLine_RegionEnabled
kBool GoProfileXLine_RegionEnabled(GoProfileXLine tool)
Returns the enabled state of the tool region.
GoProfileStrip::GoProfileStrip_LeftEdge
GoProfileStripEdgeType GoProfileStrip_LeftEdge(GoProfileStrip tool)
Gets the left edge value.
GoProfileBridgeValue::GoProfileBridgeValue_MaxDifferentialLimitMax
k64f GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential maximum value limit.
GoProfileAreaCentroidZ
Represents a centroid Z measurement for a Profile Area Tool.
GoProfileRoundCorner::GoProfileRoundCorner_CenterPoint
GoProfileRoundCornerCenterPoint GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool)
gets the round corner center point
GoProfilePanelLeftGapX
Represents a Left Gap X measurement for a Profile Panel tool.
GoProfileStrip::GoProfileStrip_SetMaxVoidWidth
kStatus GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value)
Sets the maximum void width.
GoProfileArea::GoProfileArea_AreaMeasurement
GoProfileAreaArea GoProfileArea_AreaMeasurement(GoProfileArea tool)
Returns a GoProfileArea Area measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_MaxDifferentialLimitMin
k64f GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential minimum value limit.
GoProfileRegion
Represents a profile region used in various profile tools.
GoProfileLine::GoProfileLine_MinErrorPoint
GoProfileLineMinErrorPoint GoProfileLine_MinErrorPoint(GoProfileLine tool)
Returns a GoProfileLine Maximum Z Error measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_EnableNormalize
kStatus GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable)
Enables or disables normalization.
GoProfileTool::GoProfileTool_XAnchorEnabled
kBool GoProfileTool_XAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anc...
GoProfileCircle
Represents a profile circle tool.
GoProfilePanel::GoProfilePanel_RightGapZMeasurement
GoProfilePanelRightGapZ GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap Z measurement object.
GoProfileDim::GoProfileDim_CenterPoint
GoProfileDimensionCenterPoint GoProfileDim_CenterPoint(GoProfileDim tool)
Returns a GoProfileDim Center point feature object.
GoProfilePanel::GoProfilePanel_LeftGapXMeasurement
GoProfilePanelLeftGapX GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap X measurement object.
GoProfilePanelRightGapZ
Represents a Right Gap Z measurement for a Profile Panel tool.
GoProfileArea::GoProfileArea_CentroidXMeasurement
GoProfileAreaCentroidX GoProfileArea_CentroidXMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid X measurement object.
GoProfileTool::GoProfileTool_XAnchor
k32s GoProfileTool_XAnchor(GoProfileTool tool)
Gets the current X-anchoring source.
GoProfilePanelLeftFlushX
Represents a Left Flush X measurement for a Profile Panel tool.
GoProfileAreaArea
Represents an area measurement for a Profile Area tool.
GoProfileRoundCornerDirection
Selects which reference direction to use for the round corner tool.
GoProfilePanel::GoProfilePanel_RightEdge
GoProfileEdge GoProfilePanel_RightEdge(GoProfilePanel tool)
Gets the right profile edge.
GoProfileBoxHeight
Represents a height measurement for a Profile Bounding Box tool.
GoProfileIntersect::GoProfileIntersect_PointFeature
GoProfileIntersectIntersectPoint GoProfileIntersect_PointFeature(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
GoProfileBoxGlobalAngle
Represents a global angle measurement for a Profile Bounding Box tool.
GoProfileLineMinError
Represents a minimum error measurement for a Profile Line Tool.
GoProfileGrooveShape
Represents a profile edge type.
GoProfileGroove::GoProfileGroove_RegionEnabled
kBool GoProfileGroove_RegionEnabled(GoProfileGroove tool)
Indicates whether the region is enabled.
GoProfilePosition::GoProfilePosition_EnableRegion
kStatus GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable)
Enables or disables the region.
GoProfilePositionZ
Represents an Z measurement for a Profile Position tool.
GoSdkDef.h
Essential SDK declarations.
GoProfileRoundCorner::GoProfileRoundCorner_XMeasurement
GoProfileRoundCornerX GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner X measurement object.
GoProfileArea::GoProfileArea_Baseline
GoProfileBaseline GoProfileArea_Baseline(GoProfileArea tool)
Gets the profile area baseline.
GoProfileRoundCorner::GoProfileRoundCorner_SetRefDirection
kStatus GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction)
Sets the reference direction.
GoProfileDim::GoProfileDim_CenterXMeasurement
GoProfileDimCenterX GoProfileDim_CenterXMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center X measurement object.
GoProfileTool::GoProfileTool_ZAnchorOptionAt
k32u GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the Z-anchoring option at the given index.
GoProfileIntersect::GoProfileIntersect_XMeasurement
GoProfileIntersectX GoProfileIntersect_XMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect X measurement object.
GoProfilePosition::GoProfilePosition_ZMeasurement
GoProfilePositionZ GoProfilePosition_ZMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition Z measurement object.
GoProfileTool::GoProfileTool_SetZAnchor
kStatus GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id)
Sets the Z-anchoring source.
GoProfileBox::GoProfileBox_GlobalAngleMeasurement
GoProfileBoxGlobalAngle GoProfileBox_GlobalAngleMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Angle measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_MaxDifferential
k64f GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential.
GoProfileLinePercentile
Represents a percentile measurement for a Profile Line Tool.
GoProfilePanel::GoProfilePanel_RefEdgeSide
GoProfilePanelSide GoProfilePanel_RefEdgeSide(GoProfilePanel tool)
Gets the reference edge side.
GoProfileStrip
Represents a profile strip tool.
GoProfileCircle::GoProfileCircle_EnableRegion
kStatus GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable)
Enables or disables the region.
GoProfileLine::GoProfileLine_StdDevMeasurement
GoProfileLineStdDev GoProfileLine_StdDevMeasurement(GoProfileLine tool)
Returns a GoProfileLine Standard Deviation measurement object.
GoProfileStrip::GoProfileStrip_BaseType
GoProfileStripBaseType GoProfileStrip_BaseType(GoProfileStrip tool)
Gets the strip base type.
GoProfileBridgeValue::GoProfileBridgeValue_WindowMeasurement
GoProfileBridgeValueWindow GoProfileBridgeValue_WindowMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue window measurement object.
GoProfileAreaCenterPoint
Represents a center point of a Profile Area tool.
GoTool
Represents the base tool class.
GoProfilePositionPoint
Represents a point of a Profile Position tool.
GoProfileDim::GoProfileDim_WidthMeasurement
GoProfileDimWidth GoProfileDim_WidthMeasurement(GoProfileDim tool)
Returns a GoProfileDim Width measurement object.
GoProfileBoxX
Represents an X measurement for a Profile Bounding Box tool.
GoProfileTool::GoProfileTool_Stream
GoDataStream GoProfileTool_Stream(GoProfileTool tool)
Gets the data stream.
GoProfileBox::GoProfileBox_EnableRegion
kStatus GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable)
Enables or disables the tool region.
GoProfileArea::GoProfileArea_CentroidZMeasurement
GoProfileAreaCentroidZ GoProfileArea_CentroidZMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid Z measurement object.
GoProfileLine::GoProfileLine_FittingRegionsEnabled
kBool GoProfileLine_FittingRegionsEnabled(GoProfileLine tool)
Indicates whether the fitting regions are enabled.
GoProfileBridgeValue
Represents a profile bridge value tool.
GoProfileDimHeight
Represents a height value measurement for a Profile Dimension Tool.
GoProfileCircleCenterPoint
Represents a center point of a Profile Circle tool.
GoProfileStripBaseType
Represents a profile strip tool base type.
GoProfileFeature
Represents a profile feature used in various profile tools.
GoProfileStrip::GoProfileStrip_MaxVoidWidth
k64f GoProfileStrip_MaxVoidWidth(GoProfileStrip tool)
Gets the maximum void width.
k32s
GoProfileIntersect::GoProfileIntersect_RefLineType
GoProfileBaseline GoProfileIntersect_RefLineType(GoProfileIntersect tool)
Gets the reference profile line type.
GoProfileLine::GoProfileLine_PercentileMeasurement
GoProfileLinePercentile GoProfileLine_PercentileMeasurement(GoProfileLine tool)
Returns a GoProfileLine Percentile measurement object.
GoProfileStrip::GoProfileStrip_RegionEnabled
kBool GoProfileStrip_RegionEnabled(GoProfileStrip tool)
Indicates whether the region is enabled.
GoProfileStripEdgeType
Represents a profile strip tool edge type.
GoProfileCircleZ
Represents a Z value measurement for a Profile Circle Tool.
GoProfilePanel::GoProfilePanel_LeftEdge
GoProfileEdge GoProfilePanel_LeftEdge(GoProfilePanel tool)
Gets the left profile edge.
GoProfileTool::GoProfileTool_XAnchorOptionAt
k32u GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the X-anchoring option at the given index.
GoProfileBoxGlobalY
Represents a global Y measurement for a Profile Bounding Box tool.
GoProfileStrip::GoProfileStrip_SupportWidth
k64f GoProfileStrip_SupportWidth(GoProfileStrip tool)
Gets the support width.
GoProfileDim::GoProfileDim_Feature
GoProfileFeature GoProfileDim_Feature(GoProfileDim tool)
Gets the non-reference profile feature.
GoProfileRoundCorner::GoProfileRoundCorner_ZMeasurement
GoProfileRoundCornerZ GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner Z measurement object.
GoProfileArea::GoProfileArea_BaselineUsed
kBool GoProfileArea_BaselineUsed(GoProfileArea tool)
Returns a boolean representing whether the profile area baseline is used.
GoProfileTool::GoProfileTool_SourceOptionAt
GoDataSource GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index)
Gets the data source option at the given index.
GoProfileDim::GoProfileDim_RefFeature
GoProfileFeature GoProfileDim_RefFeature(GoProfileDim tool)
Gets the reference profile feature.
GoProfileArea::GoProfileArea_Region
GoProfileRegion GoProfileArea_Region(GoProfileArea tool)
Gets the profile region.
GoProfileStrip::GoProfileStrip_MinHeight
k64f GoProfileStrip_MinHeight(GoProfileStrip tool)
Gets the minimum height.
GoProfileBridgeValue::GoProfileBridgeValue_WindowSize
k64f GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool)
Gets the profile X-Line tool window size percentage.
GoProfileStrip::GoProfileStrip_AddMeasurement
kStatus GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile strip tool measurement.
GoProfileStrip::GoProfileStrip_MeasurementAt
GoMeasurement GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index)
Returns a measurement object at the given index.
GoProfileBridgeValue::GoProfileBridgeValue_SetMaxDifferential
kStatus GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max differential.
GoProfileLine::GoProfileLine_OffsetMeasurement
GoProfileLineOffset GoProfileLine_OffsetMeasurement(GoProfileLine tool)
Returns a GoProfileLine Offset measurement object.
GoProfileStrip::GoProfileStrip_SetBaseType
kStatus GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type)
Sets the strip base type.
GoProfileIntersectBaseLine
Represents a base line feature of a Profile Intersect tool tool.
GoProfileLineAngle
Represents an Angle measurement for a Profile Line Tool.
GoProfilePanel::GoProfilePanel_GapMeasurement
GoProfilePanelGap GoProfilePanel_GapMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Gap measurement object.
GoProfileXLine
Represents a profile X-Line tool.
GoProfileBridgeValue::GoProfileBridgeValue_RegionEnabled
kBool GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool)
Returns the enabled state of the tool region.
GoProfilePanelRightFlushZ
Represents a Right Flush Z measurement for a Profile Panel tool.
GoProfileGroove::GoProfileGroove_Shape
GoProfileGrooveShape GoProfileGroove_Shape(GoProfileGroove tool)
Gets the current groove determination shape.
GoProfileRoundCornerX
Represents an X measurement for a Profile Round Corner tool.
GoProfileLineMaxErrorPoint
Represents a point of maximum error for a Profile Line tool.
GoProfileCircle::GoProfileCircle_MinErrorMeasurement
GoProfileCircleRadius GoProfileCircle_MinErrorMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Min Error measurement object.
GoProfileStrip::GoProfileStrip_TransitionWidthLimitMin
k64f GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool)
Gets the transition width limit minimum.
GoProfileStrip::GoProfileStrip_SetMinWidth
kStatus GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value)
Sets the minimum width.
GoProfilePanel::GoProfilePanel_LeftSurfaceAngleMeasurement
GoProfilePanelLeftSurfaceAngle GoProfilePanel_LeftSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Surface Angle measurement object.
GoProfileCircle::GoProfileCircle_CenterPoint
GoProfileCircleCenterPoint GoProfileCircle_CenterPoint(GoProfileCircle tool)
Returns a GoProfileCircle center point feature object.
GoProfileRoundCorner::GoProfileRoundCorner_EdgePoint
GoProfileRoundCornerPoint GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool)
gets the round corner edge point
GoProfileXLine::GoProfileXLine_Region
GoProfileRegion GoProfileXLine_Region(GoProfileXLine tool)
Gets the profile X-Line tool region.
GoProfileTool::GoProfileTool_SourceOptionCount
kSize GoProfileTool_SourceOptionCount(GoProfileTool tool)
Gets the data source option list count.
GoProfileToolUtils.h
Declares shared profile tool configuration classes.
GoProfileCircle::GoProfileCircle_StdDevMeasurement
GoProfileCircleRadius GoProfileCircle_StdDevMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle StdDev measurement object.
GoProfilePosition::GoProfilePosition_XMeasurement
GoProfilePositionX GoProfilePosition_XMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition X measurement object.
GoProfileLineStdDev
Represents a standard deviation measurement for a Profile Line Tool.
GoProfileDimCenterZ
Represents a center Z value measurement for a Profile Dimension Tool.
GoProfileBridgeValue::GoProfileBridgeValue_AngleMeasurement
GoProfileBridgeValueAngle GoProfileBridgeValue_AngleMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue angle measurement object.
GoProfileGroove::GoProfileGroove_RemoveMeasurement
kStatus GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index)
Removes a measurement from the tool at the given index.
GoProfileBridgeValue::GoProfileBridgeValue_SetWindowSkip
kStatus GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window skip percentage.
GoProfileXLine::GoProfileXLine_ZMeasurement
GoProfileXLineZ GoProfileXLine_ZMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Z measurement object.
GoProfileIntersect::GoProfileIntersect_AngleMeasurement
GoProfileIntersectAngle GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
GoProfileAreaCentroidX
Represents a centroid X measurement for a Profile Area Tool.
GoProfileArea::GoProfileArea_TypeUsed
kBool GoProfileArea_TypeUsed(GoProfileArea tool)
Gets the boolean representing whether the area type is used.
GoProfileLine::GoProfileLine_MaxErrorMeasurement
GoProfileLineMaxError GoProfileLine_MaxErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Error measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_MaxInvalid
k64f GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool)
Gets the profile X-Line tool max invalid percentage.
GoProfileLine::GoProfileLine_EnableRegion
kStatus GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable)
Enables or disables the region.
GoProfileLineMaxErrorX
Represents a Maximum X Error measurement for a Profile Line Tool.
GoProfilePanelLeftGapZ
Represents a Left Gap Z measurement for a Profile Panel tool.
GoProfileRoundCorner::GoProfileRoundCorner_SetEdge
kStatus GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge)
Sets the edge.
GoProfileGroove::GoProfileGroove_SetMinWidth
kStatus GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width)
Sets the groove width minimum.
GoProfileBox::GoProfileBox_ZMeasurement
GoProfileBoxZ GoProfileBox_ZMeasurement(GoProfileBox tool)
Returns a GoProfileBox Z measurement object.
kStatus
GoProfileTool::GoProfileTool_SetStream
kStatus GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream)
Sets the data stream.
GoProfileStrip::GoProfileStrip_SetLeftEdge
kStatus GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge)
Sets the left edge.
GoProfileLine::GoProfileLine_MinErrorXMeasurement
GoProfileLineMinErrorX GoProfileLine_MinErrorXMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum X Error measurement object.
GoProfileArea::GoProfileArea_RegionEnabled
kBool GoProfileArea_RegionEnabled(GoProfileArea tool)
Indicates whether the region is enabled.
GoProfileTool::GoProfileTool_Source
GoDataSource GoProfileTool_Source(GoProfileTool tool)
Gets the data source.
GoProfileCircle::GoProfileCircle_MaxErrorZMeasurement
GoProfileCircleRadius GoProfileCircle_MaxErrorZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Max Error Z measurement object.
GoProfileIntersectAngle
Represents an intersect angle measurement for a Profile Intersect Tool.
GoProfileStrip::GoProfileStrip_TransitionWidth
k64f GoProfileStrip_TransitionWidth(GoProfileStrip tool)
Gets the transition width.
GoProfileCircleRadius
Represents a radius value measurement for a Profile Circle Tool.
GoProfileLineMinErrorX
Represents an Minimum X Error measurement for a Profile Line Tool.
GoProfilePanelRightGapX
Represents a Right Gap X measurement for a Profile Panel tool.
GoProfileXLineZ
Represents an Z measurement for a Profile X-Line tool.
GoProfilePanelLeftFlushZ
Represents a Left Flush Z measurement for a Profile Panel tool.
GoProfileBoxWidth
Represents a width measurement for a Profile Bounding Box tool.
GoProfileDim::GoProfileDim_HeightMeasurement
GoProfileDimHeight GoProfileDim_HeightMeasurement(GoProfileDim tool)
Returns a GoProfileDim Height measurement object.
GoProfileBox::GoProfileBox_GlobalYMeasurement
GoProfileBoxGlobalY GoProfileBox_GlobalYMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Y measurement object.
GoProfileStrip::GoProfileStrip_TransitionWidthLimitMax
k64f GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool)
Gets the transition width limit maximum.
GoProfilePanel::GoProfilePanel_SetMaxGapWidth
kStatus GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width)
Sets the maximum gap width.
k64f
GoProfileRoundCorner::GoProfileRoundCorner_AngleMeasurement
GoProfileRoundCornerAngle GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner Angle measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_StdDevMeasurement
GoProfileBridgeValueStdDev GoProfileBridgeValue_StdDevMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue standard deviation measurement object.
GoProfileXLine::GoProfileXLine_MaxTrackingSpeed
k64f GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool)
Gets the profile X-Line tool maximum tracking speed.
GoProfileLineOffset
Represents an offset measurement for a Profile Line Tool.
GoProfileAreaType
Determines how to calculate profile area.
GoProfileTool::GoProfileTool_SetXAnchor
kStatus GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id)
Sets the X-anchoring source.
GoProfileDim::GoProfileDim_DistanceMeasurement
GoProfileDimDistance GoProfileDim_DistanceMeasurement(GoProfileDim tool)
Returns a GoProfileDim Distance measurement object.
GoProfileIntersectZ
Represents an intersect Z measurement for a Profile Intersect Tool.
GoProfilePositionX
Represents an X measurement for a Profile Position tool.
GoProfileLine::GoProfileLine_MaxErrorXMeasurement
GoProfileLineMaxErrorX GoProfileLine_MaxErrorXMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum X Error measurement object.
GoProfileBridgeValueWindow
Represents an window measurement for a Profile Bridge Value tool.
kBool
GoProfileCircle::GoProfileCircle_XMeasurement
GoProfileCircleX GoProfileCircle_XMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle X measurement object.
GoProfileCircle::GoProfileCircle_ZMeasurement
GoProfileCircleZ GoProfileCircle_ZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Z measurement object.
GoProfileLine::GoProfileLine_RegionEnabled
kBool GoProfileLine_RegionEnabled(GoProfileLine tool)
Indicates whether the region is enabled.
GoProfilePanel::GoProfilePanel_MaxGapWidth
k64f GoProfilePanel_MaxGapWidth(GoProfilePanel tool)
Gets the maximum gap width.
GoProfileGroove::GoProfileGroove_MeasurementCount
kSize GoProfileGroove_MeasurementCount(GoProfileGroove tool)
Returns the measurement count for the given tool.
GoProfileDim::GoProfileDim_CenterZMeasurement
GoProfileDimCenterZ GoProfileDim_CenterZMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center Z measurement object.
GoProfileBridgeValueBridgeValue
Represents a bridge value measurement for a Profile Bridge Value tool.
GoProfileStrip::GoProfileStrip_EnableTilt
kStatus GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable)
Enables or disables tilt.
GoProfileBaseline
Determines whether to use a line based on a Profile Line fit, or based on the x-axis.
GoProfileIntersectLine
Represents a line for a Profile Intersect tool.
GoProfileLineMinErrorPoint
Represents a point of minimum error for a Profile Line tool.
GoProfileCircle::GoProfileCircle_RegionEnabled
kBool GoProfileCircle_RegionEnabled(GoProfileCircle tool)
Indicates whether the region is enabled.
GoProfileTool
Represents a base profile tool.
GoProfileArea::GoProfileArea_SetBaseline
kStatus GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type)
Sets the profile area type.
GoProfilePanelRightSurfaceAngle
Represents a Right Surface Angle measurement for a Profile Panel tool.
GoProfileStrip::GoProfileStrip_SetSupportWidth
kStatus GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value)
Sets the support width.
GoProfileTool::GoProfileTool_ZAnchorOptionCount
kSize GoProfileTool_ZAnchorOptionCount(GoProfileTool tool)
Gets the Z-anchoring option list count.
GoProfileBoxGlobalX
Represents a global X measurement for a Profile Bounding Box tool.
GoProfileRoundCorner
Represents a profile round corner tool.
GoProfileBridgeValue::GoProfileBridgeValue_SetWindowSize
kStatus GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window size percentage.
GoProfileGroove::GoProfileGroove_MinWidth
k64f GoProfileGroove_MinWidth(GoProfileGroove tool)
Gets the groove width minimum value.
GoProfileRoundCornerAngle
Represents an Angle measurement for a Profile Round Corner tool.
GoProfilePanel::GoProfilePanel_RightGapXMeasurement
GoProfilePanelRightGapX GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap X measurement object.
GoProfileDimensionCenterPoint
Represents a center point of a Profile Dimension tool.
GoProfilePosition
Represents a profile position tool.
GoProfileDimDistance
Represents a distance value measurement for a Profile Dimension Tool.
GoProfileXLine::GoProfileXLine_ValidityMeasurement
GoProfileXLineZ GoProfileXLine_ValidityMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Validity measurement object.
GoProfilePanel::GoProfilePanel_RightSurfaceAngleMeasurement
GoProfilePanelRightSurfaceAngle GoProfilePanel_RightSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Surface Angle measurement object.