Gocator API

GoSections.h
1 /// @cond (Gocator_2x00 || Gocator_3x00)
2
3 /**
4 * @file GoSections.h
5 * @brief Declares the GoSections 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_SECTIONS_H
13 #define GO_SECTIONS_H
14
15 #include <GoSdk/GoSdkDef.h>
16 #include <GoSdk/GoSection.h>
17
18 kBeginHeader()
19
20 /**
21 * @class GoSections
22 * @extends kObject
23 * @ingroup GoSdk-Surface
24 * @brief Represents the collection of sections and limits for defining them.
25 */
26 typedef kObject GoSections;
27
28 /**
29 * Gets the X axis minimum for section definition.
30 *
31 * @public @memberof GoSection
32 * @version Introduced in firmware 4.4.4.14
33 * @param sections GoSections object.
34 * @return The minimum X value.
35 */
36 GoFx(k64f) GoSections_XLimitMin(GoSections sections);
37
38 /**
39 * Gets the X axis maximum for section definition.
40 *
41 * @public @memberof GoSection
42 * @version Introduced in firmware 4.4.4.14
43 * @param sections GoSections object.
44 * @return The maximum X value.
45 */
46 GoFx(k64f) GoSections_XLimitMax(GoSections sections);
47
48 /**
49 * Gets the Y axis minimum for section definition.
50 *
51 * @public @memberof GoSection
52 * @version Introduced in firmware 4.4.4.14
53 * @param sections GoSections object.
54 * @return The minimum Y value.
55 */
56 GoFx(k64f) GoSections_YLimitMin(GoSections sections);
57
58 /**
59 * Gets the Y axis maximum for section definition.
60 *
61 * @public @memberof GoSection
62 * @version Introduced in firmware 4.4.4.14
63 * @param sections GoSections object.
64 * @return The maximum Y value.
65 */
66 GoFx(k64f) GoSections_YLimitMax(GoSections sections);
67
68 /**
69 * Returns the number of added sections.
70 *
71 * @public @memberof GoSection
72 * @version Introduced in firmware 4.4.4.14
73 * @param sections GoSections object.
74 * @return The section count.
75 */
76 GoFx(kSize) GoSections_SectionCount(GoSections sections);
77
78 /**
79 * Retrieves the section at the specified index.
80 *
81 * @public @memberof GoSection
82 * @version Introduced in firmware 4.4.4.14
83 * @param sections GoSections object.
84 * @param index The index of the section to retrieve.
85 * @return A section.
86 * @see GoSections_SectionCount
87 */
88 GoFx(GoSection) GoSections_SectionAt(GoSections sections, kSize index);
89
90 /**
91 * Adds a specified section to the configuration.
92 *
93 * @public @memberof GoSection
94 * @version Introduced in firmware 4.4.4.14
95 * @param sections GoSections object.
96 * @param section The GoSection reference to add.
97 * @return Operation status.
98 */
99 GoFx(kStatus) GoSections_AddSection(GoSections sections, GoSection* section);
100
101 /**
102 * Removes the section at the specified index.
103 *
104 * @public @memberof GoSection
105 * @version Introduced in firmware 4.4.4.14
106 * @param sections GoSections object.
107 * @param index The index of the section to remove.
108 * @return Operation status.
109 */
110 GoFx(kStatus) GoSections_RemoveSection(GoSections sections, kSize index);
111
112 /**
113 * Clears the section list.
114 *
115 * @public @memberof GoSection
116 * @version Introduced in firmware 4.4.4.14
117 * @param sections GoSections object.
118 * @return Operation status.
119 */
120 GoFx(kStatus) GoSections_Clear(GoSections sections);
121
122 kEndHeader()
123 #include <GoSdk/GoSections.x.h>
124
125 #endif
126
127 /// @endcond
kSize
GoSdkDef.h
Essential SDK declarations.
GoSection.h
Declares the GoSection class.
kObject
kStatus
k64f
GoSection
Represents sections to be applied on surface data.