PointingDevice.h

/* -*- mode: c++ -*-
 *
 * pointing/input/PointingDevice.h --
 *
 * Initial software
 * Authors: Nicolas Roussel
 * Copyright © Inria
 *
 * http://libpointing.org/
 *
 * This software may be used and distributed according to the terms of
 * the GNU General Public License version 2 or any later version.
 *
 */

#ifndef PointingDevice_h
#define PointingDevice_h

#include <pointing/utils/URI.h>
#include <pointing/utils/TimeStamp.h>
#include <pointing/utils/FrequencyEstimator.h>

#include <string>
#include <iostream>

#include <stdint.h>
#include <cstring>

namespace pointing {

  class PointingDevice {

  protected:

    PointingDevice(void) ;

    FrequencyEstimator freqEstim;

    void registerTimestamp(TimeStamp::inttime timestamp, int dx, int dy);

    double estimatedUpdateFrequency() const;

  public:

    //double estimatedUpdateFrequency() const;

    enum {BUTTON_1=1, 
          BUTTON_2=2, 
          BUTTON_3=4   } ;

    typedef void (*PointingCallback)(void *context, 
                     TimeStamp::inttime timestamp, 
                     int dx, int dy, 
                     int buttons) ;

    static PointingDevice *create(const char *device_uri=0) ;
    static PointingDevice *create(std::string device_uri) ;

    static void idle(int milliseconds) ;

    virtual bool isActive(void) const { return true ; }

    virtual int getVendorID(void) const { return 0 ; }

    virtual std::string getVendor(void) const { return "???" ; }

    virtual int getProductID(void) const { return 0 ; }

    virtual std::string getProduct(void) const { return "???" ; }

    virtual double getResolution(double *defval=0) const = 0 ;

    virtual double getUpdateFrequency(double *defval=0) const = 0 ;

    virtual URI getURI(bool expanded=false, bool crossplatform=false) const = 0 ;

    int mm2counts(double millimeters) const ;
    double counts2mm(int counts) const ;
    int in2counts(double inches) const ;
    double counts2in(int counts) const ;

    virtual void setPointingCallback(PointingCallback callback, void *context=0) = 0 ;

    virtual void setDebugLevel(int /*level*/) {}

    virtual void debug(std::ostream& /*out*/) const {}

    virtual void getAbsolutePosition(double *x, double *y) const;

    virtual ~PointingDevice(void) {}

  } ;

}

#endif