lvgl/lv_objx/lv_chart.c

/**
 * @file lv_chart.c
 *
 */

/*********************
 *      INCLUDES
 *********************/
#include "lv_conf.h"
#if USE_LV_CHART != 0

#include "lv_chart.h"
#include "../lv_draw/lv_draw.h"

/*********************
 *      DEFINES
 *********************/
#define LV_CHART_YMIN_DEF	0
#define LV_CHART_YMAX_DEF	100
#define LV_CHART_HDIV_DEF	3
#define LV_CHART_VDIV_DEF	5
#define LV_CHART_PNUM_DEF	10

/**********************
 *      TYPEDEFS
 **********************/

/**********************
 *  STATIC PROTOTYPES
 **********************/
static bool lv_chart_design(lv_obj_t * chart, const area_t * mask, lv_design_mode_t mode);
static void lv_chart_draw_div(lv_obj_t * chart, const area_t * mask);
static void lv_chart_draw_lines(lv_obj_t * chart, const area_t * mask);
static void lv_chart_draw_points(lv_obj_t * chart, const area_t * mask);
static void lv_chart_draw_cols(lv_obj_t * chart, const area_t * mask);


/**********************
 *  STATIC VARIABLES
 **********************/
static lv_design_func_t ancestor_design_f;

/**********************
 *      MACROS
 **********************/

/**********************
 *   GLOBAL FUNCTIONS
 **********************/

/*-----------------
 * Create function
 *-----------------*/

/**
 * Create a chart background objects
 * @param par pointer to an object, it will be the parent of the new chart background
 * @param copy pointer to a chart background object, if not NULL then the new object will be copied from it
 * @return pointer to the created chart background
 */
lv_obj_t * lv_chart_create(lv_obj_t * par, lv_obj_t * copy)
{
    /*Create the ancestor basic object*/
    lv_obj_t * new_chart = lv_obj_create(par, copy);
    dm_assert(new_chart);

    /*Allocate the object type specific extended data*/
    lv_chart_ext_t * ext = lv_obj_allocate_ext_attr(new_chart, sizeof(lv_chart_ext_t));
    dm_assert(ext);
    ll_init(&ext->dl_ll, sizeof(lv_chart_dl_t));
    ext->dl_num = 0;
    ext->ymin = LV_CHART_YMIN_DEF;
    ext->ymax = LV_CHART_YMAX_DEF;
    ext->hdiv_cnt = LV_CHART_HDIV_DEF;
    ext->vdiv_cnt = LV_CHART_VDIV_DEF;
    ext->pnum = LV_CHART_PNUM_DEF;
    ext->type = LV_CHART_TYPE_LINE;
    ext->dl_opa = OPA_COVER;
    ext->dl_dark = OPA_50;
    ext->dl_width = 2 << LV_ANTIALIAS;

    if(ancestor_design_f == NULL) ancestor_design_f = lv_obj_get_design_func(new_chart);

    lv_obj_set_signal_func(new_chart, lv_chart_signal);
    lv_obj_set_design_func(new_chart, lv_chart_design);

    /*Init the new chart background object*/
    if(copy == NULL) {
    	lv_obj_set_style(new_chart, &lv_style_pretty);
    	lv_obj_set_size(new_chart, LV_HOR_RES / 2, LV_VER_RES / 2);
    } else {
    	lv_chart_ext_t * ext_copy = lv_obj_get_ext_attr(copy);
        ext->type = ext_copy->type;
		ext->ymin = ext_copy->ymin;
		ext->ymax = ext_copy->ymax;
		ext->hdiv_cnt = ext_copy->hdiv_cnt;
		ext->vdiv_cnt = ext_copy->vdiv_cnt;
        ext->pnum = ext_copy->pnum;
        ext->dl_opa =  ext_copy->dl_opa;

        /*Refresh the style with new signal function*/
        lv_obj_refresh_style(new_chart);
    }

    return new_chart;
}

/**
 * Signal function of the chart background
 * @param chart pointer to a chart background object
 * @param sign a signal type from lv_signal_t enum
 * @param param pointer to a signal specific variable
 */
