lvgl/lv_objx/lv_arc.c

/**
 * @file lv_arc.c
 * 
 */

/* TODO Remove these instructions
 * Search an replace: arc -> object normal name with lower case (e.g. button, label etc.)
 *                    arc -> object short name with lower case(e.g. btn, label etc)
 *                    ARC -> object short name with upper case (e.g. BTN, LABEL etc.)
 *
 */

/*********************
 *      INCLUDES
 *********************/
#include "lv_arc.h"
#if USE_LV_ARC != 0

#include "../lv_misc/lv_math.h"
#include "../lv_draw/lv_draw_arc.h"


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

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

/**********************
 *  STATIC PROTOTYPES
 **********************/
static bool lv_arc_design(lv_obj_t * arc, const lv_area_t * mask, lv_design_mode_t mode);
static lv_res_t lv_arc_signal(lv_obj_t * arc, lv_signal_t sign, void * param);

/**********************
 *  STATIC VARIABLES
 **********************/
static lv_signal_func_t ancestor_signal;
static lv_design_func_t ancestor_design;

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

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

/**
 * Create a arc object
 * @param par pointer to an object, it will be the parent of the new arc
 * @param copy pointer to a arc object, if not NULL then the new object will be copied from it
 * @return pointer to the created arc
 */
lv_obj_t * lv_arc_create(lv_obj_t * par, lv_obj_t * copy)
{
    /*Create the ancestor of arc*/
    lv_obj_t * new_arc = lv_obj_create(par, copy);
    lv_mem_assert(new_arc);
    
    /*Allocate the arc type specific extended data*/
    lv_arc_ext_t * ext = lv_obj_allocate_ext_attr(new_arc, sizeof(lv_arc_ext_t));
    lv_mem_assert(ext);
    if(ancestor_signal == NULL) ancestor_signal = lv_obj_get_signal_func(new_arc);
    if(ancestor_design == NULL) ancestor_design = lv_obj_get_design_func(new_arc);

    /*Initialize the allocated 'ext' */
    ext->angle_start = 45;
    ext->angle_end = 315;

    /*The signal and design functions are not copied so set them here*/
    lv_obj_set_signal_func(new_arc, lv_arc_signal);
    lv_obj_set_design_func(new_arc, lv_arc_design);

    /*Init the new arc arc*/
    if(copy == NULL) {
    	lv_arc_set_style(new_arc, &lv_style_plain_color);
    }
    /*Copy an existing arc*/
    else {
    	lv_arc_ext_t * copy_ext = lv_obj_get_ext_attr(copy);
    	ext->angle_start = copy_ext->angle_start;
    	ext->angle_end = copy_ext->angle_end;

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

/*======================
 * Add/remove functions
 *=====================*/

/*
 * New object specific "add" or "remove" functions come here
 */


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

/**
 * Set the start and end angles of an arc. 0 deg: bottom, 90 deg: right etc.
 * @param arc pointer to an arc object
 * @param start the start angle [0..360]
 * @param end the end angle [0..360]
 */
void lv_arc_set_angles(lv_obj_t * arc, uint16_t start, uint16_t end)
{
	lv_arc_ext_t * ext = lv_obj_get_ext_attr(arc);

	if(start > 360) start = 360;
	if(end > 360) end = 360;

	ext->angle_start = LV_MATH_MIN(start, end);
	ext->angle_end = LV_MATH_MAX(start, end);

	lv_obj_invalidate(arc);
}

/**
 * Set a style of a arc.
 * @param arc pointer to arc object
 * @param type which style should be set
 * @param style pointer to a style
 *  */
void lv_arc_set_style(lv_obj_t * arc, lv_arc_style_t type, lv_style_t *style)
{
    switch (type) {
        case LV_ARC_STYLE_MAIN:
        	lv_obj_set_style(arc, style);
            break;
    }
}

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

/**
 * Get the start angles of an arc.
 * @param arc pointer to an arc object
 * @return the start angle [0..360]
 */
uint16_t lv_arc_get_angle_start(lv_obj_t * arc, uint16_t start, uint16_t end)
{
	lv_arc_ext_t * ext = lv_obj_get_ext_attr(arc);

	return ext->angle_start;
}

/**
 * Get the end angles of an arc.
 * @param arc pointer to an arc object
 * @return the end angle [0..360]
 */
uint16_t lv_arc_get_angle_end(lv_obj_t * arc, uint16_t start, uint16_t end)
{
	lv_arc_ext_t * ext = lv_obj_get_ext_attr(arc);

	return ext->angle_start;
}

/**
 * Get style of a arc.
 * @param arc pointer to arc object
 * @param type which style should be get
 * @return style pointer to the style
 *  */
lv_style_t * lv_arc_get_style(lv_obj_t * arc, lv_arc_style_t type)
{

    switch (type) {
        case LV_ARC_STYLE_MAIN:     return lv_obj_get_style(arc);
        default: return NULL;
    }

    /*To avoid warning*/
    return NULL;
}

/*=====================
 * Other functions
 *====================*/

/*
 * New object specific "other" functions come here
 */

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

/**
 * Handle the drawing related tasks of the arcs
 * @param arc 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_arc_design(lv_obj_t * arc, const lv_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_arc_ext_t * ext = lv_obj_get_ext_attr(arc);
    	lv_style_t * style = lv_arc_get_style(arc, LV_ARC_STYLE_MAIN);

    	lv_coord_t r = (LV_MATH_MIN(lv_obj_get_width(arc), lv_obj_get_height(arc))) / 2;
    	lv_coord_t x = arc->coords.x1 + lv_obj_get_width(arc) / 2;
    	lv_coord_t y = arc->coords.y1 + lv_obj_get_height(arc) / 2;

    	lv_draw_arc(x, y, r, mask, ext->angle_start, ext->angle_end, style);

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

    }

    return true;
}

/**
 * Signal function of the arc
 * @param arc pointer to a arc object
 * @param sign a signal type from lv_signal_t enum
 * @param param pointer to a signal specific variable
 * @return LV_RES_OK: the object is not deleted in the function; LV_RES_INV: the object is deleted
 */
static lv_res_t lv_arc_signal(lv_obj_t * arc, lv_signal_t sign, void * param)
{
    lv_res_t res;

    /* Include the ancient signal function */
    res = ancestor_signal(arc, sign, param);
    if(res != LV_RES_OK) return res;


    if(sign == LV_SIGNAL_CLEANUP) {
        /*Nothing to cleanup. (No dynamically allocated memory in 'ext')*/
    }
    else if(sign == LV_SIGNAL_GET_TYPE) {
        lv_obj_type_t * buf = param;
        uint8_t i;
        for(i = 0; i < LV_MAX_ANCESTOR_NUM - 1; i++) {  /*Find the last set data*/
            if(buf->type[i] == NULL) break;
        }
        buf->type[i] = "lv_arc";
    }

    return res;
}

#endif