lvgl/lv_objx/lv_slider.c

/**
 * @file lv_slider.c
 * 
 */

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

#include "lv_slider.h"
#include "misc/math/math_base.h"
#include "../lv_draw/lv_draw.h"

/*********************
 *      DEFINES
 *********************/

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

/**********************
 *  STATIC PROTOTYPES
 **********************/
static bool lv_slider_design(lv_obj_t * slider, const area_t * mask, lv_design_mode_t mode);

/**********************
 *  STATIC VARIABLES
 **********************/
static lv_design_f_t ancestor_design_f;

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

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

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

/**
 * Create a slider objects
 * @param par pointer to an object, it will be the parent of the new slider
 * @param copy pointer to a slider object, if not NULL then the new object will be copied from it
 * @return pointer to the created slider
 */
lv_obj_t * lv_slider_create(lv_obj_t * par, lv_obj_t * copy)
{
    /*Create the ancestor slider*/
	/*TODO modify it to the ancestor create function */
    lv_obj_t * new_slider = lv_bar_create(par, copy);
    dm_assert(new_slider);
    
    /*Allocate the slider type specific extended data*/
    lv_slider_ext_t * ext = lv_obj_alloc_ext(new_slider, sizeof(lv_slider_ext_t));
    dm_assert(ext);

    /*Initialize the allocated 'ext' */
    ext->cb = NULL;
    ext->tmp_value = ext->bar.min_value;
    ext->style_knob = lv_style_get(LV_STYLE_PRETTY, NULL);

    /* Save the bar design function.
     * It will be used in the sllider design function*/
    if(ancestor_design_f == NULL) ancestor_design_f = lv_obj_get_design_f(new_slider);

    /*The signal and design functions are not copied so set them here*/
    lv_obj_set_signal_f(new_slider, lv_slider_signal);
    lv_obj_set_design_f(new_slider, lv_slider_design);

    /*Init the new slider slider*/
    if(copy == NULL) {
        lv_obj_set_click(new_slider, true);
        lv_slider_set_style_knob(new_slider, ext->style_knob);
    }
    /*Copy an existing slider*/
    else {
    	lv_slider_ext_t * copy_ext = lv_obj_get_ext(copy);
    	ext->style_knob = copy_ext->style_knob;
        ext->cb = copy_ext->cb;
        /*Refresh the style with new signal function*/
        lv_obj_refr_style(new_slider);
    }
    
    return new_slider;
}

/**
 * Signal function of the slider
 * @param slider pointer to a slider object
 * @param sign a signal type from lv_signal_t enum
 * @param param pointer to a signal specific variable
 * @return true: the object is still valid (not deleted), false: the object become invalid
 */
bool lv_slider_signal(lv_obj_t * slider, lv_signal_t sign, void * param)
{
    bool valid;

    /* Include the ancient signal function */
    /* TODO update it to the ancestor's signal function*/
    valid = lv_bar_signal(slider, sign, param);

    /* The object can be deleted so check its validity and then
     * make the object specific signal handling */
    if(valid != false) {
        lv_slider_ext_t * ext = lv_obj_get_ext(slider);
        point_t p;
        cord_t w = lv_obj_get_width(slider);
        cord_t h = lv_obj_get_height(slider);
        int16_t tmp;

        if(sign == LV_SIGNAL_PRESSED) {
            ext->tmp_value = lv_bar_get_value(slider);
        }
        else if(sign == LV_SIGNAL_PRESSING) {
            lv_dispi_get_point(param, &p);
            if(w > h) {
                p.x -= slider->cords.x1 + h / 2;    /*Modify the point to shift with half knob (important on the start and end)*/
                tmp = (int32_t) ((int32_t) p.x * (ext->bar.max_value - ext->bar.min_value + 1)) / (w - h);
            } else {
                p.y -= slider->cords.y1 + w / 2;    /*Modify the point to shift with half knob (important on the start and end)*/
                tmp = (int32_t) ((int32_t) p.y * (ext->bar.max_value - ext->bar.min_value + 1)) / (h - w);
                tmp = ext->bar.max_value - tmp;     /*Invert he value: small value means higher y*/
            }

            lv_bar_set_value(slider, tmp);
        }
        else if (sign == LV_SIGNAL_PRESS_LOST) {
            lv_bar_set_value(slider, ext->tmp_value);
        }
        else if (sign == LV_SIGNAL_RELEASED) {
            ext->tmp_value = lv_bar_get_value(slider);
            lv_bar_set_value(slider, ext->tmp_value);
            if(ext->cb != NULL) ext->cb(slider, param);
        }
        else if(sign == LV_SIGNAL_CORD_CHG) {
            /* The knob size depends on slider size.
             * During the drawing method the ext. size is used by the knob so refresh the ext. size.*/
            if(lv_obj_get_width(slider) != area_get_width(param) ||
              lv_obj_get_height(slider) != area_get_height(param)) {
                slider->signal_f(slider, LV_SIGNAL_REFR_EXT_SIZE, NULL);
            }
        }
        else if(sign == LV_SIGNAL_REFR_EXT_SIZE) {
            cord_t x = MATH_MIN(w, h);
            if(slider->ext_size < x) slider->ext_size = x;
        }
    }

    return valid;
}