bool lv_chart_signal(lv_obj_t * chart, lv_signal_t sign, void * param)
{
    bool valid;

    /* Include the ancient signal function */
    valid = lv_obj_signal(chart, sign, param);

    /* The object can be deleted so check its validity and then
     * make the object specific signal handling */
    if(valid != false) {
    	cord_t ** datal;
    	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    	if(sign == LV_SIGNAL_CLEANUP) {
            LL_READ(ext->dl_ll, datal) {
                dm_free(*datal);
            }
            ll_clear(&ext->dl_ll);
    	}
    }

    return valid;
}

/**
 * Allocate and add a data line to the chart
 * @param chart pointer to a chart object
 * @param color color of the data line
 * @return pointer to the allocated data line (
 */
lv_chart_dl_t * lv_chart_add_data_line(lv_obj_t * chart, color_t color)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	lv_chart_dl_t * dl = ll_ins_head(&ext->dl_ll);
	cord_t def = (ext->ymin + ext->ymax) >> 1;	/*half range as default value*/

	if(dl == NULL) return NULL;

    dl->color = color;

	dl->points = dm_alloc(sizeof(cord_t) * ext->pnum);

	uint16_t i;
	cord_t * p_tmp = dl->points;
	for(i = 0; i < ext->pnum; i++) {
		*p_tmp = def;
		p_tmp++;
	}

	ext->dl_num++;

	return dl;
}

/**
 * Refresh a chart if its data line has changed
 * @param chart pointer to chart object
 */
void lv_chart_refresh(lv_obj_t * chart)
{
	lv_obj_invalidate(chart);
}
/*=====================
 * Setter functions
 *====================*/

/**
 * Set the number of horizontal and vertical division lines
 * @param chart pointer to a graph background object
 * @param hdiv number of horizontal division lines
 * @param vdiv number of vertical division lines
 */
void lv_chart_set_div_line_count(lv_obj_t * chart, uint8_t hdiv, uint8_t vdiv)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);

	ext->hdiv_cnt = hdiv;
	ext->vdiv_cnt = vdiv;

	lv_obj_invalidate(chart);
}

/**
 * Set the minimal and maximal x and y values
 * @param chart pointer to a graph background object
 * @param xmin x minimum value
 * @param xmax x maximum value
 * @param ymin y minimum value
 * @param ymax y maximum value
 */
void lv_chart_set_range(lv_obj_t * chart, cord_t ymin, cord_t ymax)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);

	ext->ymin = ymin;
	ext->ymax = ymax;

	lv_chart_refresh(chart);
}

/**
 * Set a new type for a chart
 * @param chart pointer to a chart object
 * @param type new type of the chart (from 'lv_chart_type_t' enum)
 */
void lv_chart_set_type(lv_obj_t * chart, lv_chart_type_t type)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	ext->type = type;

	lv_chart_refresh(chart);
}

/**
 * Set the number of points on a data line on a chart
 * @param chart pointer r to chart object
 * @param pnum new number of points on the data lines
 */
void lv_chart_set_pnum(lv_obj_t * chart, uint16_t pnum)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	lv_chart_dl_t * dl;
	uint16_t pnum_old = ext->pnum;
	uint16_t i;
    cord_t def = (ext->ymin + ext->ymax) >> 1;  /*half range as default value*/

	if(pnum < 1) pnum = 1;

	LL_READ_BACK(ext->dl_ll, dl) {
		dl->points = dm_realloc(dl->points, sizeof(cord_t) * pnum);

		/*Initialize the new points*/
		if(pnum > pnum_old) {
		    for(i = pnum_old - 1; i < pnum; i++) {
		        dl->points[i] = def;
		    }
		}
	}

	ext->pnum = pnum;
	lv_chart_refresh(chart);
}

/**
 * Set the opacity of the data lines
 * @param chart pointer to chart object
 * @param opa opacity of the data lines
 */
void lv_chart_set_dl_opa(lv_obj_t * chart, opa_t opa)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    ext->dl_opa = opa;
    lv_obj_invalidate(chart);
}

/**
 * Set the line width or point radius of the data lines
 * @param chart pointer to chart object
 * @param width the new width
 */
