MityDSP Documentation Index
Public Member Functions | Protected Member Functions | Protected Attributes
MityDSP::tcGuiGraph Class Reference

#include <ggui/gui_graph.h>

Inheritance diagram for MityDSP::tcGuiGraph:
MityDSP::tcGuiObject MityDSP::tcGuiGenericGraph

List of all members.

Public Member Functions

 tcGuiGraph (const char *name, tcBench *bench, int idd, uint32 type)
virtual ~tcGuiGraph ()
virtual bool ParseXML (TiXmlElement *ahDom)
virtual void create ()
void show (bool show=true)
void hide ()
void set_plot_bg (tsRgb color)
void set_gutter_fg (tsRgb color)
void set_gutter_bg (tsRgb color)
void set_axis_major (tsRgb color)
void set_axis_minor (tsRgb color)
void set_left_gutter (int left_gutter)
void set_right_gutter (int right_gutter)
void set_top_gutter (int top_gutter)
void set_bottom_gutter (int bottom_gutter)
void set_axis_font (tcDspFont *font)
void set_title (const char *title, bool redraw=false)
int get_plot_x ()
int get_plot_y ()
int get_plot_h ()
int get_plot_w ()
void set_line_side (eGraphAxisLineSide side)
tcRect get_plot_rect ()
const tcGraphAxisget_x_axis ()
const tcGraphAxisget_ly_axis ()
const tcGraphAxisget_ry_axis ()
void redraw ()
void draw (tcGuiDspDisplay &pd)
- Public Member Functions inherited from MityDSP::tcGuiObject
 tcGuiObject (const char *name, tcBench *bench, int idd, uint32 type)
virtual ~tcGuiObject ()
const char * name ()
const GSTRINGgname ()
uint32 type ()
int idd ()
const char * get_text ()
bool is_visible ()
int get_x_pos ()
int get_y_pos ()
int get_height ()
int get_width ()
void get_rect (tcRect &rect)
int get_type ()
virtual tcGuiObjectget_parent_obj ()
virtual void set_text (const char *text)
virtual void set_x_pos (int x)
virtual void set_y_pos (int y)
virtual void set_height (int h)
virtual void set_width (int w)
void set_image (tcGuiImage *image)
virtual void set_text_x_pos (int x)
virtual void set_text_y_pos (int y)
void set_text_font (tcDspFont *font)
void set_text_font (const char *font_name)
void set_text_align (int align)
void set_text_color (tsRgb color)
void set_text_vertical (bool vert)
void set_text_wrap (bool wrap)
void set_fg_color (tsRgb color)
void set_bg_color (tsRgb color)
void set_user_id (int id)
virtual void set_animate (bool animate)
void set_user_ptr (void *ptr)
int get_user_id ()
tsRgb get_fg_color ()
tsRgb get_bg_color ()
tsRgb get_text_color ()
virtual bool is_point_in (int x, int y)
virtual bool is_rect_overlapped (tcRect &rect)
virtual bool lbutton_down (int x, int y)
virtual void lbutton_up (int x, int y)
virtual void mouse_move (int x, int y, int flags)
virtual bool does_l_mouse ()
virtual void animate ()
void invalidate (tcRect *bckgrnd_redraw=NULL)

Protected Member Functions

virtual void pre_clip_draw (tcGuiDspDisplay &pd)
virtual void pre_axis_draw (tcGuiDspDisplay &pd)
virtual void post_axis_draw (tcGuiDspDisplay &pd)
virtual void post_clip_draw (tcGuiDspDisplay &pd)
virtual void post_blt_draw (tcGuiDspDisplay &pd)
void erase ()
void draw_axis_lines (tcGuiDspDisplay &pd, uint32 flags)
void draw_axis_text (tcGuiDspDisplay &pd, uint32 flags)
void draw_axis (tcGuiDspDisplay &pd)
void draw_v_axis (tcGuiDspDisplay &pd, int x)
void draw_h_axis (tcGuiDspDisplay &pd, int y)
- Protected Member Functions inherited from MityDSP::tcGuiObject
virtual void calculate_text_rect (int alignment)
virtual void draw_text (tcGuiDspDisplay &pd, int alignment, int dip=0, float opacity=1.0F)

Protected Attributes

bool m_need_redraw
GSTRING m_title_string
tcGuiImagem_pixmap
tsRgb m_plot_bg
tsRgb m_gutter_fg
tsRgb m_gutter_bg
tsRgb m_axis_major
tsRgb m_axis_minor
int m_plot_x
int m_plot_y
int m_plot_w
int m_plot_h
tcRect m_plot_clip_rect
tcRect m_plot_rect
int m_left_gutter
int m_right_gutter
int m_top_gutter
int m_bottom_gutter
int m_label_x_name
int m_label_x_left
int m_label_x_right
int m_label_y_top
float m_y_range_max
float m_y_range_min
tcDspFont * m_axis_font
tcGraphAxism_LY_axis
tcGraphAxism_RY_axis
tcGraphAxism_X_axis
eGraphAxisLineSide m_line_side
LCK_Handle mhLock
 used for serialization of data accessors
