WM_types.h

Go to the documentation of this file.

/*
 * 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 2
 * 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, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2007 Blender Foundation.
 * All rights reserved.
 */
 
#pragma once
 
struct ID;
struct ImBuf;
struct bContext;
struct wmEvent;
struct wmOperator;
struct wmWindowManager;
 
#include "BLI_compiler_attrs.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
#include "RNA_types.h"
 
/* exported types for WM */
#include "gizmo/WM_gizmo_types.h"
#include "wm_cursors.h"
#include "wm_event_types.h"
 
/* Include external gizmo API's */
#include "gizmo/WM_gizmo_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct wmGenericUserData {
  void *data;
  void (*free_fn)(void *data);
  bool use_free;
} wmGenericUserData;
 
typedef struct wmGenericCallback {
  void (*exec)(struct bContext *C, void *user_data);
  void *user_data;
  void (*free_user_data)(void *user_data);
} wmGenericCallback;
 
/* ************** wmOperatorType ************************ */
 
enum {
  OPTYPE_REGISTER = (1 << 0),
  OPTYPE_UNDO = (1 << 1),
  OPTYPE_BLOCKING = (1 << 2),
  OPTYPE_MACRO = (1 << 3),
 
  OPTYPE_GRAB_CURSOR_XY = (1 << 4),
  OPTYPE_GRAB_CURSOR_X = (1 << 5),
  OPTYPE_GRAB_CURSOR_Y = (1 << 6),
 
  OPTYPE_PRESET = (1 << 7),
 
  OPTYPE_INTERNAL = (1 << 8),
 
  OPTYPE_LOCK_BYPASS = (1 << 9),
  OPTYPE_UNDO_GROUPED = (1 << 10),
};
 
enum {
  WM_CURSOR_WRAP_NONE = 0,
  WM_CURSOR_WRAP_X,
  WM_CURSOR_WRAP_Y,
  WM_CURSOR_WRAP_XY,
};
 
enum {
  /* if there's invoke, call it, otherwise exec */
  WM_OP_INVOKE_DEFAULT,
  WM_OP_INVOKE_REGION_WIN,
  WM_OP_INVOKE_REGION_CHANNELS,
  WM_OP_INVOKE_REGION_PREVIEW,
  WM_OP_INVOKE_AREA,
  WM_OP_INVOKE_SCREEN,
  /* only call exec */
  WM_OP_EXEC_DEFAULT,
  WM_OP_EXEC_REGION_WIN,
  WM_OP_EXEC_REGION_CHANNELS,
  WM_OP_EXEC_REGION_PREVIEW,
  WM_OP_EXEC_AREA,
  WM_OP_EXEC_SCREEN,
};
 
/* property tags for RNA_OperatorProperties */
typedef enum eOperatorPropTags {
  OP_PROP_TAG_ADVANCED = (1 << 0),
} eOperatorPropTags;
#define OP_PROP_TAG_ADVANCED ((eOperatorPropTags)OP_PROP_TAG_ADVANCED)
 
/* ************** wmKeyMap ************************ */
 
/* modifier */
#define KM_SHIFT 1
#define KM_CTRL 2
#define KM_ALT 4
#define KM_OSKEY 8
/* means modifier should be pressed 2nd */
#define KM_SHIFT2 16
#define KM_CTRL2 32
#define KM_ALT2 64
#define KM_OSKEY2 128
 
/* KM_MOD_ flags for wmKeyMapItem and wmEvent.alt/shift/oskey/ctrl  */
/* note that KM_ANY and KM_NOTHING are used with these defines too */
#define KM_MOD_FIRST 1
#define KM_MOD_SECOND 2
 
/* type: defined in wm_event_types.c */
#define KM_TEXTINPUT -2
 
/* val */
#define KM_ANY -1
#define KM_NOTHING 0
#define KM_PRESS 1
#define KM_RELEASE 2
#define KM_CLICK 3
#define KM_DBL_CLICK 4
#define KM_CLICK_DRAG 5
 
/* ************** UI Handler ***************** */
 
#define WM_UI_HANDLER_CONTINUE 0
#define WM_UI_HANDLER_BREAK 1
 
/* ************** Notifiers ****************** */
 
typedef struct wmNotifier {
  struct wmNotifier *next, *prev;
 
  const struct wmWindow *window;
 
  unsigned int category, data, subtype, action;
 
  void *reference;
 
} wmNotifier;
 
/* 4 levels
 *
 * 0xFF000000; category
 * 0x00FF0000; data
 * 0x0000FF00; data subtype (unused?)
 * 0x000000FF; action
 */
 
/* category */
#define NOTE_CATEGORY 0xFF000000
#define NC_WM (1 << 24)
#define NC_WINDOW (2 << 24)
#define NC_SCREEN (3 << 24)
#define NC_SCENE (4 << 24)
#define NC_OBJECT (5 << 24)
#define NC_MATERIAL (6 << 24)
#define NC_TEXTURE (7 << 24)
#define NC_LAMP (8 << 24)
#define NC_GROUP (9 << 24)
#define NC_IMAGE (10 << 24)
#define NC_BRUSH (11 << 24)
#define NC_TEXT (12 << 24)
#define NC_WORLD (13 << 24)
#define NC_ANIMATION (14 << 24)
/* When passing a space as reference data with this (e.g. `WM_event_add_notifier(..., space)`),
 * the notifier will only be sent to this space. That avoids unnecessary updates for unrelated
 * spaces. */
#define NC_SPACE (15 << 24)
#define NC_GEOM (16 << 24)
#define NC_NODE (17 << 24)
#define NC_ID (18 << 24)
#define NC_PAINTCURVE (19 << 24)
#define NC_MOVIECLIP (20 << 24)
#define NC_MASK (21 << 24)
#define NC_GPENCIL (22 << 24)
#define NC_LINESTYLE (23 << 24)
#define NC_CAMERA (24 << 24)
#define NC_LIGHTPROBE (25 << 24)
/* Changes to asset data in the current .blend. */
#define NC_ASSET (26 << 24)
 
/* data type, 256 entries is enough, it can overlap */
#define NOTE_DATA 0x00FF0000
 
/* NC_WM windowmanager */
#define ND_FILEREAD (1 << 16)
#define ND_FILESAVE (2 << 16)
#define ND_DATACHANGED (3 << 16)
#define ND_HISTORY (4 << 16)
#define ND_JOB (5 << 16)
#define ND_UNDO (6 << 16)
#define ND_XR_DATA_CHANGED (7 << 16)
#define ND_LIB_OVERRIDE_CHANGED (8 << 16)
 
/* NC_SCREEN */
#define ND_LAYOUTBROWSE (1 << 16)
#define ND_LAYOUTDELETE (2 << 16)
#define ND_ANIMPLAY (4 << 16)
#define ND_GPENCIL (5 << 16)
#define ND_EDITOR_CHANGED (6 << 16) /*sent to new editors after switching to them*/
#define ND_LAYOUTSET (7 << 16)
#define ND_SKETCH (8 << 16)
#define ND_WORKSPACE_SET (9 << 16)
#define ND_WORKSPACE_DELETE (10 << 16)
 
/* NC_SCENE Scene */
#define ND_SCENEBROWSE (1 << 16)
#define ND_MARKERS (2 << 16)
#define ND_FRAME (3 << 16)
#define ND_RENDER_OPTIONS (4 << 16)
#define ND_NODES (5 << 16)
#define ND_SEQUENCER (6 << 16)
/* Note: If an object was added, removed, merged/joined, ..., it is not enough to notify with
 * this. This affects the layer so also send a layer change notifier (e.g. ND_LAYER_CONTENT)! */
#define ND_OB_ACTIVE (7 << 16)
/* See comment on ND_OB_ACTIVE. */
#define ND_OB_SELECT (8 << 16)
#define ND_OB_VISIBLE (9 << 16)
#define ND_OB_RENDER (10 << 16)
#define ND_MODE (11 << 16)
#define ND_RENDER_RESULT (12 << 16)
#define ND_COMPO_RESULT (13 << 16)
#define ND_KEYINGSET (14 << 16)
#define ND_TOOLSETTINGS (15 << 16)
#define ND_LAYER (16 << 16)
#define ND_FRAME_RANGE (17 << 16)
#define ND_TRANSFORM_DONE (18 << 16)
#define ND_WORLD (92 << 16)
#define ND_LAYER_CONTENT (101 << 16)
 
/* NC_OBJECT Object */
#define ND_TRANSFORM (18 << 16)
#define ND_OB_SHADING (19 << 16)
#define ND_POSE (20 << 16)
#define ND_BONE_ACTIVE (21 << 16)
#define ND_BONE_SELECT (22 << 16)
#define ND_DRAW (23 << 16)
#define ND_MODIFIER (24 << 16)
#define ND_KEYS (25 << 16)
#define ND_CONSTRAINT (26 << 16)
#define ND_PARTICLE (27 << 16)
#define ND_POINTCACHE (28 << 16)
#define ND_PARENT (29 << 16)
#define ND_LOD (30 << 16)
#define ND_DRAW_RENDER_VIEWPORT \
  (31 << 16) /* for camera & sequencer viewport update, also /w NC_SCENE */
#define ND_SHADERFX (32 << 16)
/* For updating motion paths in 3dview. */
#define ND_DRAW_ANIMVIZ (33 << 16)
 
/* NC_MATERIAL Material */
#define ND_SHADING (30 << 16)
#define ND_SHADING_DRAW (31 << 16)
#define ND_SHADING_LINKS (32 << 16)
#define ND_SHADING_PREVIEW (33 << 16)
 
/* NC_LAMP Light */
#define ND_LIGHTING (40 << 16)
#define ND_LIGHTING_DRAW (41 << 16)
 
/* NC_WORLD World */
#define ND_WORLD_DRAW (45 << 16)
 
/* NC_TEXT Text */
#define ND_CURSOR (50 << 16)
#define ND_DISPLAY (51 << 16)
 
/* NC_ANIMATION Animato */
#define ND_KEYFRAME (70 << 16)
#define ND_KEYFRAME_PROP (71 << 16)
#define ND_ANIMCHAN (72 << 16)
#define ND_NLA (73 << 16)
#define ND_NLA_ACTCHANGE (74 << 16)
#define ND_FCURVES_ORDER (75 << 16)
#define ND_NLA_ORDER (76 << 16)
 
/* NC_GPENCIL */
#define ND_GPENCIL_EDITMODE (85 << 16)
 
/* NC_GEOM Geometry */
/* Mesh, Curve, MetaBall, Armature, .. */
#define ND_SELECT (90 << 16)
#define ND_DATA (91 << 16)
#define ND_VERTEX_GROUP (92 << 16)
 
/* NC_NODE Nodes */
 
/* NC_SPACE */
#define ND_SPACE_CONSOLE (1 << 16)     /* general redraw */
#define ND_SPACE_INFO_REPORT (2 << 16) /* update for reports, could specify type */
#define ND_SPACE_INFO (3 << 16)
#define ND_SPACE_IMAGE (4 << 16)
#define ND_SPACE_FILE_PARAMS (5 << 16)
#define ND_SPACE_FILE_LIST (6 << 16)
#define ND_SPACE_ASSET_PARAMS (7 << 16)
#define ND_SPACE_NODE (8 << 16)
#define ND_SPACE_OUTLINER (9 << 16)
#define ND_SPACE_VIEW3D (10 << 16)
#define ND_SPACE_PROPERTIES (11 << 16)
#define ND_SPACE_TEXT (12 << 16)
#define ND_SPACE_TIME (13 << 16)
#define ND_SPACE_GRAPH (14 << 16)
#define ND_SPACE_DOPESHEET (15 << 16)
#define ND_SPACE_NLA (16 << 16)
#define ND_SPACE_SEQUENCER (17 << 16)
#define ND_SPACE_NODE_VIEW (18 << 16)
#define ND_SPACE_CHANGED (19 << 16) /*sent to a new editor type after it's replaced an old one*/
#define ND_SPACE_CLIP (20 << 16)
#define ND_SPACE_FILE_PREVIEW (21 << 16)
#define ND_SPACE_SPREADSHEET (22 << 16)
 
/* subtype, 256 entries too */
#define NOTE_SUBTYPE 0x0000FF00
 
/* subtype scene mode */
#define NS_MODE_OBJECT (1 << 8)
 
#define NS_EDITMODE_MESH (2 << 8)
#define NS_EDITMODE_CURVE (3 << 8)
#define NS_EDITMODE_SURFACE (4 << 8)
#define NS_EDITMODE_TEXT (5 << 8)
#define NS_EDITMODE_MBALL (6 << 8)
#define NS_EDITMODE_LATTICE (7 << 8)
#define NS_EDITMODE_ARMATURE (8 << 8)
#define NS_MODE_POSE (9 << 8)
#define NS_MODE_PARTICLE (10 << 8)
 
/* subtype 3d view editing */
#define NS_VIEW3D_GPU (16 << 8)
#define NS_VIEW3D_SHADING (17 << 8)
 
/* subtype layer editing */
#define NS_LAYER_COLLECTION (24 << 8)
 
/* action classification */
#define NOTE_ACTION (0x000000FF)
#define NA_EDITED 1
#define NA_EVALUATED 2
#define NA_ADDED 3
#define NA_REMOVED 4
#define NA_RENAME 5
#define NA_SELECTED 6
#define NA_ACTIVATED 7
#define NA_PAINTING 8
#define NA_JOB_FINISHED 9
 
/* ************** Gesture Manager data ************** */
 
/* wmGesture->type */
#define WM_GESTURE_TWEAK 0
#define WM_GESTURE_LINES 1
#define WM_GESTURE_RECT 2
#define WM_GESTURE_CROSS_RECT 3
#define WM_GESTURE_LASSO 4
#define WM_GESTURE_CIRCLE 5
#define WM_GESTURE_STRAIGHTLINE 6
 
typedef struct wmGesture {
  struct wmGesture *next, *prev;
  int event_type;
  int type;
  rcti winrct;
  int points;
  int points_alloc;
  int modal_state;
  bool draw_active_side;
 
  uint is_active : 1;
  uint is_active_prev : 1;
  uint wait_for_input : 1;
  uint move : 1;
  uint use_snap : 1;
  uint use_flip : 1;
 
  void *customdata;
 
  wmGenericUserData user_data;
} wmGesture;
 
/* ************** wmEvent ************************ */
 
typedef struct wmTabletData {
  int active;
  float pressure;
  float x_tilt;
  float y_tilt;
  char is_motion_absolute;
} wmTabletData;
 
typedef struct wmEvent {
  struct wmEvent *next, *prev;
 
  short type;
  short val;
  int x, y;
  int mval[2];
  char utf8_buf[6];
  char ascii;
 
  char is_repeat;
 
  short prevtype;
  short prevval;
  double prevclicktime;
  int prevclickx, prevclicky;
  int prevx, prevy;
 
  short shift, ctrl, alt, oskey;
  short keymodifier;
 
  wmTabletData tablet;
 
  /* Custom data. */
  short custom;
  short customdatafree;
  int pad2;
  void *customdata;
 
  char is_direction_inverted;
} wmEvent;
 
#define WM_EVENT_CURSOR_MOTION_THRESHOLD ((float)U.move_threshold * U.dpi_fac)
 
typedef enum {
  P_NOT_STARTED,
  P_STARTING,    /* <-- */
  P_IN_PROGRESS, /* <-- only these are sent for NDOF motion. */
  P_FINISHING,   /* <-- */
  P_FINISHED,
} wmProgress;
 
#ifdef WITH_INPUT_NDOF
typedef struct wmNDOFMotionData {
  /* awfully similar to GHOST_TEventNDOFMotionData... */
  float tvec[3];
  float rvec[3];
  float dt;
  wmProgress progress;
} wmNDOFMotionData;
#endif /* WITH_INPUT_NDOF */
 
typedef enum {
  WM_TIMER_NO_FREE_CUSTOM_DATA = 1 << 0,
} wmTimerFlags;
 
typedef struct wmTimer {
  struct wmTimer *next, *prev;
 
  struct wmWindow *win;
 
  double timestep;
  int event_type;
  wmTimerFlags flags;
  void *customdata;
 
  double duration;
  double delta;
 
  double ltime;
  double ntime;
  double stime;
  bool sleep;
} wmTimer;
 
