== Grease Pencil ==

Grease Pencil is a tool which allows you to draw freehand in some views, allowing you to annotate/scribble over the contents of that view in either 2d or 3d. This facilitates many easier communication and planning abilities.

To use, simply enable it from the View menu (choose 'Grease Pencil...' and click 'Use Grease Pencil'). Then, click+drag using the left-mouse button and the shift-key held to draw a stroke.

For more information, check the following page on the wiki:
http://wiki.blender.org/index.php/User:Aligorith/247_Grease_Pencil

5 files changed, 182 insertions, 4 deletions

diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h
index 18d2a1cb6f3..d7969a7379b 100644
--- a/source/blender/makesdna/DNA_action_types.h
+++ b/source/blender/makesdna/DNA_action_types.h
@@ -32,6 +32,7 @@
 
 #include "DNA_listBase.h"
 #include "DNA_ID.h"
+#include "DNA_gpencil_types.h"
 #include "DNA_view2d_types.h"
 #include "DNA_userdef_types.h"
 
@@ -183,8 +184,11 @@ typedef struct SpaceAction {
 	View2D v2d;	
 	
 	bAction		*action;		/* the currently active action */
-	short flag, autosnap;		/* flag: bitmapped settings; autosnap: automatic keyframe snapping mode */
-	short pin, actnr, lock;		/* pin: keep showing current action; actnr: used for finding chosen action from menu; lock: lock time to other windows */
+	bGPdata 	*gpd;		/* the currently active gpencil block (for editing) */
+	
+	char  mode, autosnap;		/* mode: editing context; autosnap: automatic keyframe snapping mode   */
+	short flag, actnr; 			/* flag: bitmapped settings; */
+	short pin, lock;			/* pin: keep showing current action; actnr: used for finding chosen action from menu; lock: lock time to other windows */
 	short actwidth;				/* width of the left-hand side name panel (in pixels?) */
 	float timeslide;			/* for Time-Slide transform mode drawing - current frame? */
 } SpaceAction;
@@ -238,6 +242,18 @@ typedef enum SACTION_FLAG {
 	SACTION_NODRAWGCOLORS = (1<<7)
 } SACTION_FLAG;	
 
