d4d_gauge.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_GAUGE_H
#define __D4D_GAUGE_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_gaugeSysFunc;

/******************************************************************************
* D4D GAUGE setting  constants
*
*/
#ifndef D4D_GAUGE_HUB_RADIUS
  #define D4D_GAUGE_HUB_RADIUS 3
#endif

#ifndef D4D_COLOR_GAUG_HUB
  #define D4D_COLOR_GAUG_HUB        D4D_COLOR_DARK_RED
#endif

#ifndef D4D_COLOR_GAUG_POINTER
  #define D4D_COLOR_GAUG_POINTER    D4D_COLOR_DARK_BLUE
#endif

//********************* Gauge flags for its specific flags *****************
#define D4D_GAUGE_F_REDRAW_TEXT     (0x01 << D4D_OBJECT_F_OBJECT_SHIFT) 
#define D4D_GAUGE_F_HUB             (0x02 << D4D_OBJECT_F_OBJECT_SHIFT) 
#define D4D_GAUGE_F_THICK_POINTER   (0x04 << D4D_OBJECT_F_OBJECT_SHIFT) 


#ifndef D4D_GAUGE_F_DEFAULT
  #define D4D_GAUGE_F_DEFAULT     (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_TOUCHENABLE | D4D_GAUGE_F_REDRAW_TEXT | D4D_GAUGE_F_HUB)
#endif

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

#ifndef D4D_GAUGE_FNT_PRTY_DEFAULT
  #define D4D_GAUGE_FNT_PRTY_DEFAULT  ( 0 )
#endif

/******************************************************************************
* D4D GAUGE setting  public types
*
*/
/**************************************************************************/ 
typedef void (*D4D_GAUGE_ON_CHANGE)(D4D_OBJECT* pThis);


typedef sByte D4D_GAUGE_VALUE;
typedef Byte D4D_GAUGE_ANGLE;


typedef struct
{
  D4D_GAUGE_VALUE valueMin;   
  D4D_GAUGE_VALUE valueMax;   
  D4D_GAUGE_ANGLE angleMin;   
  D4D_GAUGE_ANGLE angleMax;   
} D4D_GAUGE_LIMITS;

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

// gauge runtime data (always in RAM)

typedef struct
{
    D4D_GAUGE_VALUE value;      // current value
    D4D_GAUGE_VALUE valueLast;  // last pointer value drawn
    D4D_TREND trend;            // trend of pointer move (D4D_CLOCK_WISE or D4D_ANTI_CLOCK_WISE)
    D4D_GAUGE_LIMITS limits;    // gauge runtime configuration
} D4D_GAUGE_DATA;

// gauge configuration (in ROM by default)

typedef struct
{
    D4D_STRING textBuff;       // gauge text
    D4D_POINT txtOff;           // text coordinates as offset from scrPos
    D4D_POINT hubOff;           // hub coordinates as offset from scrPos
    D4D_COOR  pointerLen;       // lentgth of the pointer line
    const D4D_BMP*  pBmpBkgd;   // gauge background bitmap

    D4D_GAUGE_ON_CHANGE OnValueChanged;

    D4D_GAUGE_DATA* pData;

} D4D_GAUGE;

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

// getting the GAUGE structure from general OBJECT
#define D4D_GET_GAUGE(pObj) ((D4D_GAUGE*)((pObj)->pParam))

/******************************************************************************
* D4D GAUGE setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_GAUGE(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
    static D4D_GAUGE_DATA name##_data = {0, 1, D4D_CLOCK_WISE, {0, 100, 0, 0x7F } }; \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_GAUGE_FNT_PRTY_DEFAULT, D4D_GAUGE_TXT_PRTY_DEFAULT}; \
    static type D4D_GAUGE name##_params = \
    { \
        { text, D4D_TEXT_LEN(text), fontId, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0},      /* pText */ \
        { tx, ty },     /* txtOff */ \
        { kx, ky },     /* hubOff */ \
        plen,           /* pointerLen */ \
        pBmp,           /* pBmpBkgd */ \
        onvalch,        /* OnValueChanged */ \
        &(name##_data)  /* RAM-based data */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_gaugeSysFunc, &(name##_params), flags, pUser, pScheme)


/**************************************************************************/ 
#define D4D_DECLARE_GAUGE(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_GAUGE(D4D_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_GAUGE(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, pBmp, fontId, onvalch) \
    D4D_DECLARE_GAUGE(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, (D4D_GAUGE_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

// Rounded gauge definition
/**************************************************************************/ 
#define D4D_DECLARE_RGAUGE(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_GAUGE(D4D_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RGAUGE(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, pBmp, fontId, onvalch) \
    D4D_DECLARE_RGAUGE(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, (D4D_GAUGE_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)


// IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_GAUGE_INRAM(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_GAUGE(D4D_NO_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_GAUGE_INRAM(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, pBmp, fontId, onvalch) \
    D4D_DECLARE_GAUGE_INRAM(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, (D4D_GAUGE_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

// Rounded gauge definition
/**************************************************************************/ 
#define D4D_DECLARE_RGAUGE_INRAM(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_GAUGE(D4D_NO_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RGAUGE_INRAM(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, pBmp, fontId, onvalch) \
    D4D_DECLARE_RGAUGE_INRAM(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, (D4D_GAUGE_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

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


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

/*********************************************************
*
* global functions
*
*********************************************************/

void D4D_GaugSetValue(D4D_OBJECT_PTR pThis, D4D_GAUGE_VALUE value);
D4D_GAUGE_VALUE D4D_GaugGetValue(D4D_OBJECT_PTR pThis);

void D4D_GaugSetLimits(D4D_OBJECT_PTR pThis, const D4D_GAUGE_LIMITS* pLimits);
void D4D_GaugGetLimits(D4D_OBJECT_PTR pThis, D4D_GAUGE_LIMITS* pLimits);

void D4D_GaugSetDir(D4D_OBJECT_PTR pThis, D4D_TREND direction);
D4D_TREND D4D_GaugGetDir(D4D_OBJECT_PTR pThis);


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




#endif /* __D4D_GAUGE_H */