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 kBeginHeader()
14 
15 
21 //typedef kObject kPlot; --forward-declared in kFsDef.x.h
22 
23 
31 kFsFx(kStatus) kPlot_Construct(kPlot* plot, kObject allocator);
32 
44 kFsFx(kStatus) kPlot_Add(kPlot plot, const kChar* label, const kObject* item);
45 
59 kFsFx(kStatus) kPlot_SetWorld(kPlot plot, k32f x, k32f y, k32f width, k32f height);
60 
76 kFsFx(kStatus) kPlot_SetWorld3d(kPlot plot, k32f x, k32f y, k32f z, k32f width, k32f height, k32f depth);
77 
86 kFsFx(kStatus) kPlot_SetBackColor(kPlot plot, kColor color);
87 
98 kFsFx(kStatus) kPlot_SetTitles(kPlot plot, const kChar* title, const kChar* xTitle, const kChar* yTitle);
99 
108 kFsFx(kStatus) kPlot_SetTitle(kPlot plot, const kChar* title);
109 
118 kFsFx(kStatus) kPlot_SetXTitle(kPlot plot, const kChar* title);
119 
128 kFsFx(kStatus) kPlot_SetYTitle(kPlot plot, const kChar* title);
129 
138 kFsFx(kStatus) kPlot_SetZTitle(kPlot plot, const kChar* title);
139 
148 kFsFx(kStatus) kPlot_SetProfilerTitle(kPlot plot, const kChar* title);
149 
157 kFsFx(k32f) kPlot_X(kPlot plot);
158 
166 kFsFx(k32f) kPlot_Y(kPlot plot);
167 
175 kFsFx(k32f) kPlot_Z(kPlot plot);
176 
184 kFsFx(k32f) kPlot_Width(kPlot plot);
185 
193 kFsFx(k32f) kPlot_Height(kPlot plot);
194 
202 kFsFx(k32f) kPlot_Depth(kPlot plot);
203 
211 kFsFx(kColor) kPlot_BackColor(kPlot plot);
212 
220 kFsFx(const kChar*) kPlot_Title(kPlot plot);
221 
229 kFsFx(const kChar*) kPlot_XTitle(kPlot plot);
230 
238 kFsFx(const kChar*) kPlot_YTitle(kPlot plot);
239 
247 kFsFx(const kChar*) kPlot_ZTitle(kPlot plot);
248 
256 kFsFx(const kChar*) kPlot_ProfilerTitle(kPlot plot);
257 
265 kFsFx(kSize) kPlot_Count(kPlot plot);
266 
275 kFsFx(const kChar*) kPlot_NameAt(kPlot plot, kSize index);
276 
285 kFsFx(kObject) kPlot_DataAt(kPlot plot, kSize index);
286 
287 kEndHeader()
288 
289 #include <kFireSync/Data/kPlot.x.h>
290 
291 #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.
kSize kPlot_Count(kPlot plot)
Returns the total count of items in the plot.
kObject kPlot_DataAt(kPlot plot, kSize index)
Returns plot item data at the specified index.
const kChar * kPlot_NameAt(kPlot plot, kSize index)
Returns plot item name at the specified index.
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.
kStatus kPlot_SetProfilerTitle(kPlot plot, const kChar *title)
Sets title for the profiler.
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.
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.
k32f kPlot_Height(kPlot plot)
Returns the world coordinates for the plot.
const kChar * kPlot_ProfilerTitle(kPlot plot)
Returns the profiler title.
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.
const kChar * kPlot_YTitle(kPlot plot)
Returns the y-axis label.
k32f kPlot_Width(kPlot plot)
Returns the world coordinates for the plot.
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.
const kChar * kPlot_Title(kPlot plot)
Returns the main heading.
k32f kPlot_Depth(kPlot plot)
Returns the world coordinates for the plot.
kColor kPlot_BackColor(kPlot plot)
Returns the background color for the plot.
kStatus kPlot_SetBackColor(kPlot plot, kColor color)
Sets the background color for the plot.
kStatus kPlot_Construct(kPlot *plot, kObject allocator)
Constructs a plot.