Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoMaterial.h
1 /// @cond (Gocator_1x00 || Gocator_2x00)
2
3 /**
4 * @file GoMaterial.h
5 * @brief Declares the GoMaterial class.
6 * @deprecated
7 * @internal
8 * Copyright (C) 2016 by LMI Technologies Inc.
9 * Licensed under the MIT License.
10 * Redistributed files must retain the above copyright notice.
11 */
12 #ifndef GO_MATERIAL_H
13 #define GO_MATERIAL_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/GoAdvanced.h>
17
18 kBeginHeader()
19
20 /**
21 * @deprecated
22 * @class GoMaterial
23 * @extends kObject
24 * @ingroup GoSdk
25 * @brief Represents configurable material acquisition settings.
26 */
27 typedef GoAdvanced GoMaterial;
28 /**
29 * @deprecated Sets the material acquisition type.
30 *
31 * @public @memberof GoMaterial
32 * @version Introduced in firmware 4.1.3.106
33 * @param material GoMaterial object.
34 * @param type The material type to set.
35 * @return Operation status.
36 */
37 GoFx(kStatus) GoMaterial_SetType(GoMaterial material, GoMaterialType type);
38
39 /**
40 * @deprecated Returns the user defined material acquisition type.
41 *
42 * @public @memberof GoMaterial
43 * @version Introduced in firmware 4.1.3.106
44 * @param material GoMaterial object.
45 * @return The material type.
46 */
47 GoFx(GoMaterialType) GoMaterial_Type(GoMaterial material);
48
49 /**
50 * @deprecated Returns a boolean relating to whether the user defined material acquisition type value will be used by the system.
51 *
52 * @public @memberof GoMaterial
53 * @version Introduced in firmware 4.1.3.106
54 * @param material GoMaterial object.
55 * @return kTRUE if the user defined material type will be used and kFALSE otherwise.
56 */
57 GoFx(kBool) GoMaterial_IsTypeUsed(GoMaterial material);
58
59 /**
60 * @deprecated Returns the material acquisition type to be used by the system.
61 *
62 * @public @memberof GoMaterial
63 * @version Introduced in firmware 4.1.3.106
64 * @param material GoMaterial object.
65 * @return The system value material type.
66 */
67 GoFx(GoMaterialType) GoMaterial_TypeSystemValue(GoMaterial material);
68
69 /**
70 * @deprecated Sets the spot threshold.
71 *
72 * @public @memberof GoMaterial
73 * @version Introduced in firmware 4.1.3.106
74 * @param material GoMaterial object.
75 * @param value Spot threshold.
76 * @return Operation status.
77 */
78 GoFx(kStatus) GoMaterial_SetSpotThreshold(GoMaterial material, k32u value);
79
80 /**
81 * @deprecated Returns the user defined spot threshold.
82 *
83 * @public @memberof GoMaterial
84 * @version Introduced in firmware 4.1.3.106
85 * @param material GoMaterial object.
86 * @return The spot threshold.
87 */
88 GoFx(k32u) GoMaterial_SpotThreshold(GoMaterial material);
89
90 /**
91 * @deprecated Returns the minimum spot threshold limit.
92 *
93 * @public @memberof GoMaterial
94 * @version Introduced in firmware 4.1.3.106
95 * @param material GoMaterial object.
96 * @return The minimum spot threshold.
97 */
98 GoFx(k32u) GoMaterial_SpotThresholdLimitMin(GoMaterial material);
99
100 /**
101 * @deprecated Returns the maximum spot threshold limit.
102 *
103 * @public @memberof GoMaterial
104 * @version Introduced in firmware 4.1.3.106
105 * @param material GoMaterial object.
106 * @return The maximum spot threshold.
107 */
108 GoFx(k32u) GoMaterial_SpotThresholdLimitMax(GoMaterial material);
109
110 /**
111 * @deprecated Returns a boolean value representing whether the user specified spot threshold value is used.
112 *
113 * @public @memberof GoMaterial
114 * @version Introduced in firmware 4.1.3.106
115 * @param material GoMaterial object.
116 * @return kTRUE if it is used and kFALSE otherwise.
117 */
118 GoFx(kBool) GoMaterial_IsSpotThresholdUsed(GoMaterial material);
119
120 /**
121 * @deprecated Returns the system spot threshold value.
122 *
123 * @public @memberof GoMaterial
124 * @version Introduced in firmware 4.1.3.106
125 * @param material GoMaterial object.
126 * @return The system spot threshold.
127 */
128 GoFx(k32u) GoMaterial_SpotThresholdSystemValue(GoMaterial material);
129
130 /**
131 * @deprecated Sets the maximum spot width.
132 *
133 * @public @memberof GoMaterial
134 * @version Introduced in firmware 4.1.3.106
135 * @param material GoMaterial object.
136 * @param value Maximum spot width.
137 * @return Operation status.
138 */
139 GoFx(kStatus) GoMaterial_SetSpotWidthMax(GoMaterial material, k32u value);
140
141 /**
142 * @deprecated Returns the user defined maximum spot width.
143 *
144 * @public @memberof GoMaterial
145 * @version Introduced in firmware 4.1.3.106
146 * @param material GoMaterial object.
147 * @return The maximum spot width.
148 */
149 GoFx(k32u) GoMaterial_SpotWidthMax(GoMaterial material);
150
151 /**
152 * @deprecated Returns the maximum spot width minimum limit.
153 *
154 * @public @memberof GoMaterial
155 * @version Introduced in firmware 4.1.3.106
156 * @param material GoMaterial object.
157 * @return The maximum spot width minimum limit.
158 */
159 GoFx(k32u) GoMaterial_SpotWidthMaxLimitMin(GoMaterial material);
160
161 /**
162 * @deprecated Returns the maximum spot width maximum limit.
163 *
164 * @public @memberof GoMaterial
165 * @version Introduced in firmware 4.1.3.106
166 * @param material GoMaterial object.
167 * @return The maximum spot width maximum limit.
168 */
169 GoFx(k32u) GoMaterial_SpotWidthMaxLimitMax(GoMaterial material);
170
171 /**
172 * @deprecated Returns a boolean relating to whether the user defined spot width max value will be used by the system.
173 *
174 * @public @memberof GoMaterial
175 * @version Introduced in firmware 4.1.3.106
176 * @param material GoMaterial object.
177 * @return kTRUE if the user value will be used and kFALSE otherwise.
178 */
179 GoFx(kBool) GoMaterial_IsSpotWidthMaxUsed(GoMaterial material);
180
181 /**
182 * @deprecated Returns the maximum spot width system value.
183 *
184 * @public @memberof GoMaterial
185 * @version Introduced in firmware 4.1.3.106
186 * @param material GoMaterial object.
187 * @return The maximum spot width system value.
188 */
189 GoFx(k32u) GoMaterial_SpotWidthMaxSystemValue(GoMaterial material);
190
191 /**
192 * @deprecated Returns the number of spot selection type options.
193 *
194 * @public @memberof GoMaterial
195 * @version Introduced in firmware 4.3.3.124
196 * @param material GoMaterial object.
197 * @return The spot selection type option count.
198 */
199 GoFx(kSize) GoMaterial_SpotSelectionTypeOptionCount(GoMaterial material);
200
201 /**
202 * @deprecated Returns the spot selection type option at the given index.
203 *
204 * @public @memberof GoMaterial
205 * @version Introduced in firmware 4.3.3.124
206 * @param material GoMaterial object.
207 * @param index The option list index to access.
208 * @return The spot selection type option at the given index.
209 */
210 GoFx(GoSpotSelectionType) GoMaterial_SpotSelectionTypeOptionAt(GoMaterial material, kSize index);
211
212 /**
213 * @deprecated Sets the spot selection type.
214 *
215 * @public @memberof GoMaterial
216 * @version Introduced in firmware 4.1.3.106
217 * @param material GoMaterial object.
218 * @param type Spot selection type.
219 * @return Operation status.
220 */
221 GoFx(kStatus) GoMaterial_SetSpotSelectionType(GoMaterial material, GoSpotSelectionType type);
222
223 /**
224 * @deprecated Returns the user defined spot selection type.
225 *
226 * @public @memberof GoMaterial
227 * @version Introduced in firmware 4.1.3.106
228 * @param material GoMaterial object.
229 * @return The maximum spot width.
230 */
231 GoFx(GoSpotSelectionType) GoMaterial_SpotSelectionType(GoMaterial material);
232
233 /**
234 * @deprecated Returns a boolean relating to whether the user defined spot selection type will be used by the system.
235 *
236 * @public @memberof GoMaterial
237 * @version Introduced in firmware 4.1.3.106
238 * @param material GoMaterial object.
239 * @return kTRUE if the user value will be used and kFALSE otherwise.
240 */
241 GoFx(kBool) GoMaterial_IsSpotSelectionTypeUsed(GoMaterial material);
242
243 /**
244 * @deprecated Returns the system spot selection type.
245 *
246 * @public @memberof GoMaterial
247 * @version Introduced in firmware 4.1.3.106
248 * @param material GoMaterial object.
249 * @return System spot selection type.
250 */
251 GoFx(GoSpotSelectionType) GoMaterial_SpotSelectionTypeSystemValue(GoMaterial material);
252
253 /**
254 * @deprecated Sets the analog camera gain.
255 *
256 * @public @memberof GoMaterial
257 * @version Introduced in firmware 4.1.3.106
258 * @param material GoMaterial object.
259 * @param value Analog camera gain.
260 * @return Operation status.
261 */
262 GoFx(kStatus) GoMaterial_SetCameraGainAnalog(GoMaterial material, k64f value);
263
264 /**
265 * @deprecated Returns the user defined analog camera gain value.
266 *
267 * @public @memberof GoMaterial
268 * @version Introduced in firmware 4.1.3.106
269 * @param material GoMaterial object.
270 * @return Analog camera gain value.
271 */
272 GoFx(k64f) GoMaterial_CameraGainAnalog(GoMaterial material);
273
274 /**
275 * @deprecated Returns the analog camera gain minimum value limit.
276 *
277 * @public @memberof GoMaterial
278 * @version Introduced in firmware 4.1.3.106
279 * @param material GoMaterial object.
280 * @return Analog camera gain minimum value limit.
281 */
282 GoFx(k64f) GoMaterial_CameraGainAnalogLimitMin(GoMaterial material);
283
284 /**
285 * @deprecated Returns the analog camera gain maximum value limit.
286 *
287 * @public @memberof GoMaterial
288 * @version Introduced in firmware 4.1.3.106
289 * @param material GoMaterial object.
290 * @return Analog camera gain maximum value limit.
291 */
292 GoFx(k64f) GoMaterial_CameraGainAnalogLimitMax(GoMaterial material);
293
294 /**
295 * @deprecated Returns a boolean value representing whether the user defined analog camera gain is used.
296 *
297 * @public @memberof GoMaterial
298 * @version Introduced in firmware 4.1.3.106
299 * @param material GoMaterial object.
300 * @return kTRUE if the user defined analog camera gain is used and kFALSE otherwise.
301 */
302 GoFx(kBool) GoMaterial_IsCameraGainAnalogUsed(GoMaterial material);
303
304 /**
305 * @deprecated Returns the analog camera gain system value.
306 *
307 * @public @memberof GoMaterial
308 * @version Introduced in firmware 4.1.3.106
309 * @param material GoMaterial object.
310 * @return The analog camera gain system value.
311 */
312 GoFx(k64f) GoMaterial_CameraGainAnalogSystemValue(GoMaterial material);
313
314 /**
315 * @deprecated Sets the digital camera gain
316 *
317 * @public @memberof GoMaterial
318 * @version Introduced in firmware 4.1.3.106
319 * @param material GoMaterial object.
320 * @param value Digital camera gain.
321 * @return Operation status.
322 */
323 GoFx(kStatus) GoMaterial_SetCameraGainDigital(GoMaterial material, k64f value);
324
325 /**
326 * @deprecated Returns the user defined digital camera gain value.
327 *
328 * @public @memberof GoMaterial
329 * @version Introduced in firmware 4.1.3.106
330 * @param material GoMaterial object.
331 * @return The digital camera gain system value.
332 */
333 GoFx(k64f) GoMaterial_CameraGainDigital(GoMaterial material);
334
335 /**
336 * @deprecated Returns the digital camera gain minimum value limit.
337 *
338 * @public @memberof GoMaterial
339 * @version Introduced in firmware 4.1.3.106
340 * @param material GoMaterial object.
341 * @return Digital camera gain minimum value limit.
342 */
343 GoFx(k64f) GoMaterial_CameraGainDigitalLimitMin(GoMaterial material);
344
345 /**
346 * @deprecated Returns the digital camera gain maximum value limit.
347 *
348 * @public @memberof GoMaterial
349 * @version Introduced in firmware 4.1.3.106
350 * @param material GoMaterial object.
351 * @return Digital camera gain maximum value limit.
352 */
353 GoFx(k64f) GoMaterial_CameraGainDigitalLimitMax(GoMaterial material);
354
355 /**
356 * @deprecated Returns a boolean value representing whether the user's digital camera gain value is used by the system.
357 *
358 * @public @memberof GoMaterial
359 * @version Introduced in firmware 4.1.3.106
360 * @param material GoMaterial object.
361 * @return kTRUE if used and kFALSE otherwise.
362 */
363 GoFx(kBool) GoMaterial_IsCameraGainDigitalUsed(GoMaterial material);
364
365 /**
366 * @deprecated Returns the system's digital camera gain value.
367 *
368 * @public @memberof GoMaterial
369 * @version Introduced in firmware 4.1.3.106
370 * @param material GoMaterial object.
371 * @return Digital camera gain system value.
372 */
373 GoFx(k64f) GoMaterial_CameraGainDigitalSystemValue(GoMaterial material);
374
375 /**
376 * @deprecated Sets the dynamic sensitivity.
377 *
378 * @public @memberof GoMaterial
379 * @version Introduced in firmware 4.1.3.106
380 * @param material GoMaterial object.
381 * @param value Dynamic sensitivity.
382 * @return Operation status.
383 */
384 GoFx(kStatus) GoMaterial_SetDynamicSensitivity(GoMaterial material, k64f value);
385
386 /**
387 * @deprecated Returns the user defined dynamic sensitivity value.
388 *
389 * @public @memberof GoMaterial
390 * @version Introduced in firmware 4.1.3.106
391 * @param material GoMaterial object.
392 * @return User defined dynamic sensitivity value.
393 */
394 GoFx(k64f) GoMaterial_DynamicSensitivity(GoMaterial material);
395
396 /**
397 * @deprecated Returns the dynamic sensitivity minimum value limit.
398 *
399 * @public @memberof GoMaterial
400 * @version Introduced in firmware 4.1.3.106
401 * @param material GoMaterial object.
402 * @return Dynamic sensitivity minimum value limit.
403 */
404 GoFx(k64f) GoMaterial_DynamicSensitivityLimitMin(GoMaterial material);
405
406 /**
407 * @deprecated Returns the dynamic sensitivity maximum value limit.
408 *
409 * @public @memberof GoMaterial
410 * @version Introduced in firmware 4.1.3.106
411 * @param material GoMaterial object.
412 * @return Dynamic sensitivity maximum value limit.
413 */
414 GoFx(k64f) GoMaterial_DynamicSensitivityLimitMax(GoMaterial material);
415
416 /**
417 * @deprecated Returns a boolean representing whether the user defined dynamic sensitivity value is used.
418 *
419 * @public @memberof GoMaterial
420 * @version Introduced in firmware 4.1.3.106
421 * @param material GoMaterial object.
422 * @return kTRUE if used and kFALSE otherwise.
423 */
424 GoFx(kBool) GoMaterial_IsDynamicSensitivityUsed(GoMaterial material);
425
426 /**
427 * @deprecated Returns the dynamic sensitivity system value.
428 *
429 * @public @memberof GoMaterial
430 * @version Introduced in firmware 4.1.3.106
431 * @param material GoMaterial object.
432 * @return Dynamic sensitivity system value.
433 */
434 GoFx(k64f) GoMaterial_DynamicSensitivitySystemValue(GoMaterial material);
435
436 /**
437 * @deprecated Sets the dynamic threshold.
438 *
439 * @public @memberof GoMaterial
440 * @version Introduced in firmware 4.1.3.106
441 * @param material GoMaterial object.
442 * @param value Dynamic threshold.
443 * @return Operation status.
444 */
445 GoFx(kStatus) GoMaterial_SetDynamicThreshold(GoMaterial material, k32u value);
446
447 /**
448 * @deprecated Returns the dynamic threshold minimum value limit.
449 *
450 * @public @memberof GoMaterial
451 * @version Introduced in firmware 4.1.3.106
452 * @param material GoMaterial object.
453 * @return Dynamic threshold minimum value limit.
454 */
455 GoFx(k32u) GoMaterial_DynamicThresholdLimitMin(GoMaterial material);
456
457 /**
458 * @deprecated Returns the dynamic threshold maximum value limit.
459 *
460 * @public @memberof GoMaterial
461 * @version Introduced in firmware 4.1.3.106
462 * @param material GoMaterial object.
463 * @return Dynamic threshold maximum value limit.
464 */
465 GoFx(k32u) GoMaterial_DynamicThresholdLimitMax(GoMaterial material);
466
467 /**
468 * @deprecated Returns the user defined dynamic threshold value.
469 *
470 * @public @memberof GoMaterial
471 * @version Introduced in firmware 4.1.3.106
472 * @param material GoMaterial object.
473 * @return The user defined dynamic threshold value.
474 */
475 GoFx(k32u) GoMaterial_DynamicThreshold(GoMaterial material);
476
477 /**
478 * @deprecated Returns a boolean representing whether or not the user defined dynamic threshold is used by the system.
479 *
480 * @public @memberof GoMaterial
481 * @version Introduced in firmware 4.1.3.106
482 * @param material GoMaterial object.
483 * @return Dynamic threshold minimum value limit.
484 */
485 GoFx(kBool) GoMaterial_IsDynamicThresholdUsed(GoMaterial material);
486
487 /**
488 * @deprecated Returns the dynamic threshold system value.
489 *
490 * @public @memberof GoMaterial
491 * @version Introduced in firmware 4.1.3.106
492 * @param material GoMaterial object.
493 * @return Dynamic threshold system value.
494 */
495 GoFx(k32u) GoMaterial_DynamicThresholdSystemValue(GoMaterial material);
496
497 /**
498 * @deprecated Sets the gamma type.
499 *
500 * @public @memberof GoMaterial
501 * @version Introduced in firmware 4.1.3.106
502 * @param material GoMaterial object.
503 * @param value Gamma type.
504 * @return Operation status.
505 */
506 GoFx(kStatus) GoMaterial_SetGammaType(GoMaterial material, GoGammaType value);
507
508 /**
509 * @deprecated Returns the user defined gamma type.
510 *
511 * @public @memberof GoMaterial
512 * @version Introduced in firmware 4.1.3.106
513 * @param material GoMaterial object.
514 * @return User defined gamma type.
515 */
516 GoFx(GoGammaType) GoMaterial_GammaType(GoMaterial material);
517
518 /**
519 * @deprecated Returns a boolean representing whether the user defined gamma type is used by the system.
520 *
521 * @public @memberof GoMaterial
522 * @version Introduced in firmware 4.1.3.106
523 * @param material GoMaterial object.
524 * @return kTRUE if used and kFALSE otherwise.
525 */
526 GoFx(kBool) GoMaterial_IsGammaTypeUsed(GoMaterial material);
527
528 /**
529 * @deprecated Returns the system's gamma type value.
530 *
531 * @public @memberof GoMaterial
532 * @version Introduced in firmware 4.1.3.106
533 * @param material GoMaterial object.
534 * @return The system gamma type value.
535 */
536 GoFx(GoGammaType) GoMaterial_GammaTypeSystemValue(GoMaterial material);
537
538 /**
539 * Enables or disables senstivity compensation. NOTE: This is only applicable to
540 * 2300 B series sensors.
541 *
542 * @public @memberof GoMaterial
543 * @version Introduced in firmware 4.3.3.124
544 * @param material GoMaterial object.
545 * @param value kTRUE to enable and kFALSE to disable.
546 * @return Operation status.
547 */
548 GoFx(kStatus) GoMaterial_EnableSensitivityCompensation(GoMaterial material, kBool value);
549
550 /**
551 * @deprecated Returns the user defined sensitivity compensation value.
552 *
553 * @public @memberof GoMaterial
554 * @version Introduced in firmware 4.3.3.124
555 * @param material GoMaterial object.
556 * @return User defined sensitivity compensation.
557 */
558 GoFx(kBool) GoMaterial_SensitivityCompensationEnabled(GoMaterial material);
559
560 /**
561 * @deprecated Returns a boolean representing whether the user defined sensitivity compensation is used by the system.
562 *
563 * @public @memberof GoMaterial
564 * @version Introduced in firmware 4.3.3.124
565 * @param material GoMaterial object.
566 * @return kTRUE if used and kFALSE otherwise.
567 */
568 GoFx(kBool) GoMaterial_IsSensitivityCompensationEnabledUsed(GoMaterial material);
569
570 /**
571 * @deprecated Returns the system's sensitivity compensation value.
572 *
573 * @public @memberof GoMaterial
574 * @version Introduced in firmware 4.3.3.124
575 * @param material GoMaterial object.
576 * @return kTRUE if enabled and kFALSE otherwise.
577 */
578 GoFx(kBool) GoMaterial_SensitivityCompensationEnabledSystemValue(GoMaterial material);
579
580
581 kEndHeader()
582
583 #endif
584
585 /// @endcond
k32u
kSize
GoSdkDef.h
Essential SDK declarations.
GoGammaType
Represents an advanced gamma type.
kStatus
k64f
kBool