MotionEvent.hpp

Go to the documentation of this file.

#ifndef __blip_MotionEvent_hpp
#define __blip_MotionEvent_hpp

#include <blip/Blip.hpp>
#include <blip/InputEvent.hpp>

#include <commonc++/Flags.h++>

namespace blip {

class InputQueue;

// TODO: The documentation on the event times is totally
// confusing. For the hisorical events, is it an absolute time? or a
// delta from the previous event?
class MotionEvent : public InputEvent
{
  friend class InputEventQueue;

  public:

  enum Action {
    Action_Unknown = -1,
    Action_Down = 0,
    Action_Up,
    Action_Move,
    Action_Cancel,
    Action_Outside,
    Action_PointerDown,
    Action_PointerUp,
    Action_HoverMove,
    Action_Scroll,
    Action_HoverEnter,
    Action_HoverExit
  };

  enum Axis {
    Axis_X = 0,
    Axis_Y = 1,
    Axis_Z = 11,
    Axis_Pressure = 2,
    Axis_Size = 3,
    Axis_TouchMajor = 4,
    Axis_TouchMinor = 5,
    Axis_ToolMajor = 6,
    Axis_ToolMinor = 7,
    Axis_Orientation = 8,
    Axis_HorizontalScroll = 10,
    Axis_VerticalScroll = 9,
    Axis_RotationX = 12,
    Axis_RotationY = 13,
    Axis_RotationZ = 14,
    Axis_HatX = 15,
    Axis_HatY = 16,
    Axis_LeftTrigger = 17,
    Axis_RightTrigger = 18,
    Axis_Throttle = 19,
    Axis_Rudder = 20,
    Axis_Wheel = 21,
    Axis_Gas = 22,
    Axis_Brake = 23,
    Axis_Distance = 24,
    Axis_Tilt = 25,
    Axis_Generic1 = 32,
    Axis_Generic2 = 33,
    Axis_Generic3 = 34,
    Axis_Generic4 = 35,
    Axis_Generic5 = 36,
    Axis_Generic6 = 37,
    Axis_Generic7 = 38,
    Axis_Generic8 = 39,
    Axis_Generic9 = 40,
    Axis_Generic10 = 41,
    Axis_Generic11 = 42,
    Axis_Generic12 = 43,
    Axis_Generic13 = 44,
    Axis_Generic14 = 45,
    Axis_Generic15 = 46,
    Axis_Generic16 = 47
  };

  enum ToolType {
    ToolType_Unknown = -1,
    ToolType_Finger = 1,
    ToolType_Stylus = 2,
    ToolType_Mouse = 3,
    ToolType_Eraser = 4
  };

  enum Button {
    Button_Primary = 1,
    Button_Secondary,
    Button_Tertiary,
    Button_Back,
    Button_Forward
  };

  virtual ~MotionEvent();

  Action getAction() const;

  int getActionPointerIndex() const;

  const ccxx::Flags<uint32_t> getFlags() const;

  uint32_t getMetaState() const;

  const ccxx::Flags<uint32_t> getButtonState() const;

  const ccxx::Flags<uint32_t> getEdgeFlags() const;

  time_ms_t getDownTime() const;

  // TODO: this is in nanotime, not a wall time
  virtual time_ms_t getEventTime() const;

  float getXOffset() const;

  float getYOffset() const;

  float getXPrecision() const;

  float getYPrecision() const;

  int getPointerCount() const;

  int32_t getPointerID(int pointerIndex) const;

  ToolType getToolType(int pointerIndex) const;

  float getRawX(int pointerIndex) const;

  float getRawY(int pointerIndex) const;

  float getX(int pointerIndex) const;

  float getY(int pointerIndex) const;

  float getPressure(int pointerIndex) const;

  float getSize(int pointerIndex) const;

  float getOrientation(int pointerIndex) const;

  float getTouchMinor(int pointerIndex) const;

  float getTouchMajor(int pointerIndex) const;

  float getToolMinor(int pointerIndex) const;

  float getToolMajor(int pointerIndex) const;

  float getAxisValue(Axis axis, int pointerIndex) const;

  uint_t getHistorySize() const;

  time_ms_t getHistoricalEventTime(int historyIndex) const;

  float getHistoricalRawX(int historyIndex, int pointerIndex) const;

  float getHistoricalRawY(int historyIndex, int pointerIndex) const;

  float getHistoricalX(int historyIndex, int pointerIndex) const;

  float getHistoricalY(int historyIndex, int pointerIndex) const;

  float getHistoricalPressure(int historyIndex, int pointerIndex)
    const;

  float getHistoricalSize(int historyIndex, int pointerIndex) const;

  float getHistoricalOrientation(int historyIndex, int pointerIndex)
    const;

  float getHistoricalTouchMinor(int historyIndex, int pointerIndex)
    const;

  float getHistoricalTouchMajor(int historyIndex, int pointerIndex)
    const;

  float getHistoricalToolMinor(int historyIndex, int pointerIndex) const;

  float getHistoricalToolMajor(int historyIndex, int pointerIndex) const;

  float getHistoricalAxisValue(int historyIndex, Axis axis, int pointerIndex)
    const;

  static const uint32_t FLAG_WINDOW_IS_OBSCURED;

  static const uint32_t EDGE_TOP_MASK;

  static const uint32_t EDGE_BOTTOM_MASK;

  static const uint32_t EDGE_LEFT_MASK;

  static const uint32_t EDGE_RIGHT_MASK;

  protected:

  MotionEvent(AInputEvent* event);
  private:

  CCXX_COPY_DECLS(MotionEvent);
};

} // namespace blip

#endif // __blip_MotionEvent_hpp