mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 18:37:44 +02:00
130 lines
2.9 KiB
Lua
130 lines
2.9 KiB
Lua
--- Component to handle hover node interaction
|
|
-- @module druid.hover
|
|
|
|
--- Component events
|
|
-- @table Events
|
|
-- @tfield druid_event on_hover On hover callback (Touch pressed)
|
|
-- @tfield druid_event on_mouse_hover On mouse hover callback (Touch over without action_id)
|
|
|
|
local Event = require("druid.event")
|
|
local const = require("druid.const")
|
|
local helper = require("druid.helper")
|
|
local component = require("druid.component")
|
|
|
|
local M = component.create("hover", { const.ON_INPUT })
|
|
|
|
|
|
--- Component init function
|
|
-- @function hover:init
|
|
-- @tparam node node Gui node
|
|
-- @tparam function on_hover_callback Hover callback
|
|
function M.init(self, node, on_hover_callback)
|
|
self.node = self:get_node(node)
|
|
|
|
self._is_hovered = false
|
|
self._is_mouse_hovered = false
|
|
|
|
self._is_enabled = true
|
|
|
|
self.on_hover = Event(on_hover_callback)
|
|
self.on_mouse_hover = Event()
|
|
end
|
|
|
|
|
|
function M.on_input(self, action_id, action)
|
|
if action_id ~= const.ACTION_TOUCH and action_id ~= nil then
|
|
return false
|
|
end
|
|
|
|
if not action_id and helper.is_mobile() then
|
|
return false
|
|
end
|
|
|
|
if not helper.is_enabled(self.node) or not self._is_enabled then
|
|
return false
|
|
end
|
|
|
|
local is_pick = gui.pick_node(self.node, action.x, action.y)
|
|
if self.click_zone then
|
|
is_pick = is_pick and gui.pick_node(self.click_zone, action.x, action.y)
|
|
end
|
|
|
|
local hover_function = action_id and M.set_hover or M.set_mouse_hover
|
|
|
|
if not is_pick then
|
|
hover_function(self, false)
|
|
return false
|
|
end
|
|
|
|
if action.released then
|
|
hover_function(self, false)
|
|
else
|
|
hover_function(self, true)
|
|
end
|
|
end
|
|
|
|
|
|
function M.on_input_interrupt(self)
|
|
self:set_hover(false)
|
|
end
|
|
|
|
|
|
--- Set hover state
|
|
-- @function hover:set_hover
|
|
-- @tparam bool state The hover state
|
|
function M.set_hover(self, state)
|
|
if self._is_hovered ~= state then
|
|
self._is_hovered = state
|
|
self.on_hover:trigger(self:get_context(), state)
|
|
end
|
|
end
|
|
|
|
--- Set mouse hover state
|
|
-- @function hover:set_mouse_hover
|
|
-- @tparam bool state The mouse hover state
|
|
function M.set_mouse_hover(self, state)
|
|
if self._is_mouse_hovered ~= state then
|
|
self._is_mouse_hovered = state
|
|
self.on_mouse_hover:trigger(self:get_context(), state)
|
|
end
|
|
end
|
|
|
|
|
|
--- Strict hover click area. Useful for
|
|
-- no click events outside stencil node
|
|
-- @function hover:set_click_zone
|
|
-- @tparam node zone Gui node
|
|
function M.set_click_zone(self, zone)
|
|
self.click_zone = self:get_node(zone)
|
|
end
|
|
|
|
|
|
--- Set enable state of hover component.
|
|
-- If hover is not enabled, it will not generate
|
|
-- any hover events
|
|
-- @function hover:set_enabled
|
|
-- @tparam bool state The hover enabled state
|
|
function M.set_enabled(self, state)
|
|
self._is_enabled = state
|
|
|
|
if not state then
|
|
if self._is_hovered then
|
|
self:set_hover(false)
|
|
end
|
|
if self._is_mouse_hovered then
|
|
self:set_mouse_hover(false)
|
|
end
|
|
end
|
|
end
|
|
|
|
|
|
--- Return current hover enabled state
|
|
-- @function hover:is_enabled
|
|
-- @treturn bool The hover enabled state
|
|
function M.is_enabled(self)
|
|
return self._is_enabled
|
|
end
|
|
|
|
|
|
return M
|