// Filename: pointerEventList.h
// Created by:  drose (12Mar02)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) Carnegie Mellon University.  All rights reserved.
//
// All use of this software is subject to the terms of the revised BSD
// license.  You should have received a copy of this license along
// with this source code in a file named "LICENSE."
//
////////////////////////////////////////////////////////////////////

#ifndef POINTEREVENTLIST_H
#define POINTEREVENTLIST_H

#include "pandabase.h"

#include "pointerEvent.h"
#include "typedReferenceCount.h"
#include "eventParameter.h"
#include "pvector.h"

class ModifierPointers;
class Datagram;
class DatagramIterator;

////////////////////////////////////////////////////////////////////
//       Class : PointerEventList
// Description : Records a set of pointer events that happened
//               recently.  This class is usually used only in the
//               data graph, to transmit the recent pointer presses,
//               but it may be used anywhere a list of PointerEvents
//               is desired.
////////////////////////////////////////////////////////////////////
class EXPCL_PANDA_EVENT PointerEventList : public EventStoreValueBase {
PUBLISHED:
  INLINE PointerEventList();

  INLINE int get_num_events() const;
  INLINE bool   get_in_window(int n) const;
  INLINE int    get_xpos(int n) const;
  INLINE int    get_ypos(int n) const;
  INLINE int    get_dx(int n) const;
  INLINE int    get_dy(int n) const;
  INLINE int    get_sequence(int n) const;
  INLINE double get_length(int n) const;
  INLINE double get_direction(int n) const;
  INLINE double get_rotation(int n) const;
  INLINE double get_time(int n) const;

  INLINE void   clear();
  INLINE void   pop_front();
  void   add_event(bool in_win, int xpos, int ypos, int seq, double time);
  
  bool   encircles(int x, int y) const;
  double total_turns(double sec) const;
  double match_pattern(const string &pattern, double rot, double seglen);
  
public:
  INLINE PointerEventList(const PointerEventList &copy);
  INLINE void operator = (const PointerEventList &copy);


  virtual void output(ostream &out) const;
  void write(ostream &out, int indent_level = 0) const;

private:
  void parse_pattern(const string &ascpat, pvector <double> &pattern);
  typedef pdeque<PointerEvent> Events;
  Events _events;

public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    EventStoreValueBase::init_type();
    register_type(_type_handle, "PointerEventList",
                  EventStoreValueBase::get_class_type());
  }
  virtual TypeHandle get_type() const {
    return get_class_type();
  }
  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}

private:
  static TypeHandle _type_handle;
};

INLINE ostream &operator << (ostream &out, const PointerEventList &pointerlist) {
  pointerlist.output(out);
  return out;
}

#include "pointerEventList.I"

#endif