d4d_graph.h

Go to the documentation of this file.

/**************************************************************************
*
* Copyright 2014 by Petr Gargulak. eGUI Community.
* Copyright 2009-2013 by Petr Gargulak. Freescale Semiconductor, Inc.
*
***************************************************************************
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License Version 3
* or later (the "LGPL").
*
* As a special exception, the copyright holders of the eGUI project give you
* permission to link the eGUI sources with independent modules to produce an
* executable, regardless of the license terms of these independent modules,
* and to copy and distribute the resulting executable under terms of your
* choice, provided that you also meet, for each linked independent module,
* the terms and conditions of the license of that module.
* An independent module is a module which is not derived from or based
* on this library.
* If you modify the eGUI sources, you may extend this exception
* to your version of the eGUI sources, but you are not obligated
* to do so. If you do not wish to do so, delete this
* exception statement from your version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program.
* If not, see <http://www.gnu.org/licenses/>.
*
***************************************************************************/
#ifndef __D4D_GRAPH_H
#define __D4D_GRAPH_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_graphSysFunc;

/******************************************************************************
* D4D GRAPH setting  constants
*
*/
#ifndef D4D_GRAPH_BORDER_OFF
  #define D4D_GRAPH_BORDER_OFF        5
#endif

#ifndef D4D_GRAPH_VALUE_OFF
  #define D4D_GRAPH_VALUE_OFF        2
#endif

#ifndef D4D_COLOR_GRAPH_GRID
  #define D4D_COLOR_GRAPH_GRID        D4D_COLOR_LIGHT_GREY
#endif

//********************* Graph flags for its specific flags *****************
  //@note    For axis, only one setting can be used, it is not allowed to mix two flags for one axis.

  #define D4D_GRAPH_F_MODE_MASK       (0x03 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_GRAPH_F_MODE_NORMAL     (0x00 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_GRAPH_F_MODE_ROLLOVER   (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)       

  #define D4D_GRAPH_F_VALUE_X_NONE    (0x00 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_GRAPH_F_VALUE_X_BOTT    (0x04 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_GRAPH_F_VALUE_X_TOP     (0x08 << D4D_OBJECT_F_OBJECT_SHIFT)       

  #define D4D_GRAPH_F_VALUE_Y_NONE    (0x00 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_GRAPH_F_VALUE_Y_LEFT    (0x10 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_GRAPH_F_VALUE_Y_RIGHT   (0x20 << D4D_OBJECT_F_OBJECT_SHIFT)       

#ifndef D4D_GRAPH_F_DEFAULT
  #define D4D_GRAPH_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_BEVEL_RAISED | D4D_GRAPH_F_MODE_ROLLOVER | D4D_GRAPH_F_VALUE_X_BOTT | D4D_GRAPH_F_VALUE_Y_RIGHT  )
#endif

#ifndef D4D_GRAPH_TXT_PRTY_DEFAULT
  #define D4D_GRAPH_TXT_PRTY_DEFAULT  (D4D_ALIGN_H_CENTER_MASK | D4D_ALIGN_V_CENTER_MASK)
#endif

#ifndef D4D_GRAPH_FNT_PRTY_DEFAULT
  #define D4D_GRAPH_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_GRAPH_LBL_FNT_PRTY_DEFAULT
  #define D4D_GRAPH_LBL_FNT_PRTY_DEFAULT  ( 0 )
#endif

//********************* Graph traces types *****************
  #define D4D_GRAPH_TRACE_TYPE_MASK       0x03  
  #define D4D_GRAPH_TRACE_TYPE_LINE       0x00  
  #define D4D_GRAPH_TRACE_TYPE_DOT        0x01  
  #define D4D_GRAPH_TRACE_TYPE_AREA       0x02  
  #define D4D_GRAPH_TRACE_TYPE_AREA_INV   0x03  

/******************************************************************************
* D4D GRAPH setting  public types
*
*/
typedef Byte D4D_GRAPH_VALUE;

typedef LWord D4D_GRAPH_SAMPLE_IX;

/**************************************************************************/ 
typedef void (*D4D_GRAPH_ON_CHANGE)(D4D_OBJECT* pThis);

/**************************************************************************/ 
typedef D4D_TCHAR* (*D4D_GRAPH_ON_NEED_LABEL)(D4D_OBJECT_PTR pThis, D4D_BOOL axisX, D4D_INDEX gridIx, D4D_GRAPH_SAMPLE_IX sampleIx);


/******************************************************************************
* Private Types
******************************************************************************/


typedef Word D4D_GRAPH_DATA_LEN;


typedef struct
{
  D4D_GRAPH_VALUE *pData;
  D4D_COLOR color;
  D4D_LINETYPE line;
  Byte type;
} D4D_GRAPH_TRACE;

typedef struct
{
    D4D_GRAPH_SAMPLE_IX xPosCnt;      // position counter on X axis
    D4D_GRAPH_DATA_LEN lastShowPos;   // position in input data buffer of shown data
    D4D_GRAPH_DATA_LEN lastDataPos;   // position in input data buffer of last added data
    D4D_GRAPH_DATA_LEN initData;
    D4D_GRAPH_DATA_LEN dataShowX; // count of showed data on axis X
    D4D_COOR lblSizeY;
    D4D_COOR columnDrawed;
    D4D_INDEX drigDrawedX;
} D4D_GRAPH_DATA;

typedef struct
{
  D4D_INDEX x_cnt;
  D4D_INDEX y_cnt;
}D4D_GRAPH_GRID;