void lv_chart_set_dl_width(lv_obj_t * chart, cord_t width)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    ext->dl_width = width;
    lv_obj_invalidate(chart);
}
/**
 * Set the dark effect on the bottom of the points or columns
 * @param chart pointer to chart object
 * @param dark_eff dark effect level (OPA_TRANSP to turn off)
 */
void lv_chart_set_dl_dark(lv_obj_t * chart, opa_t dark_eff)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    ext->dl_dark = dark_eff;
}
/**
 * Shift all data right and set the most right data on a data line
 * @param chart pointer to chart object
 * @param dl pointer to a data line on 'chart'
 * @param y the new value of the most right data
 */
void lv_chart_set_next(lv_obj_t * chart, lv_chart_dl_t * dl, cord_t y)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);

	uint16_t i;
	for(i = 0; i < ext->pnum - 1; i++) {
		dl->points[i] = dl->points[i + 1];
	}

	dl->points[ext->pnum - 1] = y;
	lv_chart_refresh(chart);

}


/*=====================
 * Getter functions
 *====================*/

/**
 * Get the type of a chart
 * @param chart pointer to chart object
 * @return type of the chart (from 'lv_chart_t' enum)
 */
lv_chart_type_t lv_chart_get_type(lv_obj_t * chart)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);

    return ext->type;
}

/**
 * Get the data point number per data line on chart
 * @param chart pointer to chart object
 * @return point number on each data line
 */
uint16_t lv_chart_get_pnum(lv_obj_t * chart)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);

    return ext->pnum;
}

/**
 * Get the opacity of the data lines
 * @param chart pointer to chart object
 * @return the opacity of the data lines
 */
opa_t lv_chart_get_dl_opa(lv_obj_t * chart)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    return ext->dl_opa;
}

/**
 * Get the data line width
 * @param chart pointer to chart object
 * @return the width the data lines (lines or points)
 */
cord_t lv_chart_get_dl_width(lv_obj_t * chart)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    return ext->dl_width;
}

/**
 * Get the dark effect level on the bottom of the points or columns
 * @param chart pointer to chart object
 * @return dark effect level (OPA_TRANSP to turn off)
 */
opa_t lv_chart_get_dl_dark(lv_obj_t * chart, opa_t dark_eff)
{
    lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
    return ext->dl_dark;
}
/**********************
 *   STATIC FUNCTIONS
 **********************/


/**
 * Handle the drawing related tasks of the chart backgrounds
 * @param chart pointer to an object
 * @param mask the object will be drawn only in this area
 * @param mode LV_DESIGN_COVER_CHK: only check if the object fully covers the 'mask_p' area
 *                                  (return 'true' if yes)
 *             LV_DESIGN_DRAW: draw the object (always return 'true')
 *             LV_DESIGN_DRAW_POST: drawing after every children are drawn
 * @param return true/false, depends on 'mode'
 */
static bool lv_chart_design(lv_obj_t * chart, const area_t * mask, lv_design_mode_t mode)
{
    if(mode == LV_DESIGN_COVER_CHK) {
    	/*Return false if the object is not covers the mask_p area*/
    	return ancestor_design_f(chart, mask, mode);
    } else if(mode == LV_DESIGN_DRAW_MAIN) {
		/*Draw the background*/
        lv_draw_rect(&chart->coords, mask, lv_obj_get_style(chart));

		lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);

		lv_chart_draw_div(chart, mask);

		if(ext->type & LV_CHART_TYPE_LINE) lv_chart_draw_lines(chart, mask);
		if(ext->type & LV_CHART_TYPE_COLUMN) lv_chart_draw_cols(chart, mask);
		if(ext->type & LV_CHART_TYPE_POINT) lv_chart_draw_points(chart, mask);
    }
    return true;
}

/**
 * Draw the division lines on chart background
 * @param chart pointer to chart object
 * @param mask mask, inherited from the design function
 */