/*=====================
 * Setter functions
 *====================*/

/**
 * Set a function which will be called when a new value is set on the slider
 * @param slider pointer to slider object
 * @param cb a callback function
 */
void lv_slider_set_action(lv_obj_t * slider, lv_action_t cb)
{
    lv_slider_ext_t * ext = lv_obj_get_ext(slider);
    ext->cb = cb;
}

/**
 * Set the style of knob on a slider
 * @param slider pointer to slider object
 * @param style pointer the new knob style
 */
void lv_slider_set_style_knob(lv_obj_t * slider, lv_style_t * style)
{
    lv_slider_ext_t * ext = lv_obj_get_ext(slider);
    ext->style_knob = style;

    slider->signal_f(slider, LV_SIGNAL_REFR_EXT_SIZE, NULL);

    lv_obj_inv(slider);
}


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

/**
 * Get the slider callback function
 * @param slider pointer to slider object
 * @return the callback function
 */
lv_action_t lv_slider_get_action(lv_obj_t * slider)
{
    lv_slider_ext_t * ext = lv_obj_get_ext(slider);
    return ext->cb;
}
/**
 * Get the style of knob on a slider
 * @param slider pointer to slider object
 * @return pointer the new knob style
 */
lv_style_t *  lv_slider_get_style_knob(lv_obj_t * slider)
{
    lv_slider_ext_t * ext = lv_obj_get_ext(slider);
    return ext->style_knob;
}

/**********************
 *   STATIC FUNCTIONS
 **********************/


/**
 * Handle the drawing related tasks of the sliders
 * @param slider 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_slider_design(lv_obj_t * slider, const area_t * mask, lv_design_mode_t mode)
{
    /*Return false if the object is not covers the mask_p area*/
    if(mode == LV_DESIGN_COVER_CHK) {
    	return false;
    }
    /*Draw the object*/
    else if(mode == LV_DESIGN_DRAW_MAIN) {
        lv_style_t * style_slider = lv_obj_get_style(slider);
        lv_style_t * style_knob = lv_slider_get_style_knob(slider);
        lv_style_t * style_indic = lv_bar_get_style_indic(slider);

        area_t area_bar;

        area_cpy(&area_bar, &slider->cords);
        area_bar.x1 += style_knob->hpad;
        area_bar.x2 -= style_knob->hpad;
        area_bar.y1 += style_knob->vpad;
        area_bar.y2 -= style_knob->vpad;
        lv_draw_rect(&area_bar, mask, style_slider);

        area_t area_indic;
        area_cpy(&area_indic, &area_bar);
        area_indic.x1 += style_indic->hpad;
        area_indic.x2 -= style_indic->hpad;
        area_indic.y1 += style_indic->vpad;
        area_indic.y2 -= style_indic->vpad;

        cord_t slider_w = area_get_width(&slider->cords);
        cord_t slider_h = area_get_height(&slider->cords);
        cord_t act_value = lv_bar_get_value(slider);
        cord_t min_value = lv_bar_get_min_value(slider);
        cord_t max_value = lv_bar_get_max_value(slider);

        if(slider_w >= slider_h) {
            area_indic.x2 = (int32_t) ((int32_t)area_get_width(&area_indic) * act_value) / (max_value - min_value);
            area_indic.x2 += area_indic.x1;
        } else {
            area_indic.y1 = (int32_t) ((int32_t)area_get_height(&area_indic) * act_value) / (max_value - min_value);
            area_indic.y1 = area_indic.y2 - area_indic.y1;
        }

        /*Draw the indicator*/
        lv_draw_rect(&area_indic, mask, style_indic);

        area_t knob_area;
        area_cpy(&knob_area, &slider->cords);

        if(slider_w >= slider_h) {
            knob_area.x1 = area_indic.x2 - slider_h / 2;
            knob_area.x2 = knob_area.x1 + slider_h;

            knob_area.y1 = slider->cords.y1;
            knob_area.y2 = slider->cords.y2;
        } else {
            knob_area.y1 = area_indic.y1 - slider_w / 2;
            knob_area.y2 = knob_area.y1 + slider_w;

            knob_area.x1 = slider->cords.x1;
            knob_area.x2 = slider->cords.x2;

        }

        lv_draw_rect(&knob_area, mask, style_knob);

    }
    /*Post draw when the children are drawn*/
    else if(mode == LV_DESIGN_DRAW_POST) {

    }

    return true;
}

#endif