torque Torque Game Engine Documentation
TGE Version 1.5.2

GuiGraphCtrl Class Reference

#include <guiGraphCtrl.h>

Inheritance diagram for GuiGraphCtrl:

Inheritance graph
[legend]

Public Types

enum  Constants {
  MaxPlots = 6,
  MaxDataPoints = 200
}
enum  GraphType {
  Point,
  Polyline,
  Filled,
  Bar
}

Public Member Functions

 DECLARE_CONOBJECT (GuiGraphCtrl)
 GuiGraphCtrl ()
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
void addDatum (S32 plotID, F32 v)
F32 getDatum (S32 plotID, S32 samples)
void addAutoPlot (S32 plotID, const char *variable, S32 update)
void removeAutoPlot (S32 plotID)
void setGraphType (S32 plotID, const char *graphType)

Data Fields

PlotInfo mPlots [MaxPlots]

Private Types

typedef GuiControl Parent

Data Structures

struct  PlotInfo

Member Typedef Documentation

typedef GuiControl GuiGraphCtrl::Parent [private]

Reimplemented from GuiControl.


Member Enumeration Documentation

Enumerator:
MaxPlots 
MaxDataPoints 

Enumerator:
Point 
Polyline 
Filled 
Bar 


Constructor & Destructor Documentation

GuiGraphCtrl::GuiGraphCtrl (  ) 


Member Function Documentation

GuiGraphCtrl::DECLARE_CONOBJECT ( GuiGraphCtrl   ) 

bool GuiGraphCtrl::onWake (  )  [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

void GuiGraphCtrl::onRender ( Point2I  offset,
const RectI updateRect 
) [virtual]

Called when this control is to render itself.

Parameters:
offset The location this control is to begin rendering
updateRect The screen area this control has drawing access to

Reimplemented from GuiControl.

void GuiGraphCtrl::addDatum ( S32  plotID,
F32  v 
)

F32 GuiGraphCtrl::getDatum ( S32  plotID,
S32  samples 
)

void GuiGraphCtrl::addAutoPlot ( S32  plotID,
const char *  variable,
S32  update 
)

void GuiGraphCtrl::removeAutoPlot ( S32  plotID  ) 

void GuiGraphCtrl::setGraphType ( S32  plotID,
const char *  graphType 
)


Field Documentation




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen