source/blender/editors/include/UI_view2d.h

   1 /**
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19  *
  20  * The Original Code is Copyright (C) 2008 Blender Foundation.
  21  * All rights reserved.
  22  *
  23  *
  24  * Contributor(s): Blender Foundation, Joshua Leung
  25  *
  26  *
  27  * Generic 2d view with should allow drawing grids,
  28  * panning, zooming, scrolling, ..
  29  * ***** END GPL LICENSE BLOCK *****
  30  */
  31
  32 #ifndef UI_VIEW2D_H
  33 #define UI_VIEW2D_H
  34
  35 /* ------------------------------------------ */
  36 /* Settings and Defines:                                        */
  37
  38 /* ---- General Defines ---- */
  39
  40 /* generic value to use when coordinate lies out of view when converting */
  41 #define V2D_IS_CLIPPED  12000
  42
  43 /* Common View2D view types
  44  * NOTE: only define a type here if it completely sets all (+/- a few) of the relevant flags
  45  *          and settings for a View2D region, and that set of settings is used in more
  46  *          than one specific place
  47  */
  48 enum {
  49                 /* custom view type (region has defined all necessary flags already) */
  50         V2D_COMMONVIEW_CUSTOM = -1,
  51                 /* standard (only use this when setting up a new view, as a sensible base for most settings) */
  52         V2D_COMMONVIEW_STANDARD,
  53                 /* listview (i.e. Outliner) */
  54         V2D_COMMONVIEW_LIST,
  55                 /* headers (this is basically the same as listview, but no y-panning) */
  56         V2D_COMMONVIEW_HEADER,
  57                 /* ui region containing panels */
  58         V2D_COMMONVIEW_PANELS_UI,
  59 } eView2D_CommonViewTypes;
  60
  61 /* ---- Defines for Scroller/Grid Arguments ----- */
  62
  63 /* 'dummy' argument to pass when argument is irrelevant */
  64 #define V2D_ARG_DUMMY           -1
  65
  66 /* Grid units */
  67 enum {
  68         /* for drawing time */
  69         V2D_UNIT_SECONDS = 0,
  70         V2D_UNIT_FRAMES,
  71         V2D_UNIT_FRAMESCALE,
  72
  73         /* for drawing values */
  74         V2D_UNIT_VALUES,
  75         V2D_UNIT_DEGREES,
  76         V2D_UNIT_TIME,
  77         V2D_UNIT_SECONDSSEQ,
  78 } eView2D_Units;
  79
  80 /* clamping of grid values to whole numbers */
  81 enum {
  82         V2D_GRID_NOCLAMP = 0,
  83         V2D_GRID_CLAMP,
  84 } eView2D_Clamp;
  85
  86 /* flags for grid-lines to draw */
  87 enum {
  88         V2D_HORIZONTAL_LINES            = (1<<0),
  89         V2D_VERTICAL_LINES                      = (1<<1),
  90         V2D_HORIZONTAL_AXIS                     = (1<<2),
  91         V2D_VERTICAL_AXIS                       = (1<<3),
  92         V2D_HORIZONTAL_FINELINES        = (1<<4),
  93
  94         V2D_GRIDLINES_MAJOR                     = (V2D_VERTICAL_LINES|V2D_VERTICAL_AXIS|V2D_HORIZONTAL_LINES|V2D_HORIZONTAL_AXIS),
  95         V2D_GRIDLINES_ALL                       = (V2D_GRIDLINES_MAJOR|V2D_HORIZONTAL_FINELINES),
  96 } eView2D_Gridlines;
  97
  98 /* ------ Defines for Scrollers ----- */
  99
 100 /* scroller thickness */
 101 #define V2D_SCROLL_HEIGHT       16
 102 #define V2D_SCROLL_WIDTH        16
 103
 104 /* half the size (in pixels) of scroller 'handles' */
 105 #define V2D_SCROLLER_HANDLE_SIZE        5
 106
 107 /* ------ Define for UI_view2d_sync ----- */
 108
 109 /* means copy it from another v2d */
 110 #define V2D_LOCK_SET    0
 111 /* means copy it to the other v2ds */
 112 #define V2D_LOCK_COPY   1
 113
 114
 115 /* ------------------------------------------ */
 116 /* Macros:                                                              */
 117
 118 /* test if mouse in a scrollbar (assume that scroller availability has been tested) */
 119 #define IN_2D_VERT_SCROLL(v2d, co) (BLI_in_rcti(&v2d->vert, co[0], co[1]))
 120 #define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_in_rcti(&v2d->hor, co[0], co[1]))
 121
 122 /* ------------------------------------------ */
 123 /* Type definitions:                                            */
 124
 125 struct View2D;
 126 struct View2DGrid;
 127 struct View2DScrollers;
 128
 129 struct wmWindowManager;
 130 struct bScreen;
 131 struct ScrArea;
 132 struct ARegion;
 133 struct bContext;
 134 struct rctf;
 135
 136 typedef struct View2DGrid View2DGrid;
 137 typedef struct View2DScrollers View2DScrollers;
 138
 139 /* ----------------------------------------- */
 140 /* Prototypes:                                              */
 141
 142 /* refresh and validation (of view rects) */
 143 void UI_view2d_region_reinit(struct View2D *v2d, short type, int winx, int winy);
 144
 145 void UI_view2d_curRect_validate(struct View2D *v2d);
 146 void UI_view2d_curRect_reset(struct View2D *v2d);
 147 void UI_view2d_sync(struct bScreen *screen, struct ScrArea *sa, struct View2D *v2dcur, int flag);
 148
 149 void UI_view2d_totRect_set(struct View2D *v2d, int width, int height);
 150
 151 /* view matrix operations */
 152 void UI_view2d_view_ortho(const struct bContext *C, struct View2D *v2d);
 153 void UI_view2d_view_orthoSpecial(const struct bContext *C, struct View2D *v2d, short xaxis);
 154 void UI_view2d_view_restore(const struct bContext *C);
 155
 156 /* grid drawing */
 157 View2DGrid *UI_view2d_grid_calc(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp, int winx, int winy);
 158 void UI_view2d_grid_draw(const struct bContext *C, struct View2D *v2d, View2DGrid *grid, int flag);
 159 void UI_view2d_constant_grid_draw(const struct bContext *C, struct View2D *v2d);
 160 void UI_view2d_grid_free(View2DGrid *grid);
 161
 162 /* scrollbar drawing */
 163 View2DScrollers *UI_view2d_scrollers_calc(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp);
 164 void UI_view2d_scrollers_draw(const struct bContext *C, struct View2D *v2d, View2DScrollers *scrollers);
 165 void UI_view2d_scrollers_free(View2DScrollers *scrollers);
 166
 167 /* list view tools */
 168 void UI_view2d_listview_cell_to_view(struct View2D *v2d, short columnwidth, short rowheight, float startx, float starty, int column, int row, struct rctf *rect);
 169 void UI_view2d_listview_view_to_cell(struct View2D *v2d, short columnwidth, short rowheight, float startx, float starty, float viewx, float viewy, int *column, int *row);
 170 void UI_view2d_listview_visible_cells(struct View2D *v2d, short columnwidth, short rowheight, float startx, float starty, int *column_min, int *column_max, int *row_min, int *row_max);
 171
 172 /* coordinate conversion */
 173 void UI_view2d_region_to_view(struct View2D *v2d, int x, int y, float *viewx, float *viewy);
 174 void UI_view2d_view_to_region(struct View2D *v2d, float x, float y, int *regionx, int *regiony);
 175 void UI_view2d_to_region_no_clip(struct View2D *v2d, float x, float y, int *regionx, int *region_y);
 176
 177 /* utilities */
 178 struct View2D *UI_view2d_fromcontext(const struct bContext *C);
 179 struct View2D *UI_view2d_fromcontext_rwin(const struct bContext *C);
 180
 181 void UI_view2d_getscale(struct View2D *v2d, float *x, float *y);
 182
 183 short UI_view2d_mouse_in_scrollers(const struct bContext *C, struct View2D *v2d, int x, int y);
 184
 185 /* cached text drawing in v2d, to allow pixel-aligned draw as post process */
 186 void UI_view2d_text_cache_add(struct View2D *v2d, float x, float y, char *str);
 187 void UI_view2d_text_cache_draw(struct ARegion *ar);
 188
 189 /* operators */
 190 void ui_view2d_operatortypes(void);
 191 void UI_view2d_keymap(struct wmWindowManager *wm);
 192
 193 #endif /* UI_VIEW2D_H */
 194