Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoPartModel.h
Go to the documentation of this file.
1 /**
2 * @file GoPartModel.h
3 * @brief Declares the GoPartModel and GoPartModelEdge class.
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_PART_MODEL_H
11 #define GO_PART_MODEL_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 /**
16 * @class GoPartModelEdge
17 * @extends kObject
18 * @note Supported with G2, G3
19 * @ingroup GoSdk-Surface
20 * @brief Represents a part model edge configuration.
21 */
22 typedef kObject GoPartModelEdge;
23
24 /**
25 * Returns the edge model image type used at the time of model creation.
26 *
27 * @public @memberof GoPartModelEdge
28 * @note Supported with G2, G3
29 * @version Introduced in firmware 4.2.4.7
30 * @param edge GoPartModelEdge object.
31 * @return Edge model image type.
32 */
33 GoFx(GoImageType) GoPartModelEdge_ImageType(GoPartModelEdge edge);
34
35 /**
36 * Returns the edge model image data source used at the time of model creation.
37 *
38 * @public @memberof GoPartModelEdge
39 * @note Supported with G2, G3
40 * @version Introduced in firmware 4.2.4.7
41 * @param edge GoPartModelEdge object.
42 * @return Edge model image data source.
43 */
44 GoFx(GoDataSource) GoPartModelEdge_ImageSource(GoPartModelEdge edge);
45
46 /**
47 * Returns the count of removed edge model points.
48 *
49 * @public @memberof GoPartModelEdge
50 * @note Supported with G2, G3
51 * @version Introduced in firmware 4.2.4.7
52 * @param edge GoPartModelEdge object.
53 * @return The number of removed edge model points.
54 */
55 GoFx(kSize) GoPartModelEdge_RemovedPointsLength(GoPartModelEdge edge);
56
57 /**
58 * @class GoPartModel
59 * @extends kObject
60 * @note Supported with G2, G3
61 * @ingroup GoSdk-Surface
62 * @brief Represents a part model configuration.
63 */
64 typedef kObject GoPartModel;
65
66
67 /**
68 * Returns the name of the part model.
69 *
70 * @public @memberof GoPartModel
71 * @note Supported with G2, G3
72 * @version Introduced in firmware 4.2.4.7
73 * @param model GoPartModel object.
74 * @return The name of the given part model.
75 */
76 GoFx(const kChar*) GoPartModel_Name(GoPartModel model);
77
78 /**
79 * Returns the number of edges for the given part model.
80 *
81 * @public @memberof GoPartModel
82 * @note Supported with G2, G3
83 * @version Introduced in firmware 4.2.4.7
84 * @param model GoPartModel object.
85 * @return The number of edges which make up the part model.
86 */
87 GoFx(kSize) GoPartModel_EdgeCount(GoPartModel model);
88
89 /**
90 * Returns the edge for the given index.
91 *
92 * @public @memberof GoPartModel
93 * @note Supported with G2, G3
94 * @version Introduced in firmware 4.2.4.7
95 * @param model GoPartModel object.
96 * @param index The index of the part model edge list to access.
97 * @return The edge at the given index.
98 */
99 GoFx(GoPartModelEdge) GoPartModel_EdgeAt(GoPartModel model, kSize index);
100
101 /**
102 * Returns the edge sensitivity used at the time of model creation.
103 *
104 * @public @memberof GoPartModel
105 * @note Supported with G2, G3
106 * @version Introduced in firmware 4.2.4.7
107 * @param partModel GoPartModel object.
108 * @return The edge sensitivity used at the time of model creation.
109 */
110 GoFx(k64f) GoPartModel_EdgeSensitivity(GoPartModel partModel);
111
112 /**
113 * Returns the transformed data region X-component value.
114 *
115 * @public @memberof GoPartModel
116 * @note Supported with G2, G3
117 * @version Introduced in firmware 4.2.4.7
118 * @param partModel GoPartModel object.
119 * @return Transformed data region value.
120 */
121 GoFx(k64f) GoPartModel_TransformedDataRegionX(GoPartModel partModel);
122
123 /**
124 * Returns the transformed data region Y-component value.
125 *
126 * @public @memberof GoPartModel
127 * @note Supported with G2, G3
128 * @version Introduced in firmware 4.2.4.7
129 * @param partModel GoPartModel object.
130 * @return Transformed data region value.
131 */
132 GoFx(k64f) GoPartModel_TransformedDataRegionY(GoPartModel partModel);
133
134 /**
135 * Returns the transformed data region Z-component value.
136 *
137 * @public @memberof GoPartModel
138 * @note Supported with G2, G3
139 * @version Introduced in firmware 4.2.4.7
140 * @param partModel GoPartModel object.
141 * @return Transformed data region value.
142 */
143 GoFx(k64f) GoPartModel_TransformedDataRegionZ(GoPartModel partModel);
144
145 /**
146 * Returns the transformed data region width value.
147 *
148 * @public @memberof GoPartModel
149 * @note Supported with G2, G3
150 * @version Introduced in firmware 4.2.4.7
151 * @param partModel GoPartModel object.
152 * @return Transformed data region value.
153 */
154 GoFx(k64f) GoPartModel_TransformedDataRegionWidth(GoPartModel partModel);
155
156 /**
157 * Returns the transformed data region length value.
158 *
159 * @public @memberof GoPartModel
160 * @note Supported with G2, G3
161 * @version Introduced in firmware 4.2.4.7
162 * @param partModel GoPartModel object.
163 * @return Transformed data region value.
164 */
165 GoFx(k64f) GoPartModel_TransformedDataRegionLength(GoPartModel partModel);
166
167 /**
168 * Returns the transformed data region height value.
169 *
170 * @public @memberof GoPartModel
171 * @note Supported with G2, G3
172 * @version Introduced in firmware 4.2.4.7
173 * @param partModel GoPartModel object.
174 * @return Transformed data region value.
175 */
176 GoFx(k64f) GoPartModel_TransformedDataRegionHeight(GoPartModel partModel); //readonly
177
178 /**
179 * Returns the current Z angle of the given part model.
180 *
181 * @public @memberof GoPartModel
182 * @note Supported with G2, G3
183 * @version Introduced in firmware 4.2.4.7
184 * @param partModel GoPartModel object.
185 * @return Z angle value.
186 */
187 GoFx(k64f) GoPartModel_ZAngle(GoPartModel partModel);
188
189 /**
190 * Sets the Z angle for the given part model.
191 *
192 * @public @memberof GoPartModel
193 * @note Supported with G2, G3
194 * @version Introduced in firmware 4.2.4.7
195 * @param partModel GoPartModel object.
196 * @param value The value to set.
197 * @return Operation status.
198 */
199 GoFx(kStatus) GoPartModel_SetZAngle(GoPartModel partModel, k64f value);
200
201
202 /**
203 * Returns the image type for the given part model.
204 *
205 * @public @memberof GoPartModel
206 * @note Supported with G2, G3
207 * @version Introduced in firmware 4.2.4.7
208 * @param partModel GoPartModel object.
209 * @return The image type.
210 */
211 GoFx(GoImageType) GoPartModel_ImageType(GoPartModel partModel);
212
213 /**
214 * Sets the image type for the given part model.
215 *
216 * @public @memberof GoPartModel
217 * @note Supported with G2, G3
218 * @version Introduced in firmware 4.2.4.7
219 * @param partModel GoPartModel object.
220 * @param value The image type to set.
221 * @return Operation status.
222 */
223 GoFx(kStatus) GoPartModel_SetImageType(GoPartModel partModel, GoImageType value);
224
225 /**
226 * Returns the image type option count.
227 *
228 * @public @memberof GoPartModel
229 * @note Supported with G2, G3
230 * @version Introduced in firmware 4.2.4.7
231 * @param partModel GoPartModel object.
232 * @return The image type option count.
233 */
234 GoFx(kSize) GoPartModel_ImageTypeOptionCount(GoPartModel partModel);
235
236 /**
237 * Returns the image type option at the given index.
238 *
239 * @public @memberof GoPartModel
240 * @note Supported with G2, G3
241 * @version Introduced in firmware 4.2.4.7
242 * @param partModel GoPartModel object.
243 * @param index The image type option index to access.
244 * @return The image type option.
245 */
246 GoFx(GoImageType) GoPartModel_ImageTypeOptionAt(GoPartModel partModel, kSize index);
247
248 /**
249 * Returns the target edge sensitivity.
250 *
251 * @public @memberof GoPartModel
252 * @note Supported with G2, G3
253 * @version Introduced in firmware 4.2.4.7
254 * @param partModel GoPartModel object.
255 * @return The target edge sensitivity.
256 */
257 GoFx(k64f) GoPartModel_TargetEdgeSensitivity(GoPartModel partModel);
258
259 /**
260 * Sets the target edge sensitivity for the given part model.
261 *
262 * @public @memberof GoPartModel
263 * @note Supported with G2, G3
264 * @version Introduced in firmware 4.2.4.7
265 * @param partModel GoPartModel object.
266 * @param value The value to set.
267 * @return Operation status.
268 */
269 GoFx(kStatus) GoPartModel_SetTargetEdgeSensitivity(GoPartModel partModel, k64f value);
270
271 #include <GoSdk/GoPartModel.x.h>
272
273 #endif
GoPartModel::GoPartModel_ImageType
GoImageType GoPartModel_ImageType(GoPartModel partModel)
Returns the image type for the given part model.
GoPartModel::GoPartModel_EdgeAt
GoPartModelEdge GoPartModel_EdgeAt(GoPartModel model, kSize index)
Returns the edge for the given index.
GoPartModel::GoPartModel_ImageTypeOptionAt
GoImageType GoPartModel_ImageTypeOptionAt(GoPartModel partModel, kSize index)
Returns the image type option at the given index.
GoPartModel
Represents a part model configuration.
GoPartModelEdge::GoPartModelEdge_ImageType
GoImageType GoPartModelEdge_ImageType(GoPartModelEdge edge)
Returns the edge model image type used at the time of model creation.
GoPartModel::GoPartModel_SetZAngle
kStatus GoPartModel_SetZAngle(GoPartModel partModel, k64f value)
Sets the Z angle for the given part model.
GoPartModelEdge::GoPartModelEdge_RemovedPointsLength
kSize GoPartModelEdge_RemovedPointsLength(GoPartModelEdge edge)
Returns the count of removed edge model points.
kSize
GoDataSource
Represents a data source.
GoPartModel::GoPartModel_TransformedDataRegionWidth
k64f GoPartModel_TransformedDataRegionWidth(GoPartModel partModel)
Returns the transformed data region width value.
GoPartModel::GoPartModel_EdgeCount
kSize GoPartModel_EdgeCount(GoPartModel model)
Returns the number of edges for the given part model.
kChar
GoPartModel::GoPartModel_TransformedDataRegionY
k64f GoPartModel_TransformedDataRegionY(GoPartModel partModel)
Returns the transformed data region Y-component value.
GoPartModel::GoPartModel_EdgeSensitivity
k64f GoPartModel_EdgeSensitivity(GoPartModel partModel)
Returns the edge sensitivity used at the time of model creation.
GoSdkDef.h
Essential SDK declarations.
GoImageType
Represents an image type.
GoPartModel::GoPartModel_TransformedDataRegionLength
k64f GoPartModel_TransformedDataRegionLength(GoPartModel partModel)
Returns the transformed data region length value.
GoPartModelEdge::GoPartModelEdge_ImageSource
GoDataSource GoPartModelEdge_ImageSource(GoPartModelEdge edge)
Returns the edge model image data source used at the time of model creation.
GoPartModel::GoPartModel_TransformedDataRegionX
k64f GoPartModel_TransformedDataRegionX(GoPartModel partModel)
Returns the transformed data region X-component value.
GoPartModel::GoPartModel_ZAngle
k64f GoPartModel_ZAngle(GoPartModel partModel)
Returns the current Z angle of the given part model.
GoPartModel::GoPartModel_TransformedDataRegionZ
k64f GoPartModel_TransformedDataRegionZ(GoPartModel partModel)
Returns the transformed data region Z-component value.
GoPartModel::GoPartModel_TargetEdgeSensitivity
k64f GoPartModel_TargetEdgeSensitivity(GoPartModel partModel)
Returns the target edge sensitivity.
GoPartModel::GoPartModel_SetTargetEdgeSensitivity
kStatus GoPartModel_SetTargetEdgeSensitivity(GoPartModel partModel, k64f value)
Sets the target edge sensitivity for the given part model.
kObject
kStatus
GoPartModel::GoPartModel_SetImageType
kStatus GoPartModel_SetImageType(GoPartModel partModel, GoImageType value)
Sets the image type for the given part model.
k64f
GoPartModel::GoPartModel_Name
const kChar * GoPartModel_Name(GoPartModel model)
Returns the name of the part model.
GoPartModel::GoPartModel_TransformedDataRegionHeight
k64f GoPartModel_TransformedDataRegionHeight(GoPartModel partModel)
Returns the transformed data region height value.
GoPartModel::GoPartModel_ImageTypeOptionCount
kSize GoPartModel_ImageTypeOptionCount(GoPartModel partModel)
Returns the image type option count.
GoPartModelEdge
Represents a part model edge configuration.