lv_arc.h

Go to the documentation of this file.

 
#ifndef LV_ARC_H
#define LV_ARC_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_ARC != 0
 
#include "../core/lv_obj.h"
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
enum {
    LV_ARC_MODE_NORMAL,
    LV_ARC_MODE_SYMMETRICAL,
    LV_ARC_MODE_REVERSE
};
typedef uint8_t lv_arc_mode_t;
 
typedef struct {
    lv_obj_t obj;
    uint16_t rotation;
    uint16_t indic_angle_start;
    uint16_t indic_angle_end;
    uint16_t bg_angle_start;
    uint16_t bg_angle_end;
    int16_t value;              /*Current value of the arc*/
    int16_t min_value;          /*Minimum value of the arc*/
    int16_t max_value;          /*Maximum value of the arc*/
    uint16_t dragging    : 1;
    uint16_t type        : 2;
    uint16_t min_close   : 1;   /*1: the last pressed angle was closer to minimum end*/
    uint16_t chg_rate;          /*Drag angle rate of change of the arc (degrees/sec)*/
    uint32_t last_tick;         /*Last dragging event timestamp of the arc*/
    int16_t last_angle;         /*Last dragging angle of the arc*/
} lv_arc_t;
 
extern const lv_obj_class_t lv_arc_class;
 
typedef enum {
    LV_ARC_DRAW_PART_BACKGROUND,    
    LV_ARC_DRAW_PART_FOREGROUND,    
    LV_ARC_DRAW_PART_KNOB,          
} lv_arc_draw_part_type_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_arc_create(lv_obj_t * parent);
 
/*======================
 * Add/remove functions
 *=====================*/
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_arc_set_start_angle(lv_obj_t * obj, uint16_t start);
 
void lv_arc_set_end_angle(lv_obj_t * obj, uint16_t end);
 
void lv_arc_set_angles(lv_obj_t * obj, uint16_t start, uint16_t end);
 
void lv_arc_set_bg_start_angle(lv_obj_t * obj, uint16_t start);
 
void lv_arc_set_bg_end_angle(lv_obj_t * obj, uint16_t end);
 
void lv_arc_set_bg_angles(lv_obj_t * obj, uint16_t start, uint16_t end);
 
void lv_arc_set_rotation(lv_obj_t * obj, uint16_t rotation);
 
void lv_arc_set_mode(lv_obj_t * obj, lv_arc_mode_t type);
 
void lv_arc_set_value(lv_obj_t * obj, int16_t value);
 
void lv_arc_set_range(lv_obj_t * obj, int16_t min, int16_t max);
 
void lv_arc_set_change_rate(lv_obj_t * obj, uint16_t rate);
 
/*=====================
 * Getter functions
 *====================*/
 
uint16_t lv_arc_get_angle_start(lv_obj_t * obj);
 
uint16_t lv_arc_get_angle_end(lv_obj_t * obj);
 
uint16_t lv_arc_get_bg_angle_start(lv_obj_t * obj);
 
uint16_t lv_arc_get_bg_angle_end(lv_obj_t * obj);
 
int16_t lv_arc_get_value(const lv_obj_t * obj);
 
int16_t lv_arc_get_min_value(const lv_obj_t * obj);
 
int16_t lv_arc_get_max_value(const lv_obj_t * obj);
 
lv_arc_mode_t lv_arc_get_mode(const lv_obj_t * obj);
 
/*=====================
 * Other functions
 *====================*/
 
void lv_arc_align_obj_to_angle(const lv_obj_t * obj, lv_obj_t * obj_to_align, lv_coord_t r_offset);
 
void lv_arc_rotate_obj_to_angle(const lv_obj_t * obj, lv_obj_t * obj_to_rotate, lv_coord_t r_offset);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_ARC*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_ARC_H*/