Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoProfileToolUtils.h
1 /// @cond (Gocator_1x00 || Gocator_2x00)
2
3 /**
4 * @file GoProfileToolUtils.h
5 * @brief Declares shared profile tool configuration classes.
6 *
7 * @internal
8 * Copyright (C) 2015 by LMI Technologies Inc.
9 * Licensed under the MIT License.
10 * Redistributed files must retain the above copyright notice.
11 */
12 #ifndef GO_PROFILE_TOOL_UTILS_H
13 #define GO_PROFILE_TOOL_UTILS_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/GoUtils.h>
17 kBeginHeader()
18
19 /**
20 * @class GoProfileRegion
21 * @extends kObject
22 * @ingroup GoSdk-ProfileTools
23 * @brief Represents a profile region used in various profile tools.
24 */
25 typedef kObject GoProfileRegion;
26
27 /**
28 * Sets the X position.
29 *
30 * @public @memberof GoProfileRegion
31 * @version Introduced in firmware 4.0.10.27
32 * @param region GoProfileRegion object.
33 * @param x The X-position to set.
34 * @return Operation status.
35 */
36 GoFx(kStatus) GoProfileRegion_SetX(GoProfileRegion region, k64f x);
37
38 /**
39 * Gets the X-position.
40 *
41 * @public @memberof GoProfileRegion
42 * @version Introduced in firmware 4.0.10.27
43 * @param region GoProfileRegion object.
44 * @return The X-position of the region.
45 */
46 GoFx(k64f) GoProfileRegion_X(GoProfileRegion region);
47
48 /**
49 * Sets the Z-position.
50 *
51 * @public @memberof GoProfileRegion
52 * @version Introduced in firmware 4.0.10.27
53 * @param region GoProfileRegion object.
54 * @param z The Z-position to set.
55 * @return Operation status.
56 */
57 GoFx(kStatus) GoProfileRegion_SetZ(GoProfileRegion region, k64f z);
58
59 /**
60 * Gets the Z-position.
61 *
62 * @public @memberof GoProfileRegion
63 * @version Introduced in firmware 4.0.10.27
64 * @param region GoProfileRegion object.
65 * @return The Z-position of the region.
66 */
67 GoFx(k64f) GoProfileRegion_Z(GoProfileRegion region);
68
69 /**
70 * Sets the width.
71 *
72 * @public @memberof GoProfileRegion
73 * @version Introduced in firmware 4.0.10.27
74 * @param region GoProfileRegion object.
75 * @param width The width to set.
76 * @return Operation status.
77 */
78 GoFx(kStatus) GoProfileRegion_SetWidth(GoProfileRegion region, k64f width);
79
80 /**
81 * Gets the width.
82 *
83 * @public @memberof GoProfileRegion
84 * @version Introduced in firmware 4.0.10.27
85 * @param region GoProfileRegion object.
86 * @return The width of the region.
87 */
88 GoFx(k64f) GoProfileRegion_Width(GoProfileRegion region);
89
90 /**
91 * Sets the height.
92 *
93 * @public @memberof GoProfileRegion
94 * @version Introduced in firmware 4.0.10.27
95 * @param region GoProfileRegion object.
96 * @param height The height to set.
97 * @return Operation status.
98 */
99 GoFx(kStatus) GoProfileRegion_SetHeight(GoProfileRegion region, k64f height);
100
101 /**
102 * Gets the height.
103 *
104 * @public @memberof GoProfileRegion
105 * @version Introduced in firmware 4.0.10.27
106 * @param region GoProfileRegion object.
107 * @return The height of the region.
108 */
109 GoFx(k64f) GoProfileRegion_Height(GoProfileRegion region);
110
111 /**
112 * @class GoProfileFeature
113 * @extends kObject
114 * @ingroup GoSdk-ProfileTools
115 * @brief Represents a profile feature used in various profile tools.
116 */
117 typedef kObject GoProfileFeature;
118
119 /**
120 * Sets the feature type.
121 *
122 * @public @memberof GoProfileFeature
123 * @version Introduced in firmware 4.0.10.27
124 * @param feature GoProfileFeature object.
125 * @param type GoProfileFeatureType object.
126 * @return Operation status.
127 */
128 GoFx(kStatus) GoProfileFeature_SetType(GoProfileFeature feature, GoProfileFeatureType type);
129
130 /**
131 * Gets the profile feature type.
132 *
133 * @public @memberof GoProfileFeature
134 * @version Introduced in firmware 4.0.10.27
135 * @param feature GoProfileFeature object.
136 * @return The feature type.
137 */
138 GoFx(GoProfileFeatureType) GoProfileFeature_Type(GoProfileFeature feature);
139
140 /**
141 * Gets the profile feature region.
142 *
143 * @public @memberof GoProfileFeature
144 * @version Introduced in firmware 4.0.10.27
145 * @param feature GoProfileFeature object.
146 * @return A GoProfileRegion object.
147 */
148 GoFx(GoProfileRegion) GoProfileFeature_Region(GoProfileFeature feature);
149
150
151 /**
152 * @class GoProfileLine
153 * @extends kObject
154 * @ingroup GoSdk-ProfileTools
155 * @brief Represents a profile line region used in various profile tools.
156 */
157 typedef kObject GoProfileLineRegion;
158
159 /**
160 * Returns the number of regions.
161 *
162 * @public @memberof GoProfileLine
163 * @version Introduced in firmware 4.0.10.27
164 * @param lineRegion GoProfileLineRegion object.
165 * @return The region count.
166 */
167 GoFx(k32u) GoProfileLineRegion_RegionCount(GoProfileLineRegion lineRegion);
168
169 /**
170 * Gets the profile region based on the given index.
171 *
172 * @public @memberof GoProfileLine
173 * @version Introduced in firmware 4.0.10.27
174 * @param lineRegion GoProfileLineRegion object.
175 * @param index The index of the profile region to return.
176 * @return The profile region.
177 * @see GoProfileLineRegion_RegionCount
178 */
179 GoFx(GoProfileRegion) GoProfileLineRegion_RegionAt(GoProfileLineRegion lineRegion, kSize index);
180
181
182 /**
183 * @class GoProfileEdge
184 * @extends kObject
185 * @ingroup GoSdk-ProfileTools
186 * @brief Represents a profile edge used in various profile tools.
187 */
188 typedef kObject GoProfileEdge;
189
190 /**
191 * Sets the profile edge type.
192 *
193 * @public @memberof GoProfileEdge
194 * @version Introduced in firmware 4.0.10.27
195 * @param edge GoProfileEdge object.
196 * @param type The type of the profile edge.
197 * @return Operation status.
198 */
199 GoFx(kStatus) GoProfileEdge_SetType(GoProfileEdge edge, GoProfileEdgeType type);
200
201 /**
202 * Gets the profile edge type.
203 *
204 * @public @memberof GoProfileEdge
205 * @version Introduced in firmware 4.0.10.27
206 * @param edge GoProfileEdge object.
207 * @return The profile edge type.
208 */
209 GoFx(GoProfileEdgeType) GoProfileEdge_Type(GoProfileEdge edge);
210
211 /**
212 * Gets the profile region.
213 *
214 * @public @memberof GoProfileEdge
215 * @version Introduced in firmware 4.0.10.27
216 * @param edge GoProfileEdge object.
217 * @return The profile region.
218 */
219 GoFx(GoProfileRegion) GoProfileEdge_Region(GoProfileEdge edge);
220
221 /**
222 * Sets the maximum void width.
223 *
224 * @public @memberof GoProfileEdge
225 * @version Introduced in firmware 4.0.10.27
226 * @param edge GoProfileEdge object.
227 * @param width The width to set for the maximum void width.
228 * @return Operation status.
229 */
230 GoFx(kStatus) GoProfileEdge_SetVoidWidthMax(GoProfileEdge edge, k64f width);
231
232 /**
233 * Gets the maximum void width.
234 *
235 * @public @memberof GoProfileEdge
236 * @version Introduced in firmware 4.0.10.27
237 * @param edge GoProfileEdge object.
238 * @return Maximum void width.
239 */
240 GoFx(k64f) GoProfileEdge_VoidWidthMax(GoProfileEdge edge);
241
242 /**
243 * Sets the minimum depth.
244 *
245 * @public @memberof GoProfileEdge
246 * @version Introduced in firmware 4.0.10.27
247 * @param edge GoProfileEdge object.
248 * @param depth The minimum depth.
249 * @return Operation status.
250 */
251 GoFx(kStatus) GoProfileEdge_SetDepthMin(GoProfileEdge edge, k64f depth);
252
253 /**
254 * Gets the minimum depth.
255 *
256 * @public @memberof GoProfileEdge
257 * @version Introduced in firmware 4.0.10.27
258 * @param edge GoProfileEdge object.
259 * @return The minimum depth.
260 */
261 GoFx(k64f) GoProfileEdge_DepthMin(GoProfileEdge edge);
262
263 /**
264 * Sets the surface width.
265 *
266 * @public @memberof GoProfileEdge
267 * @version Introduced in firmware 4.0.10.27
268 * @param edge GoProfileEdge object.
269 * @param width The surface width.
270 * @return Operation status.
271 */
272 GoFx(kStatus) GoProfileEdge_SetSurfaceWidth(GoProfileEdge edge, k64f width);
273
274 /**
275 * Gets the surface width.
276 *
277 * @public @memberof GoProfileEdge
278 * @version Introduced in firmware 4.0.10.27
279 * @param edge GoProfileEdge object.
280 * @return The surface width.
281 */
282 GoFx(k64f) GoProfileEdge_SurfaceWidth(GoProfileEdge edge);
283
284 /**
285 * Sets the surface offset.
286 *
287 * @public @memberof GoProfileEdge
288 * @version Introduced in firmware 4.0.10.27
289 * @param edge GoProfileEdge object.
290 * @param offset The surface offset.
291 * @return Operation status.
292 */
293 GoFx(kStatus) GoProfileEdge_SetSurfaceOffset(GoProfileEdge edge, k64f offset);
294
295 /**
296 * Gets the surface offset.
297 *
298 * @public @memberof GoProfileEdge
299 * @version Introduced in firmware 4.0.10.27
300 * @param edge GoProfileEdge object.
301 * @return The surface offset.
302 */
303 GoFx(k64f) GoProfileEdge_SurfaceOffset(GoProfileEdge edge);
304
305 /**
306 * Sets the nominal radius.
307 *
308 * @public @memberof GoProfileEdge
309 * @version Introduced in firmware 4.0.10.27
310 * @param edge GoProfileEdge object.
311 * @param radius The nominal radius.
312 * @return Operation status.
313 */
314 GoFx(kStatus) GoProfileEdge_SetNominalRadius(GoProfileEdge edge, k64f radius);
315
316 /**
317 * Gets the nominal radius.
318 *
319 * @public @memberof GoProfileEdge
320 * @version Introduced in firmware 4.0.10.27
321 * @param edge GoProfileEdge object.
322 * @return The nominal radius.
323 */
324 GoFx(k64f) GoProfileEdge_NominalRadius(GoProfileEdge edge);
325
326 /**
327 * Sets the edge angle.
328 *
329 * @public @memberof GoProfileEdge
330 * @version Introduced in firmware 4.0.10.27
331 * @param edge GoProfileEdge object.
332 * @param angle k64f object.
333 * @return Operation status.
334 */
335 GoFx(kStatus) GoProfileEdge_SetEdgeAngle(GoProfileEdge edge, k64f angle);
336
337 /**
338 * Gets the edge angle.
339 *
340 * @public @memberof GoProfileEdge
341 * @version Introduced in firmware 4.0.10.27
342 * @param edge GoProfileEdge object.
343 * @return The edge angle.
344 */
345 GoFx(k64f) GoProfileEdge_EdgeAngle(GoProfileEdge edge);
346
347
348 kEndHeader()
349 #include <GoSdk/Tools/GoProfileToolUtils.x.h>
350
351 #endif
352 /// @endcond
k32u
kSize
GoUtils.h
Contains various helper functions.
GoSdkDef.h
Essential SDK declarations.
kObject
kStatus
k64f