typedef struct wmOperatorType {
  const char *name;
  const char *idname;
  const char *translation_context;
  const char *description;
  const char *undo_group;
 
  int (*exec)(struct bContext *, struct wmOperator *) ATTR_WARN_UNUSED_RESULT;
 
  bool (*check)(struct bContext *, struct wmOperator *);
 
  int (*invoke)(struct bContext *,
                struct wmOperator *,
                const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
 
  void (*cancel)(struct bContext *, struct wmOperator *);
 
  int (*modal)(struct bContext *,
               struct wmOperator *,
               const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
 
  bool (*poll)(struct bContext *) ATTR_WARN_UNUSED_RESULT;
 
  bool (*poll_property)(const struct bContext *C,
                        struct wmOperator *op,
                        const PropertyRNA *prop) ATTR_WARN_UNUSED_RESULT;
 
  void (*ui)(struct bContext *, struct wmOperator *);
 
  const char *(*get_name)(struct wmOperatorType *, struct PointerRNA *);
 
  char *(*get_description)(struct bContext *C, struct wmOperatorType *, struct PointerRNA *);
 
  struct StructRNA *srna;
 
  struct IDProperty *last_properties;
 
  PropertyRNA *prop;
 
  ListBase macro;
 
  struct wmKeyMap *modalkeymap;
 
  bool (*pyop_poll)(struct bContext *, struct wmOperatorType *ot) ATTR_WARN_UNUSED_RESULT;
 
  ExtensionRNA rna_ext;
 
  short flag;
 
} wmOperatorType;
 
typedef struct wmOperatorCallParams {
  struct wmOperatorType *optype;
  struct PointerRNA *opptr;
  short opcontext;
} wmOperatorCallParams;
 
#ifdef WITH_INPUT_IME
/* *********** Input Method Editor (IME) *********** */
typedef struct wmIMEData {
  size_t result_len, composite_len;
 
  char *str_result;
  char *str_composite;
 
  int cursor_pos;
  int sel_start;
  int sel_end;
 
  bool is_ime_composing;
} wmIMEData;
#endif
 
/* **************** Paint Cursor ******************* */
 
typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
 
/* *************** Drag and drop *************** */
 
#define WM_DRAG_ID 0
#define WM_DRAG_ASSET 1
#define WM_DRAG_RNA 2
#define WM_DRAG_PATH 3
#define WM_DRAG_NAME 4
#define WM_DRAG_VALUE 5
#define WM_DRAG_COLOR 6
#define WM_DRAG_DATASTACK 7
 
typedef enum wmDragFlags {
  WM_DRAG_NOP = 0,
  WM_DRAG_FREE_DATA = 1,
} wmDragFlags;
 
/* note: structs need not exported? */
 
typedef struct wmDragID {
  struct wmDragID *next, *prev;
  struct ID *id;
  struct ID *from_parent;
} wmDragID;
 
typedef struct wmDragAsset {
  char name[64]; /* MAX_NAME */
  /* Always freed. */
  const char *path;
  int id_type;
} wmDragAsset;
 
typedef struct wmDrag {
  struct wmDrag *next, *prev;
 
  int icon;
  int type;
  void *poin;
  char path[1024]; /* FILE_MAX */
  double value;
 
  struct ImBuf *imb;
  float scale;
  int sx, sy;
 
  char opname[200];
  unsigned int flags;
 
  ListBase ids;
} wmDrag;
 
typedef struct wmDropBox {
  struct wmDropBox *next, *prev;
 
  bool (*poll)(struct bContext *, struct wmDrag *, const wmEvent *, const char **);
 
  void (*copy)(struct wmDrag *, struct wmDropBox *);
 
  void (*cancel)(struct Main *, struct wmDrag *, struct wmDropBox *);
 
  wmOperatorType *ot;
 
  struct IDProperty *properties;
  struct PointerRNA *ptr;
 
  short opcontext;
 
} wmDropBox;
 
typedef struct wmTooltipState {
  struct wmTimer *timer;
  struct ScrArea *area_from;
  struct ARegion *region_from;
  struct ARegion *region;
  struct ARegion *(*init)(struct bContext *C,
                          struct ARegion *region,
                          int *pass,
                          double *pass_delay,
                          bool *r_exit_on_event);
  bool exit_on_event;
  int event_xy[2];
  int pass;
} wmTooltipState;
 
/* *************** migrated stuff, clean later? ************** */
 
typedef struct RecentFile {
  struct RecentFile *next, *prev;
  char *filepath;
} RecentFile;
 
/* Logging */
struct CLG_LogRef;
/* wm_init_exit.c */
extern struct CLG_LogRef *WM_LOG_OPERATORS;
extern struct CLG_LogRef *WM_LOG_HANDLERS;
extern struct CLG_LogRef *WM_LOG_EVENTS;
extern struct CLG_LogRef *WM_LOG_KEYMAPS;
extern struct CLG_LogRef *WM_LOG_TOOLS;
extern struct CLG_LogRef *WM_LOG_MSGBUS_PUB;
extern struct CLG_LogRef *WM_LOG_MSGBUS_SUB;
 
#ifdef __cplusplus
}
#endif