FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPlot.h
Go to the documentation of this file.
1 
8 #ifndef K_API_PLOT_H
9 #define K_API_PLOT_H
10 
11 #include <kApi/Data/kImage.h>
13 #include <kFireSync/Data/kPlot.x.h>
14 
28 //typedef kObject kPlot; --forward-declared in kFsDef.x.h
29 
38 kFsFx(kStatus) kPlot_Construct(kPlot* plot, kObject allocator);
39 
51 kFsFx(kStatus) kPlot_Add(kPlot plot, const kChar* label, const kObject* item);
52 
66 kFsFx(kStatus) kPlot_SetWorld(kPlot plot, k32f x, k32f y, k32f width, k32f height);
67 
83 kFsFx(kStatus) kPlot_SetWorld3d(kPlot plot, k32f x, k32f y, k32f z, k32f width, k32f height, k32f depth);
84 
93 kFsFx(kStatus) kPlot_SetBackColor(kPlot plot, kColor color);
94 
105 kFsFx(kStatus) kPlot_SetTitles(kPlot plot, const kChar* title, const kChar* xTitle, const kChar* yTitle);
106 
115 kFsFx(kStatus) kPlot_SetTitle(kPlot plot, const kChar* title);
116 
125 kFsFx(kStatus) kPlot_SetXTitle(kPlot plot, const kChar* title);
126 
135 kFsFx(kStatus) kPlot_SetYTitle(kPlot plot, const kChar* title);
136 
145 kFsFx(kStatus) kPlot_SetZTitle(kPlot plot, const kChar* title);
146 
155 kFsFx(kStatus) kPlot_SetProfilerTitle(kPlot plot, const kChar* title);
156 
164 kInlineFx(k32f) kPlot_X(kPlot plot)
165 {
166  kObj(kPlot, plot);
167 
168  return obj->x;
169 }
170 
179 {
180  kObj(kPlot, plot);
181 
182  return obj->y;
183 }
184 
193 {
194  kObj(kPlot, plot);
195 
196  return obj->z;
197 }
198 
207 {
208  kObj(kPlot, plot);
209 
210  return obj->width;
211 }
212 
221 {
222  kObj(kPlot, plot);
223 
224  return obj->height;
225 }
226 
235 {
236  kObj(kPlot, plot);
237 
238  return obj->depth;
239 }
240 
249 {
250  kObj(kPlot, plot);
251 
252  return obj->backColor;
253 }
254 
263 {
264  kObj(kPlot, plot);
265 
266  return obj->title;
267 }
268 
277 {
278  kObj(kPlot, plot);
279 
280  return obj->xTitle;
281 }
282 
291 {
292  kObj(kPlot, plot);
293 
294  return obj->yTitle;
295 }
296 
305 {
306  kObj(kPlot, plot);
307 
308  return obj->zTitle;
309 }
310 
319 {
320  kObj(kPlot, plot);
321 
322  return obj->profilerTitle;
323 }
324 
333 {
334  kObj(kPlot, plot);
335 
336  return obj->count;
337 }
338 
347 kInlineFx(const kChar*) kPlot_NameAt(kPlot plot, kSize index)
348 {
349  return xkPlot_ItemAt(plot, index)->name;
350 }
351 
361 {
362  return xkPlot_ItemAt(plot, index)->object;
363 }
364 
365 #endif
kStatus kPlot_SetWorld(kPlot plot, k32f x, k32f y, k32f width, k32f height)
Defines the world coordinate system for the plot.
kStatus kPlot_SetYTitle(kPlot plot, const kChar *title)
Sets label for the y-axis.
k32f kPlot_Z(kPlot plot)
Returns the world coordinates for the plot.
Definition: kPlot.h:192
kSize kPlot_Count(kPlot plot)
Returns the total count of items in the plot.
Definition: kPlot.h:332
kObject kPlot_DataAt(kPlot plot, kSize index)
Returns plot item data at the specified index.
Definition: kPlot.h:360
const kChar * kPlot_NameAt(kPlot plot, kSize index)
Returns plot item name at the specified index.
Definition: kPlot.h:347
kStatus kPlot_SetWorld3d(kPlot plot, k32f x, k32f y, k32f z, k32f width, k32f height, k32f depth)
Defines the world coordinate system for the plot in 3D.
Color as an integer with 8-bit alpha, red, green, and blue components.
const kChar * kPlot_ZTitle(kPlot plot)
Returns the z-axis label.
Definition: kPlot.h:304
kStatus kPlot_SetProfilerTitle(kPlot plot, const kChar *title)
Sets title for the profiler.
#define kInlineFx(TYPE)
kStatus kPlot_SetZTitle(kPlot plot, const kChar *title)
Sets label for the z-axis.
Declares the kGraphic class.
k32f kPlot_X(kPlot plot)
Returns the world coordinates for the plot.
Definition: kPlot.h:164
kStatus kPlot_SetTitle(kPlot plot, const kChar *title)
Sets titles for the main heading.
Represents a multi-layer collection of images and/or vector graphics.
#define kObj(TypeName_T, T_object)
k32f kPlot_Height(kPlot plot)
Returns the world coordinates for the plot.
Definition: kPlot.h:220
const kChar * kPlot_ProfilerTitle(kPlot plot)
Returns the profiler title.
Definition: kPlot.h:318
kStatus kPlot_Add(kPlot plot, const kChar *label, const kObject *item)
Adds a new item to the plot.
kStatus kPlot_SetXTitle(kPlot plot, const kChar *title)
Sets label for the x-axis.
k32f kPlot_Y(kPlot plot)
Returns the world coordinates for the plot.
Definition: kPlot.h:178
const kChar * kPlot_YTitle(kPlot plot)
Returns the y-axis label.
Definition: kPlot.h:290
k32f kPlot_Width(kPlot plot)
Returns the world coordinates for the plot.
Definition: kPlot.h:206
kStatus kPlot_SetTitles(kPlot plot, const kChar *title, const kChar *xTitle, const kChar *yTitle)
Sets titles for the main heading, x-axis, and y-axis.
const kChar * kPlot_XTitle(kPlot plot)
Returns the x-axis label.
Definition: kPlot.h:276
const kChar * kPlot_Title(kPlot plot)
Returns the main heading.
Definition: kPlot.h:262
k32f kPlot_Depth(kPlot plot)
Returns the world coordinates for the plot.
Definition: kPlot.h:234
kColor kPlot_BackColor(kPlot plot)
Returns the background color for the plot.
Definition: kPlot.h:248
kStatus kPlot_SetBackColor(kPlot plot, kColor color)
Sets the background color for the plot.
kStatus kPlot_Construct(kPlot *plot, kObject allocator)
Constructs a plot.