source/modules/juce_gui_basics/mouse/juce_MouseInactivityDetector.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  11    Agreement and JUCE Privacy Policy.
  12
  13    End User License Agreement: www.juce.com/juce-7-licence
  14    Privacy Policy: www.juce.com/juce-privacy-policy
  15
  16    Or: You may also use this code under the terms of the GPL v3 (see
  17    www.gnu.org/licenses).
  18
  19    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  20    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  21    DISCLAIMED.
  22
  23   ==============================================================================
  24 */
  25
  26 namespace juce
  27 {
  28
  29 MouseInactivityDetector::MouseInactivityDetector (Component& c)  : targetComp (c)
  30 {
  31     targetComp.addMouseListener (this, true);
  32 }
  33
  34 MouseInactivityDetector::~MouseInactivityDetector()
  35 {
  36     targetComp.removeMouseListener (this);
  37 }
  38
  39 void MouseInactivityDetector::setDelay (int newDelay) noexcept                  { delayMs = newDelay; }
  40 void MouseInactivityDetector::setMouseMoveTolerance (int newDistance) noexcept  { toleranceDistance = newDistance; }
  41
  42 void MouseInactivityDetector::addListener    (Listener* l)   { listenerList.add (l); }
  43 void MouseInactivityDetector::removeListener (Listener* l)   { listenerList.remove (l); }
  44
  45 void MouseInactivityDetector::timerCallback()
  46 {
  47     setActive (false);
  48 }
  49
  50 void MouseInactivityDetector::wakeUp (const MouseEvent& e, bool alwaysWake)
  51 {
  52     auto newPos = e.getEventRelativeTo (&targetComp).getPosition();
  53
  54     if ((! isActive) && (alwaysWake || e.source.isTouch() || newPos.getDistanceFrom (lastMousePos) > toleranceDistance))
  55         setActive (true);
  56
  57     if (lastMousePos != newPos)
  58     {
  59         lastMousePos = newPos;
  60         startTimer (delayMs);
  61     }
  62 }
  63
  64 void MouseInactivityDetector::setActive (bool b)
  65 {
  66     if (isActive != b)
  67     {
  68         isActive = b;
  69
  70         if (isActive)
  71             listenerList.call ([] (Listener& l) { l.mouseBecameActive(); });
  72         else
  73             listenerList.call ([] (Listener& l) { l.mouseBecameInactive(); });
  74     }
  75 }
  76
  77 } // namespace juce