mouse.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
 
#include "freertos/FreeRTOS.h"
#include "freertos/timers.h"
 
#include "fabglconf.h"
#include "fabutils.h"
#include "comdrivers/ps2device.h"
#include "fabui.h"
 
 
namespace fabgl {
 
 
 
 
struct MouseDelta {
  int16_t      deltaX;             
  int16_t      deltaY;             
  int8_t       deltaZ;             
  MouseButtons buttons;            
  uint8_t      overflowX : 1;      
  uint8_t      overflowY : 1;      
};
 
 
struct MousePacket {
  uint8_t data[4];
};
 
 
enum MouseType {
  LegacyMouse,    
  Intellimouse,   
};
 
 
class Mouse : public PS2Device {
 
public:
 
  Mouse();
 
  ~Mouse();
 
  void begin(gpio_num_t clkGPIO, gpio_num_t dataGPIO);
 
  void begin(int PS2Port);
 
  bool reset();
 
  bool isMouseAvailable() { return m_mouseAvailable; }
 
  int getPacketSize();
 
  bool packetAvailable();
 
  bool getNextPacket(MousePacket * packet, int timeOutMS = -1, bool requestResendOnTimeOut = false);
 
  bool deltaAvailable();
 
  bool getNextDelta(MouseDelta * delta, int timeOutMS = -1, bool requestResendOnTimeOut = false);
 
  bool setSampleRate(int value) { return send_cmdSetSampleRate(value); }
 
  bool setResolution(int value) { return send_cmdSetResolution(value); }
 
  bool setScaling(int value) { return send_cmdSetScaling(value); }
 
  void setupAbsolutePositioner(int width, int height, bool createAbsolutePositionsQueue, BitmappedDisplayController * updateDisplayController = nullptr, uiApp * app = nullptr);
 
  void setUIApp(uiApp * app) { m_uiApp = app; }
 
  void terminateAbsolutePositioner();
 
  void updateAbsolutePosition(MouseDelta * delta);
 
  MouseStatus & status() { return m_status; }
 
  int availableStatus();
 
  MouseStatus getNextStatus(int timeOutMS = -1);
 
  int & movementAcceleration() { return m_movementAcceleration; }
 
  int & wheelAcceleration()    { return m_wheelAcceleration; }
 
  void emptyQueue();
 
 
  static void quickCheckHardware()   { s_quickCheckHardware = true; }
 
 
private:
 
  static void mouseUpdateTask(void * arg);
  bool decodeMousePacket(MousePacket * mousePacket, MouseDelta * delta);
 
  static bool     s_quickCheckHardware;
 
  bool            m_mouseAvailable;
  MouseType       m_mouseType;
 
  TaskHandle_t    m_mouseUpdateTask;
 
  // queue of one mouse packet
  QueueHandle_t   m_receivedPacket;
 
  // absolute position support
  bool            m_absoluteUpdate;
  Size            m_area;
  MouseStatus     m_status;
  MouseStatus     m_prevStatus;
  int64_t         m_prevDeltaTime;
  int             m_movementAcceleration;  // reasonable values: 0...2000
  int             m_wheelAcceleration;     // reasonable values: 0...100000
  QueueHandle_t   m_absoluteQueue;         // a queue of messages generated by updateAbsolutePosition()
  BitmappedDisplayController * m_updateDisplayController;
 
  uiApp *         m_uiApp;
};
 
 
 
} // end of namespace