int mhLock
 placeholder for win32 compiles.
- Protected Attributes inherited from MityDSP::tcGuiObject
bool m_created
 true when XML file parsing is complete and object has been initialized
bool m_visible
 true when object is potentially visible on the full screen
uint32 m_type
tcBenchm_bench
 pointer to the tcGuiBench (widget manager) object
bool m_animate
 true if this widget will perform animation
GSTRING m_name
 name of the widget
int m_idd
 unique ID number of the widget
int m_x_pos
 screen x position of the widget
int m_y_pos
 screen y position of the widget
int m_height
 widget height
int m_width
 widget widget
tcRect m_obj_rect
 bounding rectangle of widget (screen coordinates) (may not include all text)
tcRect m_text_rect
 bounding rectangle text for widget (screen coordinates)
int m_lcapture_x
int m_lcapture_y
int m_rcapture_x
int m_rcapture_y
tsRgb m_fg_color
 foregroun color to use when rendering tcGuiObject
tsRgb m_bg_color
 background color to use when rendering tcGuiObject
tsRgb m_text_color
 color to use when rendering tcGuiObject text
tcDspFont * m_font
 font to use when rendering tcGuiObject text
GSTRING m_text
 base tcGuiObject class text data
int m_text_x_pos
 reference screen x position of object text
int m_text_y_pos
 reference screen y position of object text
int m_text_align
 alignment flags used for text rendering
bool m_text_vertical
bool m_text_wrap
 true if this text string should be wrapped to available space when drawn
int m_user_id
void * m_user_ptr
tcGuiImagem_image
 pointer to optional background image

Additional Inherited Members

- Public Types inherited from MityDSP::tcGuiObject
enum  teAlignment {
  eeAlignLeft = 0x0000, eeAlignHCenter = 0x0001, eeAlignRight = 0x0002, eeAlignHMask = 0x0003,
  eeAlignTop = 0x0000, eeAlignVCenter = 0x0010, eeAlignBottom = 0x0020, eeAlignVMask = 0x0030,
  eeAlignCenter = eeAlignHCenter|eeAlignVCenter, eeAlignTopLeft = eeAlignTop|eeAlignLeft
}

Detailed Description

The tcGuiGraph class is an abstract base class used by all 2 dimensional plotting widgets in the ggui library.

See also:
tcGuiGraph Page

Constructor & Destructor Documentation

tcGuiGraph::tcGuiGraph ( const char *  name,
tcBench bench,
int  idd,
uint32  type 
)
tcGuiGraph::~tcGuiGraph ( )
virtual

Member Function Documentation

bool tcGuiGraph::ParseXML ( TiXmlElement *  apElement)
virtual

Parse common XML elements from the DOM.

Reimplemented from MityDSP::tcGuiObject.

Reimplemented in MityDSP::tcGuiGenericGraph.

void tcGuiGraph::create ( )
virtual

Reimplemented from MityDSP::tcGuiObject.

Reimplemented in MityDSP::tcGuiGenericGraph.

void tcGuiGraph::show ( bool  show = true)
virtual

This function un-hides the object. If hidden the object will not respond to mouse clicks or appear on the screen.

Note:
This function is usually called when the active screen changes from within the script virtual machine.

Reimplemented from MityDSP::tcGuiObject.

void tcGuiGraph::hide ( )
virtual

This function hides the object. If hidden the object will not respond to mouse clicks or appear on the screen.

Note:
This function is usually called when the active screen changes from within the script virtual machine.

Reimplemented from MityDSP::tcGuiObject.

void MityDSP::tcGuiGraph::set_plot_bg ( tsRgb  color)
inline
void MityDSP::tcGuiGraph::set_gutter_fg ( tsRgb  color)
inline
void MityDSP::tcGuiGraph::set_gutter_bg ( tsRgb  color)
inline
void MityDSP::tcGuiGraph::set_axis_major ( tsRgb  color)
inline
void MityDSP::tcGuiGraph::set_axis_minor ( tsRgb  color)
inline
void MityDSP::tcGuiGraph::set_left_gutter ( int  left_gutter)
inline
void MityDSP::tcGuiGraph::set_right_gutter ( int  right_gutter)
inline
void MityDSP::tcGuiGraph::set_top_gutter ( int  top_gutter)
inline
void MityDSP::tcGuiGraph::set_bottom_gutter ( int  bottom_gutter)
inline
void MityDSP::tcGuiGraph::set_axis_font ( tcDspFont *  font)
inline
void tcGuiGraph::set_title ( const char *  title,
bool  redraw = false 
)
int MityDSP::tcGuiGraph::get_plot_x ( )
inline
int MityDSP::tcGuiGraph::get_plot_y ( )
inline
int MityDSP::tcGuiGraph::get_plot_h ( )
inline
int MityDSP::tcGuiGraph::get_plot_w ( )
inline
void tcGuiGraph::set_line_side ( eGraphAxisLineSide  side)
tcRect MityDSP::tcGuiGraph::get_plot_rect ( )
inline
const tcGraphAxis* MityDSP::tcGuiGraph::get_x_axis ( )
inline
const tcGraphAxis* MityDSP::tcGuiGraph::get_ly_axis ( )
inline
const tcGraphAxis* MityDSP::tcGuiGraph::get_ry_axis ( )
inline
void MityDSP::tcGuiGraph::redraw ( )
inline
void tcGuiGraph::draw ( tcGuiDspDisplay pd)
virtual

