Gocator API

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