// GRAPH configuration (in ROM by default)

typedef struct
{
    D4D_STRING                  textBuff;       // GRAPH main text
    D4D_GRAPH_GRID              grid;        // graph grid information
    const D4D_GRAPH_TRACE*      traces;
    D4D_GRAPH_DATA_LEN          dataLenght;
    D4D_FONT                    labelFont;
    D4D_GRAPH_ON_NEED_LABEL     OnNeedLabelText;
    D4D_GRAPH_ON_CHANGE         OnValueChanged;
    D4D_GRAPH_DATA*             pData;
} D4D_GRAPH;

/******************************************************************************
* Macros
******************************************************************************/

// getting the GRAPH structure from general OBJECT
#define D4D_GET_GRAPH(pObj) ((D4D_GRAPH*)((pObj)->pParam))

/******************************************************************************
* D4D GRAPH setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_GRAPH_BEGIN(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg) \
    extern type D4D_GRAPH_TRACE  name##_traces[];\
    static D4D_GRAPH_DATA name##_data = { 0, 0, 0, 0, 0, 0, 0, 0}; /* reset data of graph*/ \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_GRAPH_FNT_PRTY_DEFAULT, D4D_GRAPH_TXT_PRTY_DEFAULT}; \
    static type D4D_GRAPH name##_params = \
    { \
        { text, D4D_TEXT_LEN(text), fontId, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0}, /* textBuff */ \
        { gx, gy },   /* grid info  */ \
        &(name##_traces[0]),  /* pLines     */ \
        dataLen,      /* Length of input data buffers */ \
        lblFontId,    /* Font ID for axis values */ \
        pOnNeedLblTxt, /* On need the label text*/ \
        pOnValch,      /* OnValueCanged */ \
        &(name##_data) /* RAM-based data */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_graphSysFunc, &(name##_params), (flags), pUser, pScheme)\
    \
    type D4D_GRAPH_TRACE name##_traces[] = \
    {


/**************************************************************************/ 
#define D4D_DECLARE_GRAPH_TRACE(pData, clr, line, type) { pData, clr , line, type},

/**************************************************************************/ 
#define D4D_DECLARE_GRAPH_END() { NULL, D4D_COLOR_WHITE , D4D_LINE_THIN, 0}};


/**************************************************************************/ 
#define D4D_DECLARE_GRAPH_BEGIN(name, text, x, y, cx, cy, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_GRAPH_BEGIN(D4D_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_GRAPH_BEGIN(name, text, x, y, cx, cy, gx, gy, dataLen, fontId, lblFontId) \
  D4D_DECLARE_GRAPH_BEGIN(name, text, x, y, cx, cy, gx, gy, dataLen, (D4D_GRAPH_F_DEFAULT), NULL, fontId, lblFontId, NULL, NULL, NULL, NULL)

// Rounded graph definition
/**************************************************************************/ 
#define D4D_DECLARE_RGRAPH_BEGIN(name, text, x, y, cx, cy, radius, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_GRAPH_BEGIN(D4D_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RGRAPH_BEGIN(name, text, x, y, cx, cy, radius, gx, gy, dataLen, fontId, lblFontId) \
  D4D_DECLARE_RGRAPH_BEGIN(name, text, x, y, cx, cy, radius, gx, gy, dataLen, (D4D_GRAPH_F_DEFAULT), NULL, fontId, lblFontId, NULL, NULL, NULL, NULL)


// IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_GRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_GRAPH_BEGIN(D4D_NO_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_GRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, gx, gy, dataLen, fontId, lblFontId) \
  D4D_DECLARE_STD_GRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, gx, gy, dataLen, (D4D_GRAPH_F_DEFAULT), NULL, fontId, lblFontId, NULL, NULL, NULL, NULL)


// Rounded graph definition
/**************************************************************************/ 
#define D4D_DECLARE_RGRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, radius, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_GRAPH_BEGIN(D4D_NO_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, gx, gy, dataLen, flags, pScheme, fontId, lblFontId, pOnNeedLblTxt, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RGRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, radius, gx, gy, dataLen, fontId, lblFontId) \
  D4D_DECLARE_RGRAPH_BEGIN_INRAM(name, text, x, y, cx, cy, radius, gx, gy, dataLen, (D4D_GRAPH_F_DEFAULT), NULL, fontId, lblFontId, NULL, NULL, NULL, NULL)

/******************************************************************************
* Global variables
******************************************************************************/

/******************************************************************************
* Global functions
******************************************************************************/

/*********************************************************
*
* global functions
*
*********************************************************/
D4D_BOOL D4D_GraphAddTraceData(D4D_OBJECT_PTR pObj, D4D_INDEX trace_ix,  D4D_GRAPH_VALUE value);
void D4D_GraphAddTracesData(D4D_OBJECT_PTR pObj, D4D_GRAPH_VALUE* pValues);
void D4D_GraphClearAll(D4D_OBJECT_PTR pObj);
D4D_GRAPH_SAMPLE_IX D4D_GraphGetSampleIndex(D4D_OBJECT_PTR pObj);
D4D_COOR D4D_GraphGetSizeX(D4D_OBJECT_PTR pObj);
D4D_BOOL D4D_GraphSetScaleX(D4D_OBJECT_PTR pObj, Byte mul, Byte div);
D4D_BOOL D4D_GraphSetDataWidth(D4D_OBJECT_PTR pObj, D4D_INDEX samples);


// Obsolete functions, replaced by any general
#define D4D_GraphSetText D4D_SetText




#endif /* __D4D_GRAPH_H */