static void lv_chart_draw_div(lv_obj_t * chart, const area_t * mask)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	lv_style_t * style = lv_obj_get_style(chart);

	uint8_t div_i;
    uint8_t div_i_end;
    uint8_t div_i_start;
	point_t p1;
	point_t p2;
	cord_t w = lv_obj_get_width(chart);
	cord_t h = lv_obj_get_height(chart);
	cord_t x_ofs = chart->coords.x1;
	cord_t y_ofs = chart->coords.y1;

	if(ext->hdiv_cnt != 0) {
        /*Draw slide lines if no border*/
        if(style->body.border.width != 0) {
            div_i_start = 1;
            div_i_end = ext->hdiv_cnt;
        } else {
            div_i_start = 0;
            div_i_end = ext->hdiv_cnt + 1;
        }

        p1.x = 0 + x_ofs;
        p2.x = w + x_ofs;
        for(div_i = div_i_start; div_i <= div_i_end; div_i++) {
            p1.y = (int32_t)((int32_t)h * div_i) / (ext->hdiv_cnt + 1);
            p1.y +=  y_ofs;
            if(div_i == div_i_start) p1.y += (style->line.width >> 1) + 1;  /*The first line might not be visible*/
            if(div_i == div_i_end) p1.y -= (style->line.width >> 1) + 1;  /*The last line might not be visible*/

            p2.y = p1.y;
            lv_draw_line(&p1, &p2, mask, style);
        }
	}

	if(ext->vdiv_cnt != 0) {
        /*Draw slide lines if no border*/
        if(style->body.border.width != 0) {
            div_i_start = 1;
            div_i_end = ext->vdiv_cnt;
        } else {
            div_i_start = 0;
            div_i_end = ext->vdiv_cnt + 1;
        }

        p1.y = 0 + y_ofs;
        p2.y = h + y_ofs;
        for(div_i = div_i_start; div_i <= div_i_end; div_i ++) {
            p1.x = (int32_t)((int32_t)w * div_i) / (ext->vdiv_cnt + 1);
            p1.x +=  x_ofs;
            if(div_i == div_i_start) p1.x += (style->line.width >> 1) + 1;  /*The first line might not be visible*/
            if(div_i == div_i_end) p1.x -= (style->line.width >> 1) + 1;  /*The last line might not be visible*/
            p2.x = p1.x;
            lv_draw_line(&p1, &p2, mask, style);
        }
	}
}

/**
 * Draw the data lines as lines on a chart
 * @param obj pointer to chart object
 */
static void lv_chart_draw_lines(lv_obj_t * chart, const area_t * mask)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	lv_style_t * style = lv_obj_get_style(chart);

	uint8_t i;
	point_t p1;
	point_t p2;
	cord_t w = lv_obj_get_width(chart);
	cord_t h = lv_obj_get_height(chart);
    cord_t x_ofs = chart->coords.x1;
    cord_t y_ofs = chart->coords.y1;
	int32_t y_tmp;
	lv_chart_dl_t * dl;
	lv_style_t lines;
	lv_style_copy(&lines, &lv_style_plain);
	lines.body.opa = (uint16_t)((uint16_t)style->body.opa * ext->dl_opa) >> 8;
    lines.line.width = ext->dl_width;

	/*Go through all data lines*/
	LL_READ_BACK(ext->dl_ll, dl) {
		lines.line.color = dl->color;

		p1.x = 0 + x_ofs;
		p2.x = 0 + x_ofs;
		y_tmp = (int32_t)((int32_t) dl->points[0] - ext->ymin) * h;
		y_tmp = y_tmp / (ext->ymax - ext->ymin);
		p2.y = h - y_tmp + y_ofs;

		for(i = 1; i < ext->pnum; i ++) {
			p1.x = p2.x;
			p1.y = p2.y;

			p2.x = ((w * i) / (ext->pnum - 1)) + x_ofs;

			y_tmp = (int32_t)((int32_t) dl->points[i] - ext->ymin) * h;
			y_tmp = y_tmp / (ext->ymax - ext->ymin);
			p2.y = h - y_tmp + y_ofs;

			lv_draw_line(&p1, &p2, mask, &lines);
		}
	}
}

/**
 * Draw the data lines as points on a chart
 * @param chart pointer to chart object
 * @param mask mask, inherited from the design function
 */
