gimp/app/display/gimpdisplayshell.h

/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GIMP_DISPLAY_SHELL_H__
#define __GIMP_DISPLAY_SHELL_H__


#include "gimpimagewindow.h"


/* Apply to a float the same rounding mode used in the renderer */
#define  PROJ_ROUND(coord)   ((gint) RINT (coord))
#define  PROJ_ROUND64(coord) ((gint64) RINT (coord))

/* finding the effective screen resolution (double) */
#define  SCREEN_XRES(s)   ((s)->dot_for_dot ? \
                           (s)->display->image->xresolution : (s)->monitor_xres)
#define  SCREEN_YRES(s)   ((s)->dot_for_dot ? \
                           (s)->display->image->yresolution : (s)->monitor_yres)

/* scale values */
#define  SCALEX(s,x)      PROJ_ROUND ((x) * (s)->scale_x)
#define  SCALEY(s,y)      PROJ_ROUND ((y) * (s)->scale_y)

/* unscale values */
#define  UNSCALEX(s,x)    ((gint) ((x) / (s)->scale_x))
#define  UNSCALEY(s,y)    ((gint) ((y) / (s)->scale_y))
/* (and float-returning versions) */
#define  FUNSCALEX(s,x)   ((x) / (s)->scale_x)
#define  FUNSCALEY(s,y)   ((y) / (s)->scale_y)

/*  the size of the display render buffer  */
#define GIMP_DISPLAY_RENDER_BUF_WIDTH  256
#define GIMP_DISPLAY_RENDER_BUF_HEIGHT 256


#define GIMP_TYPE_DISPLAY_SHELL            (gimp_display_shell_get_type ())
#define GIMP_DISPLAY_SHELL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_DISPLAY_SHELL, GimpDisplayShell))
#define GIMP_DISPLAY_SHELL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_DISPLAY_SHELL, GimpDisplayShellClass))
#define GIMP_IS_DISPLAY_SHELL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_DISPLAY_SHELL))
#define GIMP_IS_DISPLAY_SHELL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_DISPLAY_SHELL))
#define GIMP_DISPLAY_SHELL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_DISPLAY_SHELL, GimpDisplayShellClass))


typedef struct _GimpDisplayShellClass  GimpDisplayShellClass;

struct _GimpDisplayShell
{
  GimpImageWindow    parent_instance;

  /* --- cacheline 2 boundary (128 bytes) was 20 bytes ago --- */

  GtkWidget         *disp_vbox; /* FIXME temp hack */

  GimpDisplay       *display;

  GimpUIManager     *popup_manager;

  GimpDisplayOptions *options;
  GimpDisplayOptions *fullscreen_options;
  GimpDisplayOptions *no_image_options;

  gboolean           snap_to_guides;   /*  should the guides be snapped to?   */
  gboolean           snap_to_grid;     /*  should the grid be snapped to?     */
  gboolean           snap_to_canvas;   /*  should the canvas be snapped to?   */
  gboolean           snap_to_vectors;  /*  should the active path be snapped  */

  /* --- cacheline 3 boundary (192 bytes) --- */

  GimpUnit           unit;

  gint               offset_x;         /*  offset of display image            */
  gint               offset_y;

  gdouble            scale_x;          /*  horizontal scale factor            */
  gdouble            scale_y;          /*  vertical scale factor              */

  gdouble            monitor_xres;
  gdouble            monitor_yres;
  gboolean           dot_for_dot;      /*  ignore monitor resolution          */

  gint               x_src_dec;        /*  increments for the bresenham style */
  gint               y_src_dec;        /*  image --> display transformation   */
  gint               x_dest_inc;
  gint               y_dest_inc;

  /* --- cacheline 4 boundary (256 bytes) --- */

  GimpZoomModel     *zoom;

  gdouble            last_scale;       /*  scale used when reverting zoom     */
  guint              last_scale_time;  /*  time when last_scale was set       */
  gint               last_offset_x;    /*  offsets used when reverting zoom   */
  gint               last_offset_y;

  guint32            last_motion_time; /*  previous time of a forwarded motion event  */
  guint32            last_read_motion_time;
  gdouble            last_motion_delta_time;
  gdouble            last_motion_delta_x;
  gdouble            last_motion_delta_y;
  gdouble            last_motion_distance;

  /* --- cacheline 5 boundary (320 bytes) --- */

  GimpCoords         last_coords;      /* last motion event                   */

  gdouble            other_scale;      /*  scale factor entered in Zoom->Other*/

  gint               disp_width;       /*  width of drawing area              */
  gint               disp_height;      /*  height of drawing area             */

  gboolean           proximity;        /*  is a device in proximity           */

  Selection         *selection;        /*  Selection (marching ants)          */

  GtkWidget         *canvas;           /*  GimpCanvas widget                  */
  GdkGC             *grid_gc;          /*  GC for grid drawing                */
  GdkGC             *pen_gc;           /*  GC for felt pen drawing            */

  GtkAdjustment     *hsbdata;          /*  adjustments                        */
  GtkAdjustment     *vsbdata;
  GtkWidget         *hsb;              /*  scroll bars                        */
  GtkWidget         *vsb;

  GtkWidget         *hrule;            /*  rulers                             */
  GtkWidget         *vrule;

  GtkWidget         *origin;           /*  NW: origin                         */
  GtkWidget         *quick_mask_button;/*  SW: quick mask button              */
  GtkWidget         *zoom_button;      /*  NE: zoom toggle button             */
  GtkWidget         *nav_ebox;         /*  SE: navigation event box           */

  guchar            *render_buf;       /*  buffer for rendering the image     */

  guint              title_idle_id;    /*  title update idle ID               */
  gchar             *title;            /*  current title                      */
  gchar             *status;           /*  current default statusbar content  */

