Page MenuHome
Differential D2889 Diff 9436 source/blender/editors/include/ED_gpencil.h

Changeset View

Standalone View

View Options

source/blender/editors/include/ED_gpencil.h

Show All 26 Lines
* \ingroup editors * \ingroup editors
*/ */
#ifndef __ED_GPENCIL_H__ #ifndef __ED_GPENCIL_H__
#define __ED_GPENCIL_H__ #define __ED_GPENCIL_H__
#include "ED_numinput.h" #include "ED_numinput.h"
struct ID;
struct ListBase;
struct bContext;
struct ScrArea;
struct ARegion; struct ARegion;
struct View3D; struct bAnimContext;
struct Object; struct bContext;
struct bGPdata; struct bGPdata;
struct bGPDlayer; struct bGPDlayer;
struct bGPDframe; struct bGPDframe;
struct bGPDstroke; struct bGPDstroke;
struct bGPDpalette; struct bGPDpalette;
struct bGPDpalettecolor; struct bGPDpalettecolor;
struct bAnimContext; struct bGPDspoint;
struct ID;
struct KeyframeEditData; struct KeyframeEditData;
struct ListBase;
struct Object;
struct Palette;
struct PaletteColor;
struct PointerRNA; struct PointerRNA;
struct wmWindowManager; struct RegionView3D;
struct ScrArea;
struct ToolSettings;
struct View3D;
struct wmKeyConfig; struct wmKeyConfig;
struct wmWindowManager;
/* ------------- Grease-Pencil Helpers ---------------- */ /* ------------- Grease-Pencil Helpers ---------------- */
typedef struct tGPDinterpolate_layer { typedef struct tGPDinterpolate_layer {
struct tGPDinterpolate_layer *next, *prev; struct tGPDinterpolate_layer *next, *prev;
struct bGPDlayer *gpl; /* layer */ struct bGPDlayer *gpl; /* layer */
struct bGPDframe *prevFrame; /* frame before current frame (interpolate-from) */ struct bGPDframe *prevFrame; /* frame before current frame (interpolate-from) */
struct bGPDframe *nextFrame; /* frame after current frame (interpolate-to) */ struct bGPDframe *nextFrame; /* frame after current frame (interpolate-to) */
struct bGPDframe *interFrame; /* interpolated frame */ struct bGPDframe *interFrame; /* interpolated frame */
float factor; /* interpolate factor */ float factor; /* interpolate factor */
} tGPDinterpolate_layer; } tGPDinterpolate_layer;
/* Temporary interpolate operation data */ /* Temporary interpolate operation data */
typedef struct tGPDinterpolate { typedef struct tGPDinterpolate {
struct Scene *scene; /* current scene from context */ struct Scene *scene; /* current scene from context */
struct ScrArea *sa; /* area where painting originated */ struct ScrArea *sa; /* area where painting originated */
struct ARegion *ar; /* region where painting originated */ struct ARegion *ar; /* region where painting originated */
struct bGPdata *gpd; /* current GP datablock */ struct bGPdata *gpd; /* current GP datablock */
struct Palette *palette; /* current palette */
int cframe; /* current frame number */ int cframe; /* current frame number */
ListBase ilayers; /* (tGPDinterpolate_layer) layers to be interpolated */ ListBase ilayers; /* (tGPDinterpolate_layer) layers to be interpolated */
float shift; /* value for determining the displacement influence */ float shift; /* value for determining the displacement influence */
float init_factor; /* initial interpolation factor for active layer */ float init_factor; /* initial interpolation factor for active layer */
float low_limit; /* shift low limit (-100%) */ float low_limit; /* shift low limit (-100%) */
float high_limit; /* shift upper limit (200%) */ float high_limit; /* shift upper limit (200%) */
int flag; /* flag from toolsettings */ int flag; /* flag from toolsettings */
NumInput num; /* numeric input */ NumInput num; /* numeric input */
void *draw_handle_3d; /* handle for drawing strokes while operator is running 3d stuff */ void *draw_handle_3d; /* handle for drawing strokes while operator is running 3d stuff */
void *draw_handle_screen; /* handle for drawing strokes while operator is running screen stuff */ void *draw_handle_screen; /* handle for drawing strokes while operator is running screen stuff */
} tGPDinterpolate; } tGPDinterpolate;
/* Temporary primitive operation data */
typedef struct tGPDprimitive {
struct Scene *scene; /* current scene from context */
struct Object *ob; /* current active gp object */
struct ScrArea *sa; /* area where painting originated */
struct RegionView3D *rv3d; /* region where painting originated */
struct View3D *v3d; /* view3 where painting originated */
struct ARegion *ar; /* region where painting originated */
struct bGPdata *gpd; /* current GP datablock */
struct Palette *palette; /* current palette */
struct PaletteColor *palcolor; /* current palette color */
struct bGPDbrush *brush; /* current brush */
int cframe; /* current frame number */
struct bGPDlayer *gpl; /* layer */
struct bGPDframe *gpf; /* frame */
int type; /* type of primitive */
int tot_edges; /* number of polygon edges */
int top[2]; /* first box corner */
int bottom[2]; /* last box corner */
int flag; /* flag to determine operations in progress */
short oldevent; /* save old event to avoid accidental mouse clicks */
int lock_axis; /* lock to viewport axis */
NumInput num; /* numeric input */
void *draw_handle_3d; /* handle for drawing strokes while operator is running 3d stuff */
} tGPDprimitive;
/* Temporary 'Stroke Point' data /* Temporary 'Stroke Point' data
* *
* Used as part of the 'stroke cache' used during drawing of new strokes * Used as part of the 'stroke cache' used during drawing of new strokes
*/ */
typedef struct tGPspoint { typedef struct tGPspoint {
int x, y; /* x and y coordinates of cursor (in relative to area) */ int x, y; /* x and y coordinates of cursor (in relative to area) */
float pressure; /* pressure of tablet at this point */ float pressure; /* pressure of tablet at this point */
float strength; /* pressure of tablet at this point for alpha factor */ float strength; /* pressure of tablet at this point for alpha factor */
float time; /* Time relative to stroke start (used when converting to path) */ float time; /* Time relative to stroke start (used when converting to path) */
} tGPspoint; } tGPspoint;
/* used to sort by zdepth gpencil objects in viewport */
/* TODO: this could be a system parameter in userprefs screen */
#define GP_CACHE_BLOCK_SIZE 16
typedef struct tGPencilSort {
struct Base *base;
float zdepth;
} tGPencilSort;
/* Check if 'sketching sessions' are enabled */ /* Check if 'sketching sessions' are enabled */
#define GPENCIL_SKETCH_SESSIONS_ON(scene) ((scene)->toolsettings->gpencil_flags & GP_TOOL_FLAG_PAINTSESSIONS_ON) #define GPENCIL_SKETCH_SESSIONS_ON(scene) ((scene)->toolsettings->gpencil_flags & GP_TOOL_FLAG_PAINTSESSIONS_ON)
/* Check if 'multiedit sessions' is enabled */
#define GPENCIL_MULTIEDIT_SESSIONS_ON(gpd) ((gpd) && (gpd->flag & (GP_DATA_STROKE_EDITMODE | GP_DATA_STROKE_SCULPTMODE | GP_DATA_STROKE_WEIGHTMODE)) && (gpd->flag & GP_DATA_STROKE_MULTIEDIT))
/* Macros to check grease pencil modes */
#define GPENCIL_ANY_MODE(gpd) ((gpd) && (gpd->flag & (GP_DATA_STROKE_PAINTMODE | GP_DATA_STROKE_EDITMODE | GP_DATA_STROKE_SCULPTMODE | GP_DATA_STROKE_WEIGHTMODE)))
#define GPENCIL_ANY_EDIT_MODE(gpd) ((gpd) && (gpd->flag & (GP_DATA_STROKE_EDITMODE | GP_DATA_STROKE_SCULPTMODE | GP_DATA_STROKE_WEIGHTMODE)))
#define GPENCIL_SCULPT_OR_WEIGHT_MODE(gpd) ((gpd) && (gpd->flag & (GP_DATA_STROKE_SCULPTMODE | GP_DATA_STROKE_WEIGHTMODE)))
#define GPENCIL_NONE_EDIT_MODE(gpd) ((gpd) && ((gpd->flag & (GP_DATA_STROKE_EDITMODE | GP_DATA_STROKE_SCULPTMODE | GP_DATA_STROKE_WEIGHTMODE)) == 0))
/* ----------- Grease Pencil Tools/Context ------------- */ /* ----------- Grease Pencil Tools/Context ------------- */
/* Context-dependent */ /* Context-dependent */
struct bGPdata **ED_gpencil_data_get_pointers(const struct bContext *C, struct PointerRNA *ptr); struct bGPdata **ED_gpencil_data_get_pointers(const struct bContext *C, struct PointerRNA *ptr);
struct bGPdata *ED_gpencil_data_get_active(const struct bContext *C); struct bGPdata *ED_gpencil_data_get_active(const struct bContext *C);
/* Context independent (i.e. each required part is passed in instead) */ /* Context independent (i.e. each required part is passed in instead) */
struct bGPdata **ED_gpencil_data_get_pointers_direct(struct ID *screen_id, struct Scene *scene, struct bGPdata **ED_gpencil_data_get_pointers_direct(struct ID *screen_id, struct Scene *scene,
struct ScrArea *sa, struct Object *ob, struct ScrArea *sa, struct Object *ob,
struct PointerRNA *ptr); struct PointerRNA *ptr);
struct bGPdata *ED_gpencil_data_get_active_direct(struct ID *screen_id, struct Scene *scene, struct bGPdata *ED_gpencil_data_get_active_direct(struct ID *screen_id, struct Scene *scene,
struct ScrArea *sa, struct Object *ob); struct ScrArea *sa, struct Object *ob);
/* 3D View */ /* 3D View */
struct bGPdata *ED_gpencil_data_get_active_v3d(struct Scene *scene, struct View3D *v3d); struct bGPdata *ED_gpencil_data_get_active_v3d(struct Scene *scene, struct View3D *v3d);
bool ED_gpencil_has_keyframe_v3d(struct Scene *scene, struct Object *ob, int cfra); bool ED_gpencil_has_keyframe_v3d(struct Scene *scene, struct Object *ob, int cfra);
/* ----------- Stroke Editing Utilities ---------------- */ /* ----------- Stroke Editing Utilities ---------------- */
bool ED_gpencil_stroke_can_use_direct(const struct ScrArea *sa, const struct bGPDstroke *gps); bool ED_gpencil_stroke_can_use_direct(const struct ScrArea *sa, const struct bGPDstroke *gps);
bool ED_gpencil_stroke_can_use(const struct bContext *C, const struct bGPDstroke *gps); bool ED_gpencil_stroke_can_use(const struct bContext *C, const struct bGPDstroke *gps);
bool ED_gpencil_stroke_color_use(const struct bGPDlayer *gpl, const struct bGPDstroke *gps); bool ED_gpencil_stroke_color_use(const struct bGPDlayer *gpl, const struct bGPDstroke *gps);
struct bGPDpalettecolor *ED_gpencil_stroke_getcolor(struct bGPdata *gpd, struct bGPDstroke *gps);
bool ED_gpencil_stroke_minmax( bool ED_gpencil_stroke_minmax(
const struct bGPDstroke *gps, const bool use_select, const struct bGPDstroke *gps, const bool use_select,
float r_min[3], float r_max[3]); float r_min[3], float r_max[3]);
/* ----------- Grease Pencil Operators ----------------- */ /* ----------- Grease Pencil Operators ----------------- */
void ED_keymap_gpencil(struct wmKeyConfig *keyconf); void ED_keymap_gpencil(struct wmKeyConfig *keyconf);
void ED_operatortypes_gpencil(void); void ED_operatortypes_gpencil(void);
void ED_operatormacros_gpencil(void); void ED_operatormacros_gpencil(void);
/* ------------- Copy-Paste Buffers -------------------- */ /* ------------- Copy-Paste Buffers -------------------- */
/* Strokes copybuf */ /* Strokes copybuf */
void ED_gpencil_strokes_copybuf_free(void); void ED_gpencil_strokes_copybuf_free(void);
/* ------------ Grease-Pencil Drawing API ------------------ */ /* ------------ Grease-Pencil Drawing API ------------------ */
/* drawgpencil.c */ /* drawgpencil.c */
void ED_gpencil_draw_2dimage(const struct bContext *C); void ED_gpencil_draw_2dimage(const struct bContext *C);
void ED_gpencil_draw_view2d(const struct bContext *C, bool onlyv2d); void ED_gpencil_draw_view2d(const struct bContext *C, bool onlyv2d);
void ED_gpencil_draw_view3d(struct wmWindowManager *wm, struct Scene *scene, struct View3D *v3d, struct ARegion *ar, bool only3d); void ED_gpencil_draw_view3d(struct wmWindowManager *wm, struct Scene *scene, struct View3D *v3d, struct ARegion *ar, bool only3d);
void ED_gpencil_draw_view3d_object(struct wmWindowManager *wm, struct Scene *scene, struct Object *ob, struct View3D *v3d, struct ARegion *ar, bool only3d);
void ED_gpencil_draw_ex(struct Scene *scene, struct bGPdata *gpd, int winx, int winy, void ED_gpencil_draw_ex(struct Scene *scene, struct bGPdata *gpd, int winx, int winy,
const int cfra, const char spacetype); const int cfra, const char spacetype);
void ED_gp_draw_interpolation(struct tGPDinterpolate *tgpi, const int type); void ED_gp_draw_interpolation(const struct bContext *C, struct tGPDinterpolate *tgpi, const int type);
void ED_gp_draw_primitives(const struct bContext *C, struct tGPDprimitive *tgpi, const int type);
/* ----------- Grease-Pencil AnimEdit API ------------------ */ /* ----------- Grease-Pencil AnimEdit API ------------------ */
bool ED_gplayer_frames_looper(struct bGPDlayer *gpl, struct Scene *scene, bool ED_gplayer_frames_looper(struct bGPDlayer *gpl, struct Scene *scene,
short (*gpf_cb)(struct bGPDframe *, struct Scene *)); short (*gpf_cb)(struct bGPDframe *, struct Scene *));
void ED_gplayer_make_cfra_list(struct bGPDlayer *gpl, ListBase *elems, bool onlysel); void ED_gplayer_make_cfra_list(struct bGPDlayer *gpl, ListBase *elems, bool onlysel);
bool ED_gplayer_frame_select_check(struct bGPDlayer *gpl); bool ED_gplayer_frame_select_check(struct bGPDlayer *gpl);
void ED_gplayer_frame_select_set(struct bGPDlayer *gpl, short mode); void ED_gplayer_frame_select_set(struct bGPDlayer *gpl, short mode);
Show All 16 Lines
/* ------------ Grease-Pencil Undo System ------------------ */ /* ------------ Grease-Pencil Undo System ------------------ */
int ED_gpencil_session_active(void); int ED_gpencil_session_active(void);
int ED_undo_gpencil_step(struct bContext *C, int step, const char *name); int ED_undo_gpencil_step(struct bContext *C, int step, const char *name);
/* ------------ Transformation Utilities ------------ */ /* ------------ Transformation Utilities ------------ */
/* get difference matrix using parent */ /* get difference matrix */
void ED_gpencil_parent_location(struct bGPDlayer *gpl, float diff_mat[4][4]); void ED_gpencil_parent_location(struct Object *obact, struct bGPdata *gpd, struct bGPDlayer *gpl, float diff_mat[4][4]);
/* reset parent matrix for all layers */ /* reset parent matrix for all layers */
void ED_gpencil_reset_layers_parent(struct bGPdata *gpd); void ED_gpencil_reset_layers_parent(struct Object *obact, struct bGPdata *gpd);
/* ----------- Add Primitive Utilities -------------- */
void ED_gpencil_create_monkey(struct bContext *C, struct bGPdata *gpd);
/* ------------ Object Utilities ------------ */
struct Object *ED_add_gpencil_object(struct bContext *C, struct Scene *scene, const float loc[3]);
void ED_gpencil_add_defaults(struct bContext *C);
struct tGPencilSort *ED_gpencil_allocate_cache(struct tGPencilSort *cache, int *gp_cache_size, int gp_cache_used);
void ED_gpencil_add_to_cache(struct tGPencilSort *cache, struct RegionView3D *rv3d, struct Base *base, int *gp_cache_used);
void ED_gp_project_stroke_to_plane(struct Object *ob, struct RegionView3D *rv3d, struct bGPDstroke *gps, const float origin[3], const int axis, char type);
void ED_gp_project_point_to_plane(struct Object *ob, struct RegionView3D *rv3d, const float origin[3], const int axis, char type, struct bGPDspoint *pt);
void ED_gp_get_drawing_reference(struct ToolSettings *ts, struct View3D *v3d, struct Scene *scene, struct Object *ob, struct bGPDlayer *gpl, char align_flag, float vec[3]);
/* set sculpt cursor */
void ED_gpencil_toggle_brush_cursor(struct bContext *C, bool enable);
/* vertex groups */
void ED_gpencil_vgroup_assign(struct bContext *C, struct Object *ob, float weight);
void ED_gpencil_vgroup_remove(struct bContext *C, struct Object *ob);
void ED_gpencil_vgroup_select(struct bContext *C, struct Object *ob);
void ED_gpencil_vgroup_deselect(struct bContext *C, struct Object *ob);
#endif /* __ED_GPENCIL_H__ */ #endif /* __ED_GPENCIL_H__ */