static void lv_chart_draw_points(lv_obj_t * chart, const area_t * mask)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	lv_style_t * style = lv_obj_get_style(chart);

	uint8_t i;
	area_t cir_a;
	cord_t w = lv_obj_get_width(chart);
	cord_t h = lv_obj_get_height(chart);
    cord_t x_ofs = chart->coords.x1;
    cord_t y_ofs = chart->coords.y1;
	int32_t y_tmp;
    lv_chart_dl_t * dl;
    uint8_t dl_cnt = 0;
    lv_style_t style_point;
    lv_style_copy(&style_point, &lv_style_plain);

	style_point.body.border.width = 0;
	style_point.body.empty = 0;
	style_point.body.radius = LV_RADIUS_CIRCLE;
    style_point.body.opa = (uint16_t)((uint16_t)style->body.opa * ext->dl_opa) >> 8;
    style_point.body.radius = ext->dl_width;

	/*Go through all data lines*/
	LL_READ_BACK(ext->dl_ll, dl) {
		style_point.body.color_main = dl->color;
		style_point.body.color_gradient = color_mix(COLOR_BLACK, dl->color, ext->dl_dark);

		for(i = 0; i < ext->pnum; i ++) {
			cir_a.x1 = ((w * i) / (ext->pnum - 1)) + x_ofs;
			cir_a.x2 = cir_a.x1 + style_point.body.radius;
			cir_a.x1 -= style_point.body.radius;

			y_tmp = (int32_t)((int32_t) dl->points[i] - ext->ymin) * h;
			y_tmp = y_tmp / (ext->ymax - ext->ymin);
			cir_a.y1 = h - y_tmp + y_ofs;
			cir_a.y2 = cir_a.y1 + style_point.body.radius;
			cir_a.y1 -= style_point.body.radius;

			lv_draw_rect(&cir_a, mask, &style_point);
		}
		dl_cnt++;
	}
}

/**
 * Draw the data lines as columns on a chart
 * @param chart pointer to chart object
 * @param mask mask, inherited from the design function
 */
static void lv_chart_draw_cols(lv_obj_t * chart, const area_t * mask)
{
	lv_chart_ext_t * ext = lv_obj_get_ext_attr(chart);
	lv_style_t * style = lv_obj_get_style(chart);

	uint8_t i;
	area_t col_a;
	area_t col_mask;
	bool mask_ret;
	cord_t w = lv_obj_get_width(chart);
	cord_t h = lv_obj_get_height(chart);
	int32_t y_tmp;
    lv_chart_dl_t * dl;
    lv_style_t rects;
	cord_t col_w = w / ((ext->dl_num + 1) * ext->pnum); /* Suppose + 1 dl as separator*/
	cord_t x_ofs = col_w / 2; /*Shift with a half col.*/

	lv_style_copy(&rects, &lv_style_plain);
	rects.body.border.width = 0;
	rects.body.empty = 0;
	rects.body.radius = 0;
	rects.body.opa = (uint16_t)((uint16_t)style->body.opa * ext->dl_opa) >> 8;

	col_a.y2 = chart->coords.y2;

	cord_t x_act;

	/*Go through all points*/
    for(i = 0; i < ext->pnum; i ++) {
        x_act = (int32_t)((int32_t) w * i) / ext->pnum;
        x_act += chart->coords.x1 + x_ofs;

        /*Draw the current point of all data line*/
        LL_READ_BACK(ext->dl_ll, dl) {
            rects.body.color_main = dl->color;
            rects.body.color_gradient = color_mix(COLOR_BLACK, dl->color, ext->dl_dark);
            col_a.x1 = x_act;
            col_a.x2 = col_a.x1 + col_w;
            x_act += col_w;

            y_tmp = (int32_t)((int32_t) dl->points[i] - ext->ymin) * h;
            y_tmp = y_tmp / (ext->ymax - ext->ymin);
            col_a.y1 = h - y_tmp + chart->coords.y1;

            mask_ret = area_union(&col_mask, mask, &col_a);
            if(mask_ret != false) {
                lv_draw_rect(&chart->coords, &col_mask, &rects);
            }
        }
	}
}
#endif