  gint               icon_size;        /*  size of the icon pixmap            */
  guint              icon_idle_id;     /*  ID of the idle-function            */
  GdkPixbuf         *icon;             /*  icon                               */

  guint              fill_idle_id;     /*  display_shell_fill() idle ID       */

  GimpCursorFormat   cursor_format;    /*  Currently used cursor format       */
  GimpCursorType     current_cursor;   /*  Currently installed main cursor    */
  GimpToolCursorType tool_cursor;      /*  Current Tool cursor                */
  GimpCursorModifier cursor_modifier;  /*  Cursor modifier (plus, minus, ...) */

  GimpCursorType     override_cursor;  /*  Overriding cursor                 */
  gboolean           using_override_cursor;
  gboolean           draw_cursor;      /* should we draw software cursor ?    */
  gboolean           have_cursor;      /* is cursor currently drawn ?         */
  gint               cursor_x;         /* software cursor X value             */
  gint               cursor_y;         /* software cursor Y value             */

  GtkWidget         *close_dialog;     /*  close dialog                       */
  GtkWidget         *scale_dialog;     /*  scale (zoom) dialog                */
  GtkWidget         *nav_popup;        /*  navigation popup                   */
  GtkWidget         *grid_dialog;      /*  grid configuration dialog          */

  GimpColorDisplayStack *filter_stack;   /* color display conversion stuff    */
  guint                  filter_idle_id;
  GtkWidget             *filters_dialog; /* color display filter dialog       */

  gint               paused_count;

  GimpTreeHandler   *vectors_freeze_handler;
  GimpTreeHandler   *vectors_thaw_handler;
  GimpTreeHandler   *vectors_visible_handler;

  gboolean           zoom_on_resize;
  gboolean           show_transform_preview;

  gboolean           size_allocate_from_configure_event;

  /*  the state of gimp_display_shell_tool_events()  */
  gboolean           space_pressed;
  gboolean           space_release_pending;
  const gchar       *space_shaded_tool;

  gboolean           scrolling;
  gint               scroll_start_x;
  gint               scroll_start_y;
  gpointer           scroll_info;

  gboolean           button_press_before_focus;

  GdkRectangle      *highlight;        /* in image coordinates, can be NULL   */
  GimpDrawable      *mask;
  GimpChannelType    mask_color;

  GArray            *event_history;
  GArray            *event_queue;
  gboolean           event_delay;      /* TRUE if theres an unsent event in
                                          the history buffer                  */

  gint               event_delay_timeout;
  GdkModifierType    last_active_state;
};

struct _GimpDisplayShellClass
{
  GimpImageWindowClass  parent_class;

  void (* scaled)    (GimpDisplayShell *shell);
  void (* scrolled)  (GimpDisplayShell *shell);
  void (* reconnect) (GimpDisplayShell *shell);
};


GType       gimp_display_shell_get_type            (void) G_GNUC_CONST;

GtkWidget * gimp_display_shell_new                 (GimpDisplay        *display,
                                                    GimpUnit            unit,
                                                    gdouble             scale,
                                                    GimpMenuFactory    *menu_factory,
                                                    GimpUIManager      *popup_manager,
                                                    GimpDialogFactory  *display_factory);

GimpImageWindow * gimp_display_shell_get_window    (GimpDisplayShell   *shell);

void        gimp_display_shell_reconnect           (GimpDisplayShell   *shell);

void        gimp_display_shell_empty               (GimpDisplayShell   *shell);
void        gimp_display_shell_fill                (GimpDisplayShell   *shell,
                                                    GimpImage          *image,
                                                    GimpUnit            unit,
                                                    gdouble             scale);

void        gimp_display_shell_scale_changed       (GimpDisplayShell   *shell);

void        gimp_display_shell_scaled              (GimpDisplayShell   *shell);
void        gimp_display_shell_scrolled            (GimpDisplayShell   *shell);

void        gimp_display_shell_set_unit            (GimpDisplayShell   *shell,
                                                    GimpUnit            unit);
GimpUnit    gimp_display_shell_get_unit            (GimpDisplayShell   *shell);

gboolean    gimp_display_shell_snap_coords         (GimpDisplayShell   *shell,
                                                    GimpCoords         *coords,
                                                    gint                snap_offset_x,
                                                    gint                snap_offset_y,
                                                    gint                snap_width,
                                                    gint                snap_height);

gboolean    gimp_display_shell_mask_bounds         (GimpDisplayShell   *shell,
                                                    gint               *x1,
                                                    gint               *y1,
                                                    gint               *x2,
                                                    gint               *y2);

void        gimp_display_shell_expose_area         (GimpDisplayShell   *shell,
                                                    gint                x,
                                                    gint                y,
                                                    gint                w,
                                                    gint                h);
void        gimp_display_shell_expose_guide        (GimpDisplayShell   *shell,
                                                    GimpGuide          *guide);
void        gimp_display_shell_expose_sample_point (GimpDisplayShell   *shell,
                                                    GimpSamplePoint    *sample_point);
void        gimp_display_shell_expose_full         (GimpDisplayShell   *shell);

void        gimp_display_shell_flush               (GimpDisplayShell   *shell,
                                                    gboolean            now);

void        gimp_display_shell_pause               (GimpDisplayShell   *shell);
void        gimp_display_shell_resume              (GimpDisplayShell   *shell);

void        gimp_display_shell_set_highlight       (GimpDisplayShell   *shell,
                                                    const GdkRectangle *highlight);
void        gimp_display_shell_set_mask            (GimpDisplayShell   *shell,
                                                    GimpDrawable       *mask,
                                                    GimpChannelType     color);


#endif /* __GIMP_DISPLAY_SHELL_H__ */