2011-02-18 14:05:18 +01:00
|
|
|
/*
|
2009-04-20 12:20:18 +02:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
|
|
|
*
|
|
|
|
|
* 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,
|
2010-02-12 14:34:04 +01:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2009-04-20 12:20:18 +02:00
|
|
|
*
|
|
|
|
|
* The Original Code is Copyright (C) 2008, Blender Foundation
|
|
|
|
|
* This is a new part of Blender
|
|
|
|
|
*
|
|
|
|
|
* Contributor(s): Joshua Leung
|
|
|
|
|
*
|
|
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
|
|
|
*/
|
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __BKE_GPENCIL_H__
|
|
|
|
|
#define __BKE_GPENCIL_H__
|
2009-04-20 12:20:18 +02:00
|
|
|
|
2011-02-18 14:05:18 +01:00
|
|
|
/** \file BKE_gpencil.h
|
|
|
|
|
* \ingroup bke
|
|
|
|
|
* \author Joshua Leung
|
|
|
|
|
*/
|
|
|
|
|
|
2016-08-03 23:31:48 +02:00
|
|
|
struct ToolSettings;
|
2009-04-20 12:20:18 +02:00
|
|
|
struct ListBase;
|
|
|
|
|
struct bGPdata;
|
|
|
|
|
struct bGPDlayer;
|
|
|
|
|
struct bGPDframe;
|
Grease Pencil - Storyboarding Features (merge from GPencil_EditStrokes branch)
This merge-commit brings in a number of new features and workflow/UI improvements for
working with Grease Pencil. While these were originally targetted at improving
the workflow for creating 3D storyboards in Blender using the Grease Pencil,
many of these changes should also prove useful in other workflows too.
The main highlights here are:
1) It is now possible to edit Grease Pencil strokes
- Use D Tab, or toggle the "Enable Editing" toggles in the Toolbar/Properties regions
to enter "Stroke Edit Mode". In this mode, many common editing tools will
operate on Grease Pencil stroke points instead.
- Tools implemented include Select, Select All/Border/Circle/Linked/More/Less,
Grab, Rotate, Scale, Bend, Shear, To Sphere, Mirror, Duplicate, Delete.
- Proportional Editing works when using the transform tools
2) Grease Pencil stroke settings can now be animated
NOTE: Currently drivers don't work, but if time allows, this may still be
added before the release.
3) Strokes can be drawn with "filled" interiors, using a separate set of
colour/opacity settings to the ones used for the lines themselves.
This makes use of OpenGL filled polys, which has the limitation of only
being able to fill convex shapes. Some artifacts may be visible on concave
shapes (e.g. pacman's mouth will be overdrawn)
4) "Volumetric Strokes" - An alternative drawing technique for stroke drawing
has been added which draws strokes as a series of screen-aligned discs.
While this was originally a partial experimental technique at getting better
quality 3D lines, the effects possible using this technique were interesting
enough to warrant making this a dedicated feature. Best results when partial
opacity and large stroke widths are used.
5) Improved Onion Skinning Support
- Different colours can be selected for the before/after ghosts. To do so,
enable the "colour wheel" toggle beside the Onion Skinning toggle, and set
the colours accordingly.
- Different numbers of ghosts can be shown before/after the current frame
6) Grease Pencil datablocks are now attached to the scene by default instead of
the active object.
- For a long time, the object-attachment has proved to be quite problematic
for users to keep track of. Now that this is done at scene level, it is
easier for most users to use.
- An exception for old files (and for any addons which may benefit from object
attachment instead), is that if the active object has a Grease Pencil datablock,
that will be used instead.
- It is not currently possible to choose object-attachment from the UI, but
it is simple to do this from the console instead, by doing:
context.active_object.grease_pencil = bpy.data.grease_pencil["blah"]
7) Various UI Cleanups
- The layers UI has been cleaned up to use a list instead of the nested-panels
design. Apart from saving space, this is also much nicer to look at now.
- The UI code is now all defined in Python. To support this, it has been necessary
to add some new context properties to make it easier to access these settings.
e.g. "gpencil_data" for the datablock
"active_gpencil_layer" and "active_gpencil_frame" for active data,
"editable_gpencil_strokes" for the strokes that can be edited
- The "stroke placement/alignment" settings (previously "Drawing Settings" at the
bottom of the Grease Pencil panel in the Properties Region) is now located in
the toolbar. These were more toolsettings than properties for how GPencil got drawn.
- "Use Sketching Sessions" has been renamed "Continuous Drawing", as per a
suggestion for an earlier discussion on developer.blender.org
- By default, the painting operator will wait for a mouse button to be pressed
before it starts creating the stroke. This is to make it easier to include
this operator in various toolbars/menus/etc. To get it immediately starting
(as when you hold down DKEy to draw), set "wait_for_input" to False.
- GPencil Layers can be rearranged in the "Grease Pencil" mode of the Action Editor
- Toolbar panels have been added to all the other editors which support these.
8) Pie menus for quick-access to tools
A set of experimental pie menus has been included for quick access to many
tools and settings. It is not necessary to use these to get things done,
but they have been designed to help make certain common tasks easier.
- Ctrl-D = The main pie menu. Reveals tools in a context sensitive and
spatially stable manner.
- D Q = "Quick Settings" pie. This allows quick access to the active
layer's settings. Notably, colours, thickness, and turning
onion skinning on/off.
2014-11-30 13:52:06 +01:00
|
|
|
struct bGPDstroke;
|
2016-08-03 23:31:48 +02:00
|
|
|
struct bGPDpalette;
|
|
|
|
|
struct bGPDpalettecolor;
|
2016-07-10 14:52:00 +02:00
|
|
|
struct Main;
|
2009-04-20 12:20:18 +02:00
|
|
|
|
|
|
|
|
/* ------------ Grease-Pencil API ------------------ */
|
|
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
void BKE_gpencil_free_stroke(struct bGPDstroke *gps);
|
|
|
|
|
bool BKE_gpencil_free_strokes(struct bGPDframe *gpf);
|
|
|
|
|
void BKE_gpencil_free_frames(struct bGPDlayer *gpl);
|
|
|
|
|
void BKE_gpencil_free_layers(struct ListBase *list);
|
|
|
|
|
void BKE_gpencil_free_brushes(struct ListBase *list);
|
|
|
|
|
void BKE_gpencil_free_palettes(struct ListBase *list);
|
2016-08-03 23:31:48 +02:00
|
|
|
void BKE_gpencil_free(struct bGPdata *gpd, bool free_palettes);
|
2009-04-20 12:20:18 +02:00
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
void BKE_gpencil_stroke_sync_selection(struct bGPDstroke *gps);
|
Grease Pencil - Storyboarding Features (merge from GPencil_EditStrokes branch)
This merge-commit brings in a number of new features and workflow/UI improvements for
working with Grease Pencil. While these were originally targetted at improving
the workflow for creating 3D storyboards in Blender using the Grease Pencil,
many of these changes should also prove useful in other workflows too.
The main highlights here are:
1) It is now possible to edit Grease Pencil strokes
- Use D Tab, or toggle the "Enable Editing" toggles in the Toolbar/Properties regions
to enter "Stroke Edit Mode". In this mode, many common editing tools will
operate on Grease Pencil stroke points instead.
- Tools implemented include Select, Select All/Border/Circle/Linked/More/Less,
Grab, Rotate, Scale, Bend, Shear, To Sphere, Mirror, Duplicate, Delete.
- Proportional Editing works when using the transform tools
2) Grease Pencil stroke settings can now be animated
NOTE: Currently drivers don't work, but if time allows, this may still be
added before the release.
3) Strokes can be drawn with "filled" interiors, using a separate set of
colour/opacity settings to the ones used for the lines themselves.
This makes use of OpenGL filled polys, which has the limitation of only
being able to fill convex shapes. Some artifacts may be visible on concave
shapes (e.g. pacman's mouth will be overdrawn)
4) "Volumetric Strokes" - An alternative drawing technique for stroke drawing
has been added which draws strokes as a series of screen-aligned discs.
While this was originally a partial experimental technique at getting better
quality 3D lines, the effects possible using this technique were interesting
enough to warrant making this a dedicated feature. Best results when partial
opacity and large stroke widths are used.
5) Improved Onion Skinning Support
- Different colours can be selected for the before/after ghosts. To do so,
enable the "colour wheel" toggle beside the Onion Skinning toggle, and set
the colours accordingly.
- Different numbers of ghosts can be shown before/after the current frame
6) Grease Pencil datablocks are now attached to the scene by default instead of
the active object.
- For a long time, the object-attachment has proved to be quite problematic
for users to keep track of. Now that this is done at scene level, it is
easier for most users to use.
- An exception for old files (and for any addons which may benefit from object
attachment instead), is that if the active object has a Grease Pencil datablock,
that will be used instead.
- It is not currently possible to choose object-attachment from the UI, but
it is simple to do this from the console instead, by doing:
context.active_object.grease_pencil = bpy.data.grease_pencil["blah"]
7) Various UI Cleanups
- The layers UI has been cleaned up to use a list instead of the nested-panels
design. Apart from saving space, this is also much nicer to look at now.
- The UI code is now all defined in Python. To support this, it has been necessary
to add some new context properties to make it easier to access these settings.
e.g. "gpencil_data" for the datablock
"active_gpencil_layer" and "active_gpencil_frame" for active data,
"editable_gpencil_strokes" for the strokes that can be edited
- The "stroke placement/alignment" settings (previously "Drawing Settings" at the
bottom of the Grease Pencil panel in the Properties Region) is now located in
the toolbar. These were more toolsettings than properties for how GPencil got drawn.
- "Use Sketching Sessions" has been renamed "Continuous Drawing", as per a
suggestion for an earlier discussion on developer.blender.org
- By default, the painting operator will wait for a mouse button to be pressed
before it starts creating the stroke. This is to make it easier to include
this operator in various toolbars/menus/etc. To get it immediately starting
(as when you hold down DKEy to draw), set "wait_for_input" to False.
- GPencil Layers can be rearranged in the "Grease Pencil" mode of the Action Editor
- Toolbar panels have been added to all the other editors which support these.
8) Pie menus for quick-access to tools
A set of experimental pie menus has been included for quick access to many
tools and settings. It is not necessary to use these to get things done,
but they have been designed to help make certain common tasks easier.
- Ctrl-D = The main pie menu. Reveals tools in a context sensitive and
spatially stable manner.
- D Q = "Quick Settings" pie. This allows quick access to the active
layer's settings. Notably, colours, thickness, and turning
onion skinning on/off.
2014-11-30 13:52:06 +01:00
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
struct bGPDframe *BKE_gpencil_frame_addnew(struct bGPDlayer *gpl, int cframe);
|
|
|
|
|
struct bGPDframe *BKE_gpencil_frame_addcopy(struct bGPDlayer *gpl, int cframe);
|
|
|
|
|
struct bGPDlayer *BKE_gpencil_layer_addnew(struct bGPdata *gpd, const char *name, bool setactive);
|
|
|
|
|
struct bGPdata *BKE_gpencil_data_addnew(const char name[]);
|
2009-04-20 12:20:18 +02:00
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
struct bGPDframe *BKE_gpencil_frame_duplicate(const struct bGPDframe *gpf_src);
|
|
|
|
|
struct bGPDlayer *BKE_gpencil_layer_duplicate(const struct bGPDlayer *gpl_src);
|
Refactor ID copying (and to some extent, ID freeing).
This will allow much finer controll over how we copy data-blocks, from
full copy in Main database, to "lighter" ones (out of Main, inside an
already allocated datablock, etc.).
This commit also transfers a llot of what was previously handled by
per-ID-type custom code to generic ID handling code in BKE_library.
Hopefully will avoid in future inconsistencies and missing bits we had
all over the codebase in the past.
It also adds missing copying handling for a few types, most notably
Scene (which where using a fully customized handling previously).
Note that the type of allocation used during copying (regular in Main,
allocated but outside of Main, or not allocated by ID handling code at
all) is stored in ID's, which allows to handle them correctly when
freeing. This needs to be taken care of with caution when doing 'weird'
unusual things with ID copying and/or allocation!
As a final note, while rather noisy, this commit will hopefully not
break too much existing branches, old 'API' has been kept for the main
part, as a wrapper around new code. Cleaning it up will happen later.
Design task : T51804
Phab Diff: D2714
2017-08-07 16:39:55 +02:00
|
|
|
void BKE_gpencil_copy_data(struct Main *bmain, struct bGPdata *gpd_dst, const struct bGPdata *gpd_src, const int flag);
|
2017-06-14 22:36:30 +02:00
|
|
|
struct bGPdata *BKE_gpencil_data_duplicate(struct Main *bmain, const struct bGPdata *gpd, bool internal_copy);
|
2009-04-20 12:20:18 +02:00
|
|
|
|
2016-07-21 16:09:08 +02:00
|
|
|
void BKE_gpencil_make_local(struct Main *bmain, struct bGPdata *gpd, const bool lib_local);
|
|
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
void BKE_gpencil_frame_delete_laststroke(struct bGPDlayer *gpl, struct bGPDframe *gpf);
|
2009-04-20 12:20:18 +02:00
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
struct bGPDpalette *BKE_gpencil_palette_addnew(struct bGPdata *gpd, const char *name, bool setactive);
|
|
|
|
|
struct bGPDpalette *BKE_gpencil_palette_duplicate(const struct bGPDpalette *palette_src);
|
|
|
|
|
struct bGPDpalettecolor *BKE_gpencil_palettecolor_addnew(struct bGPDpalette *palette, const char *name, bool setactive);
|
2016-08-03 23:31:48 +02:00
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
struct bGPDbrush *BKE_gpencil_brush_addnew(struct ToolSettings *ts, const char *name, bool setactive);
|
|
|
|
|
struct bGPDbrush *BKE_gpencil_brush_duplicate(const struct bGPDbrush *brush_src);
|
|
|
|
|
void BKE_gpencil_brush_init_presets(struct ToolSettings *ts);
|
2016-08-03 23:31:48 +02:00
|
|
|
|
2015-12-13 09:03:13 +01:00
|
|
|
|
2016-02-08 14:44:02 +01:00
|
|
|
/* Stroke and Fill - Alpha Visibility Threshold */
|
|
|
|
|
#define GPENCIL_ALPHA_OPACITY_THRESH 0.001f
|
2016-08-03 23:31:48 +02:00
|
|
|
#define GPENCIL_STRENGTH_MIN 0.003f
|
2016-02-08 14:44:02 +01:00
|
|
|
|
|
|
|
|
bool gpencil_layer_is_editable(const struct bGPDlayer *gpl);
|
|
|
|
|
|
2015-12-13 09:03:13 +01:00
|
|
|
/* How gpencil_layer_getframe() should behave when there
|
|
|
|
|
* is no existing GP-Frame on the frame requested.
|
|
|
|
|
*/
|
|
|
|
|
typedef enum eGP_GetFrame_Mode {
|
|
|
|
|
/* Use the preceeding gp-frame (i.e. don't add anything) */
|
|
|
|
|
GP_GETFRAME_USE_PREV = 0,
|
|
|
|
|
|
|
|
|
|
/* Add a new empty/blank frame */
|
|
|
|
|
GP_GETFRAME_ADD_NEW = 1,
|
|
|
|
|
/* Make a copy of the active frame */
|
|
|
|
|
GP_GETFRAME_ADD_COPY = 2
|
|
|
|
|
} eGP_GetFrame_Mode;
|
|
|
|
|
|
2016-08-04 15:03:18 +02:00
|
|
|
struct bGPDframe *BKE_gpencil_layer_getframe(struct bGPDlayer *gpl, int cframe, eGP_GetFrame_Mode addnew);
|
2012-06-09 00:07:57 +02:00
|
|
|
struct bGPDframe *BKE_gpencil_layer_find_frame(struct bGPDlayer *gpl, int cframe);
|
2016-08-04 15:03:18 +02:00
|
|
|
bool BKE_gpencil_layer_delframe(struct bGPDlayer *gpl, struct bGPDframe *gpf);
|
|
|
|
|
|
|
|
|
|
struct bGPDlayer *BKE_gpencil_layer_getactive(struct bGPdata *gpd);
|
|
|
|
|
void BKE_gpencil_layer_setactive(struct bGPdata *gpd, struct bGPDlayer *active);
|
|
|
|
|
void BKE_gpencil_layer_delete(struct bGPdata *gpd, struct bGPDlayer *gpl);
|
|
|
|
|
|
|
|
|
|
struct bGPDbrush *BKE_gpencil_brush_getactive(struct ToolSettings *ts);
|
|
|
|
|
void BKE_gpencil_brush_setactive(struct ToolSettings *ts, struct bGPDbrush *active);
|
2016-12-19 12:28:51 +01:00
|
|
|
void BKE_gpencil_brush_delete(struct ToolSettings *ts, struct bGPDbrush *brush);
|
2016-08-04 15:03:18 +02:00
|
|
|
|
|
|
|
|
struct bGPDpalette *BKE_gpencil_palette_getactive(struct bGPdata *gpd);
|
|
|
|
|
void BKE_gpencil_palette_setactive(struct bGPdata *gpd, struct bGPDpalette *active);
|
|
|
|
|
void BKE_gpencil_palette_delete(struct bGPdata *gpd, struct bGPDpalette *palette);
|
|
|
|
|
void BKE_gpencil_palette_change_strokes(struct bGPdata *gpd);
|
|
|
|
|
|
|
|
|
|
struct bGPDpalettecolor *BKE_gpencil_palettecolor_getactive(struct bGPDpalette *palette);
|
|
|
|
|
void BKE_gpencil_palettecolor_setactive(struct bGPDpalette *palette, struct bGPDpalettecolor *active);
|
|
|
|
|
void BKE_gpencil_palettecolor_delete(struct bGPDpalette *palette, struct bGPDpalettecolor *palcolor);
|
|
|
|
|
struct bGPDpalettecolor *BKE_gpencil_palettecolor_getbyname(struct bGPDpalette *palette, char *name);
|
|
|
|
|
void BKE_gpencil_palettecolor_changename(struct bGPdata *gpd, char *oldname, const char *newname);
|
|
|
|
|
void BKE_gpencil_palettecolor_delete_strokes(struct bGPdata *gpd, char *name);
|
2016-08-03 23:31:48 +02:00
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#endif /* __BKE_GPENCIL_H__ */
|