+/* SpaceAction Mode Settings */
+typedef enum SACTCONT_MODES {
+		/* action (default) */
+	SACTCONT_ACTION	= 0,
+		/* editing of shapekey's IPO block */
+	SACTCONT_SHAPEKEY,
+		/* editing of gpencil data */
+	SACTCONT_GPENCIL,
+		/* dopesheet (unimplemented... future idea?) */
+	SACTCONT_DOPESHEET
+} SACTCONTEXT_MODES;
+
 /* SpaceAction AutoSnap Settings (also used by SpaceNLA) */
 typedef enum SACTSNAP_MODES {
 		/* no auto-snap */
diff --git a/source/blender/makesdna/DNA_gpencil_types.h b/source/blender/makesdna/DNA_gpencil_types.h
new file mode 100644
index 00000000000..eafd886981b
--- /dev/null
+++ b/source/blender/makesdna/DNA_gpencil_types.h
@@ -0,0 +1,141 @@
+/**
+ * $Id: DNA_gpencil_types.h 8768 2006-11-07 00:10:37Z aligorith $
+ *
+ * ***** 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,
+ * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ * The Original Code is Copyright (C) 2008, Blender Foundation.
+ * This is a new part of Blender
+ *
+ * Contributor(s): Joshua Leung
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+#ifndef DNA_GPENCIL_TYPES_H
+#define DNA_GPENCIL_TYPES_H
+
+#include "DNA_listBase.h"
+#include "DNA_ID.h"
+
+/* Grease-Pencil Annotations - 'Stroke Point'
+ *	-> Coordinates may either be 2d or 3d depending on settings at the time
+ * 	-> Coordinates of point on stroke, in proportions of window size
+ *		(i.e. n/1000). This assumes that the bottom-left corner is (0,0)
+ */
+typedef struct bGPDspoint {
+	float x, y, z;			/* co-ordinates of point (usually 2d, but can be 3d as well) */				
+	float pressure;			/* pressure of input device (from 0 to 1) at this point */
+} bGPDspoint;
+
+/* Grease-Pencil Annotations - 'Stroke'
+ * 	-> A stroke represents a (simplified version) of the curve
+ *	   drawn by the user in one 'mousedown'->'mouseup' operation
+ */
+typedef struct bGPDstroke {
+	struct bGPDstroke *next, *prev;
+	
+	bGPDspoint *points;		/* array of data-points for stroke */
+	int totpoints;			/* number of data-points in array */
+	
+	short thickness;		/* thickness of stroke (currently not used) */	
+	short flag;				/* various settings about this stroke */
+} bGPDstroke;
+
+/* bGPDstroke->flag */
+	/* stroke is in 3d-space */
+#define GP_STROKE_3DSPACE		(1<<0)
+	/* stroke is in 2d-space */
+#define GP_STROKE_2DSPACE		(1<<1)
+
+
+/* Grease-Pencil Annotations - 'Frame'
+ *	-> Acts as storage for the 'image' formed by strokes
+ */
+typedef struct bGPDframe {
+	struct bGPDframe *next, *prev;
+	
+	ListBase strokes;	/* list of the simplified 'strokes' that make up the frame's data */
+	
+	int framenum;		/* frame number of this frame */
+	int flag;			/* temp settings */
+} bGPDframe;
+
+/* bGPDframe->flag */	
+	/* frame is being painted on */
+#define GP_FRAME_PAINT		(1<<0)
+	/* for editing in Action Editor */
+#define GP_FRAME_SELECT		(1<<1)
+
+
+/* Grease-Pencil Annotations - 'Layer' */
+typedef struct bGPDlayer {
+	struct bGPDlayer *next, *prev;
+	
+	ListBase frames;		/* list of annotations to display for frames (bGPDframe list) */
+	bGPDframe *actframe;	/* active frame (should be the frame that is currently being displayed) */
+	
+	int flag;				/* settings for layer */		
+	short thickness;		/* current thickness to apply to strokes */
+	short gstep;			/* max number of frames between active and ghost to show (0=only those on either side) */
+	
+	float color[4];			/* color that should be used to draw all the strokes in this layer */
+	
+	char info[128];			/* optional reference info about this layer (i.e. "director's comments, 12/3") */
+} bGPDlayer;
+
+/* bGPDlayer->flag */
+	/* don't display layer */
+#define GP_LAYER_HIDE		(1<<0)
+	/* protected from further editing */
+#define GP_LAYER_LOCKED		(1<<1)	
+	/* layer is 'active' layer being edited */
+#define GP_LAYER_ACTIVE		(1<<2)
+	/* draw points of stroke for debugging purposes */
+#define GP_LAYER_DRAWDEBUG 	(1<<3)
+	/* do onionskinning */
+#define GP_LAYER_ONIONSKIN	(1<<4)
+	/* for editing in Action Editor */
+#define GP_LAYER_SELECT		(1<<5)
+
+
+/* Grease-Pencil Annotations - 'DataBlock' */
+typedef struct bGPdata {
+	/* saved Grease-Pencil data */
+	ListBase layers;		/* bGPDlayers */
+	int flag;				/* settings for this datablock */
+	
+	/* not-saved stroke buffer data (only used during paint-session) 
+	 * 	- buffer must be initialised before use, but freed after 
+	 *	  whole paint operation is over
+	 */
+	short sbuffer_size;			/* number of elements currently in cache */
+	short sbuffer_sflag;		/* flags for stroke that cache represents */
+	bGPDspoint *sbuffer;		/* stroke buffer (can hold GP_STROKE_BUFFER_MAX) */
+} bGPdata;
+
+/* bGPdata->flag */
+	/* draw this datablock's data (not used) */
+#define GP_DATA_DISP		(1<<0)
+	/* show debugging info in viewport (i.e. status print) */
+#define GP_DATA_DISPINFO	(1<<1)
+	/* is the block being shown in Action Editor */
+#define GP_DATA_EDITTIME	(1<<2)
+	/* is the block overriding all clicks? */
+#define GP_DATA_EDITPAINT	(1<<3)
+	/* new strokes are added in viewport space */
+#define GP_DATA_VIEWALIGN	(1<<4)
+
+#endif /*  DNA_GPENCIL_TYPES_H */
diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h
index bc30a12ff27..a8694dfb7f5 100644
--- a/source/blender/makesdna/DNA_space_types.h
+++ b/source/blender/makesdna/DNA_space_types.h
@@ -50,6 +50,7 @@ struct RenderInfo;
 struct bNodeTree;
 struct uiBlock;
 struct FileList;
+struct bGPdata;
 
 	/**
 	 * The base structure all the other spaces
@@ -150,6 +151,8 @@ typedef struct SpaceSeq {
 	short zebra;
 	int flag;
 	float zoom;
+	
+	struct bGPdata *gpd;		/* grease-pencil data */
 } SpaceSeq;
 
 typedef struct SpaceFile {
@@ -339,6 +342,8 @@ typedef struct SpaceNode {
 	float blockscale;
 	struct ScrArea *area;
 	
+	short blockhandler[8];
+	
 	View2D v2d;
 	
 	struct ID *id, *from;		/* context, no need to save in file? well... pinning... */
@@ -351,11 +356,13 @@ typedef struct SpaceNode {
 	struct bNodeTree *nodetree, *edittree;
 	int treetype, pad;			/* treetype: as same nodetree->type */
 	
+	struct bGPdata *gpd;		/* grease-pencil data */
 } SpaceNode;
 
 /* snode->flag */
 #define SNODE_DO_PREVIEW	1
 #define SNODE_BACKDRAW		2
+#define SNODE_DISPGP		4
 
 typedef struct SpaceImaSel {
 	SpaceLink *next, *prev;
@@ -657,6 +664,7 @@ typedef struct SpaceImaSel {
 #define SEQ_MARKER_TRANS 2
 #define SEQ_DRAW_COLOR_SEPERATED     4
 #define SEQ_DRAW_SAFE_MARGINS        8
+#define SEQ_DRAW_GPENCIL			16
 
 /* space types, moved from DNA_screen_types.h */
 enum {
diff --git a/source/blender/makesdna/DNA_view3d_types.h b/source/blender/makesdna/DNA_view3d_types.h
index c21d629be83..135272b9ac2 100644
--- a/source/blender/makesdna/DNA_view3d_types.h
+++ b/source/blender/makesdna/DNA_view3d_types.h
@@ -40,6 +40,7 @@ struct Base;
 struct BoundBox;
 struct RenderInfo;
 struct RetopoViewData;
+struct bGPdata;
 
 /* This is needed to not let VC choke on near and far... old
  * proprietary MS extensions... */
@@ -53,9 +54,12 @@ struct RetopoViewData;
 #include "DNA_listBase.h"
 #include "DNA_image_types.h"
 
+/* ******************************** */
+
 /* The near/far thing is a Win EXCEPTION. Thus, leave near/far in the
  * code, and patch for windows. */
-
+ 
+/* Background Picture in 3D-View */
 typedef struct BGpic {
     struct Image *ima;
 	struct ImageUser iuser;
@@ -63,6 +67,9 @@ typedef struct BGpic {
     short xim, yim;
 } BGpic;
 
+/* ********************************* */
+
+/* 3D ViewPort Struct */
 typedef struct View3D {
 	struct SpaceLink *next, *prev;
 	int spacetype;
@@ -135,9 +142,10 @@ typedef struct View3D {
 	char ndoffilter;		/*filter for 6DOF devices 0 normal, 1 dominant */
 	
 	void *properties_storage;	/* Nkey panel stores stuff here, not in file */
-
+	struct bGPdata *gpd;		/* Grease-Pencil Data (annotation layers) */
 } View3D;
 
+
 /* View3D->flag (short) */
 #define V3D_MODE			(16+32+64+128+256+512)
 #define V3D_DISPIMAGE		1
@@ -158,10 +166,12 @@ typedef struct View3D {
 #define V3D_DRAW_CENTERS	32768
 
 /* View3d->flag2 (short) */
+#define V3D_MODE2			(32)
 #define V3D_OPP_DIRECTION_NAME	1
 #define V3D_FLYMODE				2
 #define V3D_DEPRECATED			4 /* V3D_TRANSFORM_SNAP, moved to a scene setting */
 #define V3D_SOLID_TEX			8
+#define V3D_DISPGP				16
 
 /* View3D->around */
 #define V3D_CENTER		 0
@@ -203,3 +213,4 @@ typedef struct View3D {
 
 #endif
 
+
diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c
index 83f4e633fa1..3818d66b39c 100644
--- a/source/blender/makesdna/intern/makesdna.c
+++ b/source/blender/makesdna/intern/makesdna.c
@@ -126,6 +126,7 @@ char *includefiles[] = {
 	"DNA_customdata_types.h",
 	"DNA_particle_types.h",
 	"DNA_cloth_types.h",
+	"DNA_gpencil_types.h",
 	// if you add files here, please add them at the end
 	// of makesdna.c (this file) as well
 
@@ -1147,4 +1148,5 @@ int main(int argc, char ** argv)
 #include "DNA_customdata_types.h"
 #include "DNA_particle_types.h"
 #include "DNA_cloth_types.h"
+#include "DNA_gpencil_types.h"
 /* end of list */