Reimplemented from MityDSP::tcGuiObject.

virtual void MityDSP::tcGuiGraph::pre_clip_draw ( tcGuiDspDisplay pd)
inlineprotectedvirtual
virtual void MityDSP::tcGuiGraph::pre_axis_draw ( tcGuiDspDisplay pd)
inlineprotectedvirtual
virtual void MityDSP::tcGuiGraph::post_axis_draw ( tcGuiDspDisplay pd)
inlineprotectedvirtual

Reimplemented in MityDSP::tcGuiGenericGraph.

virtual void MityDSP::tcGuiGraph::post_clip_draw ( tcGuiDspDisplay pd)
inlineprotectedvirtual
virtual void MityDSP::tcGuiGraph::post_blt_draw ( tcGuiDspDisplay pd)
inlineprotectedvirtual
void tcGuiGraph::erase ( )
protected
void tcGuiGraph::draw_axis_lines ( tcGuiDspDisplay pd,
uint32  flags 
)
protected
void tcGuiGraph::draw_axis_text ( tcGuiDspDisplay pd,
uint32  flags 
)
protected
void tcGuiGraph::draw_axis ( tcGuiDspDisplay pd)
protected
void tcGuiGraph::draw_v_axis ( tcGuiDspDisplay pd,
int  x 
)
protected
void tcGuiGraph::draw_h_axis ( tcGuiDspDisplay pd,
int  y 
)
protected

Member Data Documentation

bool MityDSP::tcGuiGraph::m_need_redraw
protected
GSTRING MityDSP::tcGuiGraph::m_title_string
protected
tcGuiImage* MityDSP::tcGuiGraph::m_pixmap
protected
tsRgb MityDSP::tcGuiGraph::m_plot_bg
protected
tsRgb MityDSP::tcGuiGraph::m_gutter_fg
protected
tsRgb MityDSP::tcGuiGraph::m_gutter_bg
protected
tsRgb MityDSP::tcGuiGraph::m_axis_major
protected
tsRgb MityDSP::tcGuiGraph::m_axis_minor
protected
int MityDSP::tcGuiGraph::m_plot_x
protected
int MityDSP::tcGuiGraph::m_plot_y
protected
int MityDSP::tcGuiGraph::m_plot_w
protected
int MityDSP::tcGuiGraph::m_plot_h
protected
tcRect MityDSP::tcGuiGraph::m_plot_clip_rect
protected
tcRect MityDSP::tcGuiGraph::m_plot_rect
protected
int MityDSP::tcGuiGraph::m_left_gutter
protected
int MityDSP::tcGuiGraph::m_right_gutter
protected
int MityDSP::tcGuiGraph::m_top_gutter
protected
int MityDSP::tcGuiGraph::m_bottom_gutter
protected
int MityDSP::tcGuiGraph::m_label_x_name
protected
int MityDSP::tcGuiGraph::m_label_x_left
protected
int MityDSP::tcGuiGraph::m_label_x_right
protected
int MityDSP::tcGuiGraph::m_label_y_top
protected
float MityDSP::tcGuiGraph::m_y_range_max
protected
float MityDSP::tcGuiGraph::m_y_range_min
protected
tcDspFont* MityDSP::tcGuiGraph::m_axis_font
protected
tcGraphAxis* MityDSP::tcGuiGraph::m_LY_axis
protected
tcGraphAxis* MityDSP::tcGuiGraph::m_RY_axis
protected
tcGraphAxis* MityDSP::tcGuiGraph::m_X_axis
protected
eGraphAxisLineSide MityDSP::tcGuiGraph::m_line_side
protected
LCK_Handle MityDSP::tcGuiGraph::mhLock
protected

used for serialization of data accessors

int MityDSP::tcGuiGraph::mhLock
protected

placeholder for win32 compiles.


  
Generated on Mon Apr 22 2013 11:33:51 for MityDSP Skinnable Graphics User Interface (GGUI) by  Doxygen Version 1.8.1.1
Copyright © 2009, Critical Link LLC, All rights reserved.