Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSurfaceToolUtils.h
Go to the documentation of this file.
1 /// @cond (Gocator_2x00 || Gocator_3x00)
2 /**
3 * @file GoSurfaceToolUtils.h
4 * @brief Declares all surface tools and their related classes.
5 *
6 * @internal
7 * Copyright (C) 2016 by LMI Technologies Inc.
8 * Licensed under the MIT License.
9 * Redistributed files must retain the above copyright notice.
10 */
11
12 #ifndef GO_SURFACE_TOOL_UTILS_H
13 #define GO_SURFACE_TOOL_UTILS_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/GoUtils.h>
17
18 kBeginHeader()
19
20 /**
21 * @class GoSurfaceRegion2d
22 * @extends kObject
23 * @ingroup GoSdk-SurfaceTools
24 * @brief Represents a two dimensional surface tool region.
25 */
26 typedef kObject GoSurfaceRegion2d;
27
28 /**
29 * Sets the X position.
30 *
31 * @public @memberof GoSurfaceRegion2d
32 * @version Introduced in firmware 4.0.10.27
33 * @param region GoSurfaceRegion2d object.
34 * @param x The X position to set.
35 * @return Operation status.
36 */
37 GoFx(kStatus) GoSurfaceRegion2d_SetX(GoSurfaceRegion2d region, k64f x);
38
39 /**
40 * Gets the X position.
41 *
42 * @public @memberof GoSurfaceRegion2d
43 * @version Introduced in firmware 4.0.10.27
44 * @param region GoSurfaceRegion2d object.
45 * @return The X position of the region.
46 */
47 GoFx(k64f) GoSurfaceRegion2d_X(GoSurfaceRegion2d region);
48
49 /**
50 * Sets the Y position.
51 *
52 * @public @memberof GoSurfaceRegion2d
53 * @version Introduced in firmware 4.0.10.27
54 * @param region GoSurfaceRegion2d object.
55 * @param value The Y position to set.
56 * @return Operation status.
57 */
58 GoFx(kStatus) GoSurfaceRegion2d_SetY(GoSurfaceRegion2d region, k64f value);
59
60 /**
61 * Gets the Y position.
62 *
63 * @public @memberof GoSurfaceRegion2d
64 * @version Introduced in firmware 4.0.10.27
65 * @param region GoSurfaceRegion2d object.
66 * @return The Y position of the region.
67 */
68 GoFx(k64f) GoSurfaceRegion2d_Y(GoSurfaceRegion2d region);
69
70 /**
71 * Sets the width.
72 *
73 * @public @memberof GoSurfaceRegion2d
74 * @version Introduced in firmware 4.0.10.27
75 * @param region GoSurfaceRegion2d object.
76 * @param width The width to set.
77 * @return Operation status.
78 */
79 GoFx(kStatus) GoSurfaceRegion2d_SetWidth(GoSurfaceRegion2d region, k64f width);
80
81 /**
82 * Gets the width.
83 *
84 * @public @memberof GoSurfaceRegion2d
85 * @version Introduced in firmware 4.0.10.27
86 * @param region GoSurfaceRegion2d object.
87 * @return The width of the region.
88 */
89 GoFx(k64f) GoSurfaceRegion2d_Width(GoSurfaceRegion2d region);
90
91 /**
92 * Sets the length.
93 *
94 * @public @memberof GoSurfaceRegion2d
95 * @version Introduced in firmware 4.0.10.27
96 * @param region GoSurfaceRegion2d object.
97 * @param length The length to set.
98 * @return Operation status.
99 */
100 GoFx(kStatus) GoSurfaceRegion2d_SetLength(GoSurfaceRegion2d region, k64f length);
101
102 /**
103 * Gets the length.
104 *
105 * @public @memberof GoSurfaceRegion2d
106 * @version Introduced in firmware 4.0.10.27
107 * @param region GoSurfaceRegion2d object.
108 * @return The length of the region.
109 */
110 GoFx(k64f) GoSurfaceRegion2d_Length(GoSurfaceRegion2d region);
111
112
113 /**
114 * @class GoRegion3d
115 * @extends kObject
116 * @ingroup GoSdk-SurfaceTools
117 * @brief Represents a three dimensional surface region.
118 */
119 typedef kObject GoRegion3d;
120
121 /**
122 * Sets the X position.
123 *
124 * @public @memberof GoRegion3d
125 * @version Introduced in firmware 4.0.10.27
126 * @param region GoRegion3d object.
127 * @param x The X position to set.
128 * @return Operation status.
129 */
130 GoFx(kStatus) GoRegion3d_SetX(GoRegion3d region, k64f x);
131
132 /**
133 * Gets the X position.
134 *
135 * @public @memberof GoRegion3d
136 * @version Introduced in firmware 4.0.10.27
137 * @param region GoRegion3d object.
138 * @return The X position of the region.
139 */
140 GoFx(k64f) GoRegion3d_X(GoRegion3d region);
141
142 /**
143 * Sets the Y position.
144 *
145 * @public @memberof GoRegion3d
146 * @version Introduced in firmware 4.0.10.27
147 * @param region GoRegion3d object.
148 * @param value The Y position to set.
149 * @return Operation status.
150 */
151 GoFx(kStatus) GoRegion3d_SetY(GoRegion3d region, k64f value);
152
153 /**
154 * Gets the Y position.
155 *
156 * @public @memberof GoRegion3d
157 * @version Introduced in firmware 4.0.10.27
158 * @param region GoRegion3d object.
159 * @return The Y position of the region.
160 */
161 GoFx(k64f) GoRegion3d_Y(GoRegion3d region);
162
163 /**
164 * Sets the Z-position.
165 *
166 * @public @memberof GoRegion3d
167 * @version Introduced in firmware 4.0.10.27
168 * @param region GoRegion3d object.
169 * @param z The Z-position to set.
170 * @return Operation status.
171 */
172 GoFx(kStatus) GoRegion3d_SetZ(GoRegion3d region, k64f z);
173
174 /**
175 * Gets the Z-position.
176 *
177 * @public @memberof GoRegion3d
178 * @version Introduced in firmware 4.0.10.27
179 * @param region GoRegion3d object.
180 * @return The Z-position of the region.
181 */
182 GoFx(k64f) GoRegion3d_Z(GoRegion3d region);
183
184 /**
185 * Sets the width.
186 *
187 * @public @memberof GoRegion3d
188 * @version Introduced in firmware 4.0.10.27
189 * @param region GoRegion3d object.
190 * @param width The width to set.
191 * @return Operation status.
192 */
193 GoFx(kStatus) GoRegion3d_SetWidth(GoRegion3d region, k64f width);
194
195 /**
196 * Gets the width.
197 *
198 * @public @memberof GoRegion3d
199 * @version Introduced in firmware 4.0.10.27
200 * @param region GoRegion3d object.
201 * @return The width of the region.
202 */
203 GoFx(k64f) GoRegion3d_Width(GoRegion3d region);
204
205 /**
206 * Sets the length.
207 *
208 * @public @memberof GoRegion3d
209 * @version Introduced in firmware 4.0.10.27
210 * @param region GoRegion3d object.
211 * @param length The length to set.
212 * @return Operation status.
213 */
214 GoFx(kStatus) GoRegion3d_SetLength(GoRegion3d region, k64f length);
215
216 /**
217 * Gets the length.
218 *
219 * @public @memberof GoRegion3d
220 * @version Introduced in firmware 4.0.10.27
221 * @param region GoRegion3d object.
222 * @return The length of the region.
223 */
224 GoFx(k64f) GoRegion3d_Length(GoRegion3d region);
225
226 /**
227 * Sets the height.
228 *
229 * @public @memberof GoRegion3d
230 * @version Introduced in firmware 4.0.10.27
231 * @param region GoRegion3d object.
232 * @param height The height to set.
233 * @return Operation status.
234 */
235 GoFx(kStatus) GoRegion3d_SetHeight(GoRegion3d region, k64f height);
236
237 /**
238 * Gets the height.
239 *
240 * @public @memberof GoRegion3d
241 * @version Introduced in firmware 4.0.10.27
242 * @param region GoRegion3d object.
243 * @return The height of the region.
244 */
245 GoFx(k64f) GoRegion3d_Height(GoRegion3d region);
246
247
248 /**
249 * @class GoCylinderRegion
250 * @extends kObject
251 * @ingroup GoSdk-SurfaceTools
252 * @brief Represents a cylinder region for select surface tools.
253 */
254 typedef kObject GoCylinderRegion;
255
256 /**
257 * Sets the X position.
258 *
259 * @public @memberof GoCylinderRegion
260 * @version Introduced in firmware 4.0.10.27
261 * @param region GoCylinderRegion object.
262 * @param x The X position to set.
263 * @return Operation status.
264 */
265 GoFx(kStatus) GoCylinderRegion_SetX(GoCylinderRegion region, k64f x);
266
267 /**
268 * Gets the X position.
269 *
270 * @public @memberof GoCylinderRegion
271 * @version Introduced in firmware 4.0.10.27
272 * @param region GoCylinderRegion object.
273 * @return The X position of the region.
274 */
275 GoFx(k64f) GoCylinderRegion_X(GoCylinderRegion region);
276
277 /**
278 * Sets the Y position.
279 *
280 * @public @memberof GoCylinderRegion
281 * @version Introduced in firmware 4.0.10.27
282 * @param region GoCylinderRegion object.
283 * @param value The Y position to set.
284 * @return Operation status.
285 */
286 GoFx(kStatus) GoCylinderRegion_SetY(GoCylinderRegion region, k64f value);
287
288 /**
289 * Gets the Y position.
290 *
291 * @public @memberof GoCylinderRegion
292 * @version Introduced in firmware 4.0.10.27
293 * @param region GoCylinderRegion object.
294 * @return The Y position of the region.
295 */
296 GoFx(k64f) GoCylinderRegion_Y(GoCylinderRegion region);
297
298 /**
299 * Sets the Z-position.
300 *
301 * @public @memberof GoCylinderRegion
302 * @version Introduced in firmware 4.0.10.27
303 * @param region GoCylinderRegion object.
304 * @param z The Z-position to set.
305 * @return Operation status.
306 */
307 GoFx(kStatus) GoCylinderRegion_SetZ(GoCylinderRegion region, k64f z);
308
309 /**
310 * Gets the Z-position.
311 *
312 * @public @memberof GoCylinderRegion
313 * @version Introduced in firmware 4.0.10.27
314 * @param region GoCylinderRegion object.
315 * @return The Z-position of the region.
316 */
317 GoFx(k64f) GoCylinderRegion_Z(GoCylinderRegion region);
318
319 /**
320 * Sets the radius.
321 *
322 * @public @memberof GoCylinderRegion
323 * @version Introduced in firmware 4.0.10.27
324 * @param region GoCylinderRegion object.
325 * @param value The radius to set.
326 * @return Operation status.
327 */
328 GoFx(kStatus) GoCylinderRegion_SetRadius(GoCylinderRegion region, k64f value);
329
330 /**
331 * Gets the radius.
332 *
333 * @public @memberof GoCylinderRegion
334 * @version Introduced in firmware 4.0.10.27
335 * @param region GoCylinderRegion object.
336 * @return The radius of the region.
337 */
338 GoFx(k64f) GoCylinderRegion_Radius(GoCylinderRegion region);
339
340 /**
341 * Sets the height.
342 *
343 * @public @memberof GoCylinderRegion
344 * @version Introduced in firmware 4.0.10.27
345 * @param region GoCylinderRegion object.
346 * @param value The height to set.
347 * @return Operation status.
348 */
349 GoFx(kStatus) GoCylinderRegion_SetHeight(GoCylinderRegion region, k64f value);
350
351 /**
352 * Gets the height.
353 *
354 * @public @memberof GoCylinderRegion
355 * @version Introduced in firmware 4.0.10.27
356 * @param region GoCylinderRegion object.
357 * @return The height of the region.
358 */
359 GoFx(k64f) GoCylinderRegion_Height(GoCylinderRegion region);
360
361
362 /**
363 * @class GoSurfaceFeature
364 * @extends kObject
365 * @ingroup GoSdk-SurfaceTools
366 * @brief Represents a surface feature for select surface tools.
367 */
368 typedef kObject GoSurfaceFeature;
369
370 /**
371 * Gets the surface feature type.
372 *
373 * @public @memberof GoSurfaceFeature
374 * @version Introduced in firmware 4.0.10.27
375 * @param feature GoSurfaceFeature object.
376 * @return The surface feature type.
377 */
378 GoFx(GoSurfaceFeatureType) GoSurfaceFeature_Type(GoSurfaceFeature feature);
379
380 /**
381 * Sets the surface feature type.
382 *
383 * @public @memberof GoSurfaceFeature
384 * @version Introduced in firmware 4.0.10.27
385 * @param feature GoSurfaceFeature object.
386 * @param type The feature type value to set.
387 * @return Operation status.
388 */
389 GoFx(kStatus) GoSurfaceFeature_SetType(GoSurfaceFeature feature, GoSurfaceFeatureType type);
390
391 /**
392 * Gets the current state the surface feature region.
393 *
394 * @public @memberof GoSurfaceFeature
395 * @version Introduced in firmware 4.0.10.27
396 * @param feature GoSurfaceFeature object.
397 * @return kTRUE if enabled and kFALSE if disabled.
398 */
399 GoFx(kBool) GoSurfaceFeature_RegionEnabled(GoSurfaceFeature feature);
400
401 /**
402 * Enable or disable the surface feature region.
403 *
404 * @public @memberof GoSurfaceFeature
405 * @version Introduced in firmware 4.0.10.27
406 * @param feature GoSurfaceFeature object.
407 * @param enable kTRUE to enable, or kFALSE to disable.
408 * @return Operation status.
409 */
410 GoFx(kStatus) GoSurfaceFeature_EnableRegion(GoSurfaceFeature feature, kBool enable);
411
412 /**
413 * Gets the 3d region for the feature.
414 *
415 * @public @memberof GoSurfaceFeature
416 * @version Introduced in firmware 4.0.10.27
417 * @param feature GoSurfaceFeature object.
418 * @return A GoRegion3d object.
419 */
420 GoFx(GoRegion3d) GoSurfaceFeature_Region(GoSurfaceFeature feature);
421
422
423 kEndHeader()
424 #include <GoSdk/Tools/GoSurfaceToolUtils.x.h>
425
426 #endif
427
428 /// @endcond
GoSurfaceRegion2d::GoSurfaceRegion2d_SetWidth
kStatus GoSurfaceRegion2d_SetWidth(GoSurfaceRegion2d region, k64f width)
Sets the width.
GoSurfaceRegion2d::GoSurfaceRegion2d_Length
k64f GoSurfaceRegion2d_Length(GoSurfaceRegion2d region)
Gets the length.
GoCylinderRegion::GoCylinderRegion_Y
k64f GoCylinderRegion_Y(GoCylinderRegion region)
Gets the Y position.
GoSurfaceFeatureType
Represents a surface feature type.
GoRegion3d::GoRegion3d_X
k64f GoRegion3d_X(GoRegion3d region)
Gets the X position.
GoRegion3d::GoRegion3d_SetHeight
kStatus GoRegion3d_SetHeight(GoRegion3d region, k64f height)
Sets the height.
GoRegion3d::GoRegion3d_SetLength
kStatus GoRegion3d_SetLength(GoRegion3d region, k64f length)
Sets the length.
GoCylinderRegion::GoCylinderRegion_Radius
k64f GoCylinderRegion_Radius(GoCylinderRegion region)
Gets the radius.
GoRegion3d::GoRegion3d_SetZ
kStatus GoRegion3d_SetZ(GoRegion3d region, k64f z)
Sets the Z-position.
GoSurfaceFeature::GoSurfaceFeature_Region
GoRegion3d GoSurfaceFeature_Region(GoSurfaceFeature feature)
Gets the 3d region for the feature.
GoCylinderRegion::GoCylinderRegion_X
k64f GoCylinderRegion_X(GoCylinderRegion region)
Gets the X position.
GoCylinderRegion::GoCylinderRegion_SetX
kStatus GoCylinderRegion_SetX(GoCylinderRegion region, k64f x)
Sets the X position.
GoCylinderRegion::GoCylinderRegion_Z
k64f GoCylinderRegion_Z(GoCylinderRegion region)
Gets the Z-position.
GoCylinderRegion::GoCylinderRegion_SetY
kStatus GoCylinderRegion_SetY(GoCylinderRegion region, k64f value)
Sets the Y position.
GoSurfaceFeature::GoSurfaceFeature_RegionEnabled
kBool GoSurfaceFeature_RegionEnabled(GoSurfaceFeature feature)
Gets the current state the surface feature region.
GoCylinderRegion
Represents a cylinder region for select surface tools.
GoUtils.h
Contains various helper functions.
GoRegion3d::GoRegion3d_Y
k64f GoRegion3d_Y(GoRegion3d region)
Gets the Y position.
GoSurfaceRegion2d::GoSurfaceRegion2d_Y
k64f GoSurfaceRegion2d_Y(GoSurfaceRegion2d region)
Gets the Y position.
GoCylinderRegion::GoCylinderRegion_SetZ
kStatus GoCylinderRegion_SetZ(GoCylinderRegion region, k64f z)
Sets the Z-position.
GoSurfaceRegion2d::GoSurfaceRegion2d_X
k64f GoSurfaceRegion2d_X(GoSurfaceRegion2d region)
Gets the X position.
GoSurfaceFeature::GoSurfaceFeature_Type
GoSurfaceFeatureType GoSurfaceFeature_Type(GoSurfaceFeature feature)
Gets the surface feature type.
GoSdkDef.h
Essential SDK declarations.
GoSurfaceRegion2d::GoSurfaceRegion2d_SetX
kStatus GoSurfaceRegion2d_SetX(GoSurfaceRegion2d region, k64f x)
Sets the X position.
GoCylinderRegion::GoCylinderRegion_Height
k64f GoCylinderRegion_Height(GoCylinderRegion region)
Gets the height.
GoSurfaceRegion2d
Represents a two dimensional surface tool region.
GoSurfaceRegion2d::GoSurfaceRegion2d_SetLength
kStatus GoSurfaceRegion2d_SetLength(GoSurfaceRegion2d region, k64f length)
Sets the length.
GoRegion3d::GoRegion3d_SetWidth
kStatus GoRegion3d_SetWidth(GoRegion3d region, k64f width)
Sets the width.
GoSurfaceRegion2d::GoSurfaceRegion2d_SetY
kStatus GoSurfaceRegion2d_SetY(GoSurfaceRegion2d region, k64f value)
Sets the Y position.
GoRegion3d
Represents a three dimensional surface region.
GoRegion3d::GoRegion3d_Z
k64f GoRegion3d_Z(GoRegion3d region)
Gets the Z-position.
GoRegion3d::GoRegion3d_SetX
kStatus GoRegion3d_SetX(GoRegion3d region, k64f x)
Sets the X position.
GoSurfaceFeature::GoSurfaceFeature_SetType
kStatus GoSurfaceFeature_SetType(GoSurfaceFeature feature, GoSurfaceFeatureType type)
Sets the surface feature type.
GoRegion3d::GoRegion3d_Width
k64f GoRegion3d_Width(GoRegion3d region)
Gets the width.
GoCylinderRegion::GoCylinderRegion_SetHeight
kStatus GoCylinderRegion_SetHeight(GoCylinderRegion region, k64f value)
Sets the height.
kObject
kStatus
GoRegion3d::GoRegion3d_Height
k64f GoRegion3d_Height(GoRegion3d region)
Gets the height.
GoSurfaceFeature::GoSurfaceFeature_EnableRegion
kStatus GoSurfaceFeature_EnableRegion(GoSurfaceFeature feature, kBool enable)
Enable or disable the surface feature region.
k64f
GoCylinderRegion::GoCylinderRegion_SetRadius
kStatus GoCylinderRegion_SetRadius(GoCylinderRegion region, k64f value)
Sets the radius.
kBool
GoSurfaceFeature
Represents a surface feature for select surface tools.
GoRegion3d::GoRegion3d_Length
k64f GoRegion3d_Length(GoRegion3d region)
Gets the length.
GoSurfaceRegion2d::GoSurfaceRegion2d_Width
k64f GoSurfaceRegion2d_Width(GoSurfaceRegion2d region)
Gets the width.
GoRegion3d::GoRegion3d_SetY
kStatus GoRegion3d_SetY(GoRegion3d region, k64f value)
Sets the Y position.