345 lines
9.6 KiB
Lua
345 lines
9.6 KiB
Lua
---------------------------------------------------------------------------
|
|
--
|
|
-- A circular chart (arc chart).
|
|
--
|
|
-- It can contain a central widget (or not) and display multiple values.
|
|
--
|
|
--@DOC_wibox_container_defaults_arcchart_EXAMPLE@
|
|
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
|
|
-- @copyright 2013 Emmanuel Lepage Vallee
|
|
-- @classmod wibox.container.arcchart
|
|
---------------------------------------------------------------------------
|
|
|
|
local setmetatable = setmetatable
|
|
local base = require("wibox.widget.base")
|
|
local shape = require("gears.shape" )
|
|
local util = require( "awful.util" )
|
|
local color = require( "gears.color" )
|
|
local beautiful = require("beautiful" )
|
|
|
|
|
|
local arcchart = { mt = {} }
|
|
|
|
--- The progressbar border background color.
|
|
-- @beautiful beautiful.arcchart_border_color
|
|
|
|
--- The progressbar foreground color.
|
|
-- @beautiful beautiful.arcchart_color
|
|
|
|
--- The progressbar border width.
|
|
-- @beautiful beautiful.arcchart_border_width
|
|
|
|
--- The padding between the outline and the progressbar.
|
|
-- @beautiful beautiful.arcchart_paddings
|
|
-- @tparam[opt=0] table|number paddings A number or a table
|
|
-- @tparam[opt=0] number paddings.top
|
|
-- @tparam[opt=0] number paddings.bottom
|
|
-- @tparam[opt=0] number paddings.left
|
|
-- @tparam[opt=0] number paddings.right
|
|
|
|
--- The arc thickness.
|
|
-- @beautiful beautiful.thickness
|
|
-- @param number
|
|
|
|
local function outline_workarea(width, height)
|
|
local x, y = 0, 0
|
|
local size = math.min(width, height)
|
|
|
|
return {x=x+(width-size)/2, y=y+(height-size)/2, width=size, height=size}
|
|
end
|
|
|
|
-- The child widget area
|
|
local function content_workarea(self, width, height)
|
|
local padding = self._private.paddings or {}
|
|
local border_width = self:get_border_width() or 0
|
|
local wa = outline_workarea(width, height)
|
|
local thickness = math.max(border_width, self:get_thickness() or 5)
|
|
|
|
wa.x = wa.x + (padding.left or 0) + thickness + 2*border_width
|
|
wa.y = wa.y + (padding.top or 0) + thickness + 2*border_width
|
|
wa.width = wa.width - (padding.left or 0) - (padding.right or 0)
|
|
- 2*thickness - 4*border_width
|
|
wa.height = wa.height - (padding.top or 0) - (padding.bottom or 0)
|
|
- 2*thickness - 4*border_width
|
|
|
|
return wa
|
|
end
|
|
|
|
-- Draw the radial outline and progress
|
|
function arcchart:after_draw_children(_, cr, width, height)
|
|
cr:restore()
|
|
|
|
local values = self:get_values() or {}
|
|
local border_width = self:get_border_width() or 0
|
|
local thickness = math.max(border_width, self:get_thickness() or 5)
|
|
|
|
local offset = thickness + 2*border_width
|
|
|
|
-- Draw a circular background
|
|
local bg = self:get_bg()
|
|
if bg then
|
|
cr:save()
|
|
cr:translate(offset/2, offset/2)
|
|
shape.circle(
|
|
cr,
|
|
width-offset,
|
|
height-offset
|
|
)
|
|
cr:set_line_width(thickness+2*border_width)
|
|
cr:set_source(color(bg))
|
|
cr:stroke()
|
|
cr:restore()
|
|
end
|
|
|
|
if #values == 0 then
|
|
return
|
|
end
|
|
|
|
local wa = outline_workarea(width, height)
|
|
cr:translate(wa.x+border_width/2, wa.y+border_width/2)
|
|
|
|
|
|
-- Get the min and max value
|
|
--local min_val = self:get_min_value() or 0 --TODO support min_values
|
|
local max_val = self:get_max_value()
|
|
local sum = 0
|
|
|
|
if not max_val then
|
|
for _, v in ipairs(values) do
|
|
sum = sum + v
|
|
end
|
|
max_val = sum
|
|
end
|
|
|
|
max_val = math.max(max_val, sum)
|
|
|
|
local use_rounded_edges = sum ~= max_val and self:get_rounded_edge()
|
|
|
|
-- Fallback to the current foreground color
|
|
local colors = self:get_colors() or {}
|
|
|
|
-- Draw the outline
|
|
local offset_angle = self:get_start_angle() or math.pi
|
|
local start_angle, end_angle = offset_angle, offset_angle
|
|
|
|
for k, v in ipairs(values) do
|
|
end_angle = start_angle + (v*2*math.pi) / max_val
|
|
|
|
if colors[k] then
|
|
cr:set_source(color(colors[k]))
|
|
end
|
|
|
|
shape.arc(cr, wa.width-border_width, wa.height-border_width,
|
|
thickness+border_width, math.pi-end_angle, math.pi-start_angle,
|
|
(use_rounded_edges and k == 1), (use_rounded_edges and k == #values)
|
|
)
|
|
|
|
cr:fill()
|
|
start_angle = end_angle
|
|
end
|
|
|
|
if border_width > 0 then
|
|
local border_color = self:get_border_color()
|
|
|
|
cr:set_source(color(border_color))
|
|
cr:set_line_width(border_width)
|
|
|
|
shape.arc(cr, wa.width-border_width, wa.height-border_width,
|
|
thickness+border_width, math.pi-end_angle, math.pi-offset_angle,
|
|
use_rounded_edges, use_rounded_edges
|
|
)
|
|
cr:stroke()
|
|
end
|
|
|
|
end
|
|
|
|
-- Set the clip
|
|
function arcchart:before_draw_children(_, cr, width, height)
|
|
cr:save()
|
|
local wa = content_workarea(self, width, height)
|
|
cr:translate(wa.x, wa.y)
|
|
shape.circle(
|
|
cr,
|
|
wa.width,
|
|
wa.height
|
|
)
|
|
cr:clip()
|
|
cr:translate(-wa.x, -wa.y)
|
|
end
|
|
|
|
-- Layout this layout
|
|
function arcchart:layout(_, width, height)
|
|
if self._private.widget then
|
|
local wa = content_workarea(self, width, height)
|
|
|
|
return { base.place_widget_at(
|
|
self._private.widget, wa.x, wa.y, wa.width, wa.height
|
|
) }
|
|
end
|
|
end
|
|
|
|
-- Fit this layout into the given area
|
|
function arcchart:fit(_, width, height)
|
|
local size = math.min(width, height)
|
|
return size, size
|
|
end
|
|
|
|
--- The widget to wrap in a radial proggressbar.
|
|
-- @property widget
|
|
-- @tparam widget widget The widget
|
|
|
|
function arcchart:set_widget(widget)
|
|
if widget then
|
|
base.check_widget(widget)
|
|
end
|
|
self._private.widget = widget
|
|
self:emit_signal("widget::layout_changed")
|
|
end
|
|
|
|
--- Get the children elements.
|
|
-- @treturn table The children
|
|
function arcchart:get_children()
|
|
return {self._private.widget}
|
|
end
|
|
|
|
--- Replace the layout children
|
|
-- This layout only accept one children, all others will be ignored
|
|
-- @tparam table children A table composed of valid widgets
|
|
function arcchart:set_children(children)
|
|
self._private.widget = children and children[1]
|
|
self:emit_signal("widget::layout_changed")
|
|
end
|
|
|
|
--- Reset this layout. The widget will be removed and the rotation reset.
|
|
function arcchart:reset()
|
|
self:set_widget(nil)
|
|
end
|
|
|
|
for _,v in ipairs {"left", "right", "top", "bottom"} do
|
|
arcchart["set_"..v.."_padding"] = function(self, val)
|
|
self._private.paddings = self._private.paddings or {}
|
|
self._private.paddings[v] = val
|
|
self:emit_signal("widget::redraw_needed")
|
|
self:emit_signal("widget::layout_changed")
|
|
end
|
|
end
|
|
|
|
--- The padding between the outline and the progressbar.
|
|
--@DOC_wibox_container_arcchart_paddings_EXAMPLE@
|
|
-- @property paddings
|
|
-- @tparam[opt=0] table|number paddings A number or a table
|
|
-- @tparam[opt=0] number paddings.top
|
|
-- @tparam[opt=0] number paddings.bottom
|
|
-- @tparam[opt=0] number paddings.left
|
|
-- @tparam[opt=0] number paddings.right
|
|
|
|
--- The border background color.
|
|
--@DOC_wibox_container_arcchart_border_color_EXAMPLE@
|
|
-- @property border_color
|
|
|
|
--- The border foreground color.
|
|
--@DOC_wibox_container_arcchart_color_EXAMPLE@
|
|
-- @property color
|
|
|
|
--- The border width.
|
|
--@DOC_wibox_container_arcchart_border_width_EXAMPLE@
|
|
-- @property border_width
|
|
-- @tparam[opt=3] number border_width
|
|
|
|
--- The minimum value.
|
|
-- @property min_value
|
|
|
|
--- The maximum value.
|
|
-- @property max_value
|
|
|
|
--- The radial background.
|
|
--@DOC_wibox_container_arcchart_bg_EXAMPLE@
|
|
-- @property bg
|
|
-- @param color
|
|
-- @see gears.color
|
|
|
|
--- The value.
|
|
--@DOC_wibox_container_arcchart_value_EXAMPLE@
|
|
-- @property value
|
|
-- @tparam number value Between min_value and max_value
|
|
-- @see values
|
|
|
|
--- The values.
|
|
-- The arcchart is designed to display multiple values at once. Each will be
|
|
-- shown in table order.
|
|
--@DOC_wibox_container_arcchart_values_EXAMPLE@
|
|
-- @property values
|
|
-- @tparam table values An ordered set if values.
|
|
-- @see value
|
|
|
|
--- If the chart has rounded edges.
|
|
--@DOC_wibox_container_arcchart_rounded_edge_EXAMPLE@
|
|
-- @property rounded_edge
|
|
-- @param[opt=false] boolean
|
|
|
|
--- The arc thickness.
|
|
--@DOC_wibox_container_arcchart_thickness_EXAMPLE@
|
|
-- @property thickness
|
|
-- @param number
|
|
|
|
--- The (radiant) angle where the first value start.
|
|
--@DOC_wibox_container_arcchart_start_angle_EXAMPLE@
|
|
-- @property start_angle
|
|
-- @param[opt=math.pi] number A number between 0 and 2*math.pi
|
|
|
|
for _, prop in ipairs {"border_width", "border_color", "paddings", "colors",
|
|
"rounded_edge", "bg", "thickness", "values", "min_value", "max_value",
|
|
"start_angle" } do
|
|
arcchart["set_"..prop] = function(self, value)
|
|
self._private[prop] = value
|
|
self:emit_signal("property::"..prop)
|
|
self:emit_signal("widget::redraw_needed")
|
|
end
|
|
arcchart["get_"..prop] = function(self)
|
|
return self._private[prop] or beautiful["arcchart_"..prop]
|
|
end
|
|
end
|
|
|
|
function arcchart:set_paddings(val)
|
|
self._private.paddings = type(val) == "number" and {
|
|
left = val,
|
|
right = val,
|
|
top = val,
|
|
bottom = val,
|
|
} or val or {}
|
|
self:emit_signal("property::paddings")
|
|
self:emit_signal("widget::redraw_needed")
|
|
self:emit_signal("widget::layout_changed")
|
|
end
|
|
|
|
function arcchart:set_value(value)
|
|
self:set_values {value}
|
|
end
|
|
|
|
--- Returns a new arcchart layout.
|
|
-- @param[opt] widget The widget to display.
|
|
-- @function wibox.container.arcchart
|
|
local function new(widget)
|
|
local ret = base.make_widget(nil, nil, {
|
|
enable_properties = true,
|
|
})
|
|
|
|
util.table.crush(ret, arcchart)
|
|
|
|
ret:set_widget(widget)
|
|
|
|
return ret
|
|
end
|
|
|
|
function arcchart.mt:__call(...)
|
|
return new(...)
|
|
end
|
|
|
|
--@DOC_widget_COMMON@
|
|
|
|
--@DOC_object_COMMON@
|
|
|
|
return setmetatable(arcchart, arcchart.mt)
|
|
|
|
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|