Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkParamPointSetRegion.h
Go to the documentation of this file.
1 /**
2 * @file GdkParamPointSetRegion.h
3 * @brief Declares the GdkPointSetRegion interface.
4 *
5 * Copyright (C) 2015-2022 by LMI Technologies Inc. All rights reserved.
6 */
7 #ifndef GDK_EXT_PARAM_POINT_SET_REGION_H
8 #define GDK_EXT_PARAM_POINT_SET_REGION_H
9 
10 #include <Gdk/GdkDef.h>
11 #include <Gdk/Config/GdkParam.h>
12 #include <Gdk/Config/GdkParamInfo.h>
13 
14 typedef kPointer GdkPointSetRegionParam;
15 
16 /**
17 * Sets the constant Z value which will then be used for all points, and will not be modifiable by client.
18 *
19 * @public @memberof GdkParamPointSetRegion
20 * @param param Param object.
21 * @param constantZ Z value to use for all points.
22 * @return Operation status.
23 */
24 GdkFx(kStatus) GdkParamPointSetRegion_SetConstantZ(GdkPointSetRegionParam param, k64f constantZ);
25 
26 /**
27 * Gets the current constant Z value.
28 *
29 * @public @memberof GdkParamPointSetRegion
30 * @param param Param object.
31 * @return Currently used constant-z value.
32 */
33 GdkFx(k64f) GdkParamPointSetRegion_ConstantZ(GdkPointSetRegionParam param);
34 
35 /**
36 * Disables constant Z for the parameter. All points must have individual, valid Z-values
37 *
38 * @public @memberof GdkParamPointSetRegion
39 * @param param Param object.
40 * @return Operation status.
41 */
42 GdkFx(kStatus) GdkParamPointSetRegion_DisableConstantZ(GdkPointSetRegionParam param);
43 
44 /**
45 * Sets the point shape mode for the parameter.
46 *
47 * @public @memberof GdkParamPointSetRegion
48 * @param param Param object.
49 * @param shape Shape to use when displaying points.
50 * @return Operation status.
51 */
52 GdkFx(kStatus) GdkParamPointSetRegion_SetPointShape(GdkPointSetRegionParam param, kMarkerShape shape);
53 
54 /**
55 * Gets the point shape mode for the parameter.
56 *
57 * @public @memberof GdkParamPointSetRegion
58 * @param param Param object.
59 * @return Current point-shape setting.
60 */
61 GdkFx(kMarkerShape) GdkParamPointSetRegion_PointShape(GdkPointSetRegionParam param);
62 
63 /**
64 * Sets the point size for the parameter.
65 *
66 * @public @memberof GdkParamPointSetRegion
67 * @param param Param object.
68 * @param size Size of points, in pixels, to display.
69 * @return Operation status.
70 */
71 GdkFx(kStatus) GdkParamPointSetRegion_SetPointSize(GdkPointSetRegionParam param, k16u size);
72 
73 /**
74 * Gets the point size for the parameter.
75 *
76 * @public @memberof GdkParamPointSetRegion
77 * @param param Param object.
78 * @return Current point-size of the parameter.
79 */
80 GdkFx(k16u) GdkParamPointSetRegion_PointSize(GdkPointSetRegionParam param);
81 
82 /**
83 * Sets the point colour for the parameter.
84 *
85 * @public @memberof GdkParamPointSetRegion
86 * @param param Param object.
87 * @param color Color to display points.
88 * @return Operation status.
89 */
90 GdkFx(kStatus) GdkParamPointSetRegion_SetPointColor(GdkPointSetRegionParam param, GdkPointSetRegionColor color);
91 
92 /**
93 * Gets the point colour for the parameter.
94 *
95 * @public @memberof GdkParamPointSetRegion
96 * @param param Param object.
97 * @return Current point color setting.
98 */
99 GdkFx(GdkPointSetRegionColor) GdkParamPointSetRegion_PointColor(GdkPointSetRegionParam param);
100 
101 /**
102 * Sets the line colour for the parameter.
103 *
104 * @public @memberof GdkParamPointSetRegion
105 * @param param Param object.
106 * @param color Color to display lines (if shown).
107 * @return Operation status.
108 */
109 GdkFx(kStatus) GdkParamPointSetRegion_SetLineColor(GdkPointSetRegionParam param, GdkPointSetRegionColor color);
110 
111 /**
112 * Gets the line colour for the parameter.
113 *
114 * @public @memberof GdkParamPointSetRegion
115 * @param param Param object.
116 * @return Current line color setting.
117 */
118 GdkFx(GdkPointSetRegionColor) GdkParamPointSetRegion_LineColor(GdkPointSetRegionParam param);
119 
120 /**
121 * Sets the point connectedness mode for the parameter
122 *
123 * @public @memberof GdkParamPointSetRegion
124 * @param param Param object.
125 * @param mode Mode with which to connect points (or not).
126 * @return Operation status.
127 */
128 GdkFx(kStatus) GdkParamPointSetRegion_SetMode(GdkPointSetRegionParam param, GdkPointSetRegionMode mode);
129 
130 /**
131 * Gets the point connectedness mode for the parameter
132 *
133 * @public @memberof GdkParamPointSetRegion
134 * @param param Param object.
135 * @return Mode with which to connect points (or not).
136 */
137 GdkFx(GdkPointSetRegionMode) GdkParamPointSetRegion_Mode(GdkPointSetRegionParam param);
138 
139 /**
140 * Sets the projection on or off for the parameter.
141 *
142 * @public @memberof GdkParamPointSetRegion
143 * @param param Param object.
144 * @param showProjection Show the projection of the point set or not.
145 * @return Operation status.
146 */
147 GdkFx(kStatus) GdkParamPointSetRegion_SetProjection(GdkPointSetRegionParam param, kBool showProjection);
148 
149 /**
150 * Gets the projection on or off setting for the parameter.
151 *
152 * @public @memberof GdkParamPointSetRegion
153 * @param param Param object.
154 * @return Current state of show-projection for the point set.
155 */
156 GdkFx(kBool) GdkParamPointSetRegion_Projection(GdkPointSetRegionParam param);
157 
158 /**
159 * Sets the maximum number of points supported by the parameter.
160 *
161 * @public @memberof GdkParamPointSetRegion
162 * @param param Param object.
163 * @param maxPoints Maximum number of points to be allowed.
164 * @return Operation status.
165 */
166 GdkFx(kStatus) GdkParamPointSetRegion_SetMaxPoints(GdkPointSetRegionParam param, k32u maxPoints);
167 
168 /**
169 * Gets the maximum number of points supported by the parameter.
170 *
171 * @public @memberof GdkParamPointSetRegion
172 * @param param Param object.
173 * @return Current max points setting.
174 */
175 GdkFx(k32u) GdkParamPointSetRegion_MaxPoints(GdkPointSetRegionParam param);
176 
177 /**
178 * Sets the minimum number of points supported by the parameter.
179 *
180 * @public @memberof GdkParamPointSetRegion
181 * @param param Param object.
182 * @param minPoints Minimum number of points to be allowed.
183 * @return Operation status.
184 */
185 GdkFx(kStatus) GdkParamPointSetRegion_SetMinPoints(GdkPointSetRegionParam param, k32u minPoints);
186 
187 /**
188 * Gets the minimum number of points supported by the parameter.
189 *
190 * @public @memberof GdkParamPointSetRegion
191 * @param param Param object.
192 * @return Current minimum points setting for the parameter.
193 */
194 GdkFx(k32u) GdkParamPointSetRegion_MinPoints(GdkPointSetRegionParam param);
195 
196 
197 /**
198 * Sets the number of points for the parameter. Must be between (or equal to) the current min and max settings.
199 *
200 * @public @memberof GdkParamPointSetRegion
201 * @param param Param object.
202 * @param count Number of points.
203 * @return Operation status.
204 */
205 GdkFx(kStatus) GdkParamPointSetRegion_SetPointCount(GdkPointSetRegionParam param, kSize count);
206 
207 /**
208 * Gets the number of points for the parameter.
209 *
210 * @public @memberof GdkParamPointSetRegion
211 * @param param Param object.
212 * @return Current point count.
213 */
214 GdkFx(kSize) GdkParamPointSetRegion_PointCount(GdkPointSetRegionParam param);
215 
216 /**
217 * Sets the value of a point within the parameter. Index must be in the range (0, GdkParamPointSetRegion_PointCount - 1)
218 *
219 * @public @memberof GdkParamPointSetRegion
220 * @param param Param object.
221 * @param index Index of point to be set
222 * @param point Pointer to value to copy into point set.
223 * @return Operation status.
224 */
225 GdkFx(kStatus) GdkParamPointSetRegion_SetPointAt(GdkPointSetRegionParam param, kSize index, const kPoint3d64f* point);
226 
227 /**
228 * Gets the value of a point within the parameter. Index must be in the range (0, GdkParamPointSetRegion_PointCount - 1)
229 *
230 * @public @memberof GdkParamPointSetRegion
231 * @param param Param object.
232 * @param index Index of point to be retrieved.
233 * @return Const pointer to point value.
234 */
235 GdkFx(const kPoint3d64f*) GdkParamPointSetRegion_PointAt(GdkPointSetRegionParam param, kSize index);
236 
237 #endif
GdkDef.h
Essential Gdk declarations.
GdkParamInfo.h
Declares the GdkParamInfo class.
GdkPointSetRegionMode
Connectedness of points in point set region.
GdkParam.h
Declares the GdkParam class.
GdkPointSetRegionColor
Color, of points or connecting lines.