graphicsWindow.h

Go to the documentation of this file.

/**
 * 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."
 *
 * @file graphicsWindow.h
 * @author mike
 * @date 1997-01-09
 */

#ifndef GRAPHICSWINDOW_H
#define GRAPHICSWINDOW_H

#include "pandabase.h"

#include "graphicsOutput.h"
#include "graphicsWindowInputDevice.h"
#include "graphicsWindowProc.h"
#include "graphicsWindowProcCallbackData.h"
#include "windowProperties.h"
#include "mouseData.h"
#include "modifierButtons.h"
#include "buttonEvent.h"
#include "keyboardButton.h"
#include "buttonMap.h"
#include "pnotify.h"
#include "lightMutex.h"
#include "lightReMutex.h"
#include "pvector.h"
#include "windowHandle.h"
#include "touchInfo.h"

/**
 * A window, fullscreen or on a desktop, into which a graphics device sends
 * its output for interactive display.
 */
class EXPCL_PANDA_DISPLAY GraphicsWindow : public GraphicsOutput {
protected:
  GraphicsWindow(GraphicsEngine *engine,
                 GraphicsPipe *pipe,
                 const std::string &name,
                 const FrameBufferProperties &fb_prop,
                 const WindowProperties &win_prop,
                 int flags,
                 GraphicsStateGuardian *gsg,
                 GraphicsOutput *host);

PUBLISHED:
  virtual ~GraphicsWindow();

  const WindowProperties get_properties() const;
  const WindowProperties get_requested_properties() const;
  void clear_rejected_properties();
  WindowProperties get_rejected_properties() const;
  void request_properties(const WindowProperties &requested_properties);
  INLINE bool is_closed() const;
  virtual bool is_active() const;
  INLINE bool is_fullscreen() const;

  MAKE_PROPERTY(properties, get_properties);
  MAKE_PROPERTY(requested_properties, get_requested_properties);
  MAKE_PROPERTY(rejected_properties, get_rejected_properties);
  MAKE_PROPERTY(closed, is_closed);

  void set_window_event(const std::string &window_event);
  std::string get_window_event() const;
  MAKE_PROPERTY(window_event, get_window_event, set_window_event);

  void set_close_request_event(const std::string &close_request_event);
  std::string get_close_request_event() const;
  MAKE_PROPERTY(close_request_event, get_close_request_event, set_close_request_event);

  INLINE void set_unexposed_draw(bool unexposed_draw);
  INLINE bool get_unexposed_draw() const;
  MAKE_PROPERTY(unexposed_draw, get_unexposed_draw, set_unexposed_draw);

  INLINE WindowHandle *get_window_handle() const;
  MAKE_PROPERTY(window_handle, get_window_handle);

  // Mouse and keyboard routines
  int get_num_input_devices() const;
  InputDevice *get_input_device(int i) const;
  std::string get_input_device_name(int device) const;
  MAKE_SEQ(get_input_devices, get_num_input_devices, get_input_device);
  MAKE_SEQ(get_input_device_names, get_num_input_devices, get_input_device_name);
  bool has_pointer(int device) const;
  bool has_keyboard(int device) const;
  virtual ButtonMap *get_keyboard_map() const;

  void enable_pointer_events(int device);
  void disable_pointer_events(int device);
  /*void enable_pointer_mode(int device, double speed);
  void disable_pointer_mode(int device);*/

  virtual MouseData get_pointer(int device) const;
  virtual bool move_pointer(int device, int x, int y);
  virtual void close_ime();

public:
  virtual void add_window_proc( const GraphicsWindowProc* wnd_proc_object ){};
  virtual void remove_window_proc( const GraphicsWindowProc* wnd_proc_object ){};
  virtual void clear_window_procs(){};
  virtual bool supports_window_procs() const;

  virtual int verify_window_sizes(int numsizes, int *dimen);

  virtual bool is_touch_event(GraphicsWindowProcCallbackData* callbackData);
  virtual int get_num_touches();
  virtual TouchInfo get_touch_info(int index);

public:
  virtual void request_open();
  virtual void request_close();

  // It is an error to call any of the following methods from any thread other
  // than the window thread.  These methods are normally called by the
  // GraphicsEngine.
  virtual void set_close_now();
  virtual void process_events();
  virtual void set_properties_now(WindowProperties &properties);

protected:
  virtual void close_window();
  virtual bool open_window();
  virtual void reset_window(bool swapchain);

  virtual bool do_reshape_request(int x_origin, int y_origin, bool has_origin,
                                  int x_size, int y_size);

  virtual void mouse_mode_absolute();
  virtual void mouse_mode_relative();

  // It is an error to call any of the following methods from any thread other
  // than the window thread.
  void system_changed_properties(const WindowProperties &properties);
  void system_changed_size(int x_size, int y_size);

protected:
  int add_input_device(InputDevice *device);
  typedef pvector<PT(InputDevice)> InputDevices;
  InputDevices _input_devices;
  LightMutex _input_lock;

protected:
  WindowProperties _properties;
  PT(WindowHandle) _window_handle;
  PT(WindowHandle) _parent_window_handle;

  bool _got_expose_event;

private:
  LightReMutex _properties_lock;
  // protects _requested_properties, _rejected_properties, and _window_event.

  WindowProperties _requested_properties;
  WindowProperties _rejected_properties;
  std::string _window_event;
  std::string _close_request_event;
  bool _unexposed_draw;

#ifdef HAVE_PYTHON
  typedef pset<GraphicsWindowProc*> PythonWinProcClasses;
  PythonWinProcClasses _python_window_proc_classes;
#endif

public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    GraphicsOutput::init_type();
    register_type(_type_handle, "GraphicsWindow",
                  GraphicsOutput::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;

  friend class GraphicsEngine;
  friend class Extension<GraphicsWindow>;
};

#include "graphicsWindow.I"

#endif /* GRAPHICSWINDOW_H */