FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPlot Class Reference

Description

Represents a multi-layer collection of images and/or vector graphics.

Note that unlike many kApi data collections, kPlot owns the data items that are added to it. Accordingly, kObject_Destroy will destroy both a plot object and any plot data items.

kPlot supports the kObject_Clone and kObject_Size methods.

kPlot supports the kdat5 and kdat6 serialization protocols.

Inheritance diagram for kPlot:
Inheritance graph

Public Member Functions

kStatus kPlot_Add (kPlot plot, const kChar *label, const kObject *item)
 Adds a new item to the plot. More...
 
kColor kPlot_BackColor (kPlot plot)
 Returns the background color for the plot. More...
 
kStatus kPlot_Construct (kPlot *plot, kObject allocator)
 Constructs a plot. More...
 
kSize kPlot_Count (kPlot plot)
 Returns the total count of items in the plot. More...
 
kObject kPlot_DataAt (kPlot plot, kSize index)
 Returns plot item data at the specified index. More...
 
k32f kPlot_Depth (kPlot plot)
 Returns the world coordinates for the plot. More...
 
k32f kPlot_Height (kPlot plot)
 Returns the world coordinates for the plot. More...
 
const kCharkPlot_NameAt (kPlot plot, kSize index)
 Returns plot item name at the specified index. More...
 
const kCharkPlot_ProfilerTitle (kPlot plot)
 Returns the profiler title. More...
 
kStatus kPlot_SetBackColor (kPlot plot, kColor color)
 Sets the background color for the plot. More...
 
kStatus kPlot_SetProfilerTitle (kPlot plot, const kChar *title)
 Sets title for the profiler. More...
 
kStatus kPlot_SetTitle (kPlot plot, const kChar *title)
 Sets titles for the main heading. More...
 
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. More...
 
kStatus kPlot_SetWorld (kPlot plot, k32f x, k32f y, k32f width, k32f height)
 Defines the world coordinate system for the plot. More...
 
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. More...
 
kStatus kPlot_SetXTitle (kPlot plot, const kChar *title)
 Sets label for the x-axis. More...
 
kStatus kPlot_SetYTitle (kPlot plot, const kChar *title)
 Sets label for the y-axis. More...
 
kStatus kPlot_SetZTitle (kPlot plot, const kChar *title)
 Sets label for the z-axis. More...
 
const kCharkPlot_Title (kPlot plot)
 Returns the main heading. More...
 
k32f kPlot_Width (kPlot plot)
 Returns the world coordinates for the plot. More...
 
k32f kPlot_X (kPlot plot)
 Returns the world coordinates for the plot. More...
 
const kCharkPlot_XTitle (kPlot plot)
 Returns the x-axis label. More...
 
k32f kPlot_Y (kPlot plot)
 Returns the world coordinates for the plot. More...
 
const kCharkPlot_YTitle (kPlot plot)
 Returns the y-axis label. More...
 
k32f kPlot_Z (kPlot plot)
 Returns the world coordinates for the plot. More...
 
const kCharkPlot_ZTitle (kPlot plot)
 Returns the z-axis label. More...
 

The documentation for this class was generated from the following file: