GSOC 2013 paint
[blender.git] / source / blender / makesdna / DNA_freestyle_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2010 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __DNA_FREESTYLE_TYPES_H__
29 #define __DNA_FREESTYLE_TYPES_H__
30
31 /** \file DNA_freestyle_types.h
32  *  \ingroup DNA
33  */
34
35 #include "DNA_defs.h"
36 #include "DNA_listBase.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct FreestyleLineStyle;
43 struct Group;
44 struct Text;
45
46 /* FreestyleConfig::flags */
47 #define FREESTYLE_SUGGESTIVE_CONTOURS_FLAG  (1 << 0)
48 #define FREESTYLE_RIDGES_AND_VALLEYS_FLAG   (1 << 1)
49 #define FREESTYLE_MATERIAL_BOUNDARIES_FLAG  (1 << 2)
50 #define FREESTYLE_FACE_SMOOTHNESS_FLAG      (1 << 3)
51 #define FREESTYLE_ADVANCED_OPTIONS_FLAG     (1 << 4)
52 #define FREESTYLE_CULLING                   (1 << 5)
53
54 /* FreestyleConfig::mode */
55 #define FREESTYLE_CONTROL_SCRIPT_MODE  1
56 #define FREESTYLE_CONTROL_EDITOR_MODE  2
57
58 /* FreestyleLineSet::flags */
59 #define FREESTYLE_LINESET_CURRENT  (1 << 0)
60 #define FREESTYLE_LINESET_ENABLED  (1 << 1)
61 #define FREESTYLE_LINESET_FE_NOT   (1 << 2)
62 #define FREESTYLE_LINESET_FE_AND   (1 << 3)
63 #define FREESTYLE_LINESET_GR_NOT   (1 << 4)
64 #define FREESTYLE_LINESET_FM_NOT   (1 << 5)
65 #define FREESTYLE_LINESET_FM_BOTH  (1 << 6)
66
67 /* FreestyleLineSet::selection */
68 #define FREESTYLE_SEL_VISIBILITY    (1 << 0)
69 #define FREESTYLE_SEL_EDGE_TYPES    (1 << 1)
70 #define FREESTYLE_SEL_GROUP         (1 << 2)
71 #define FREESTYLE_SEL_IMAGE_BORDER  (1 << 3)
72 #define FREESTYLE_SEL_FACE_MARK     (1 << 4)
73
74 /* FreestyleLineSet::edge_types, exclude_edge_types */
75 #define FREESTYLE_FE_SILHOUETTE          (1 << 0)
76 #define FREESTYLE_FE_BORDER              (1 << 1)
77 #define FREESTYLE_FE_CREASE              (1 << 2)
78 #define FREESTYLE_FE_RIDGE_VALLEY        (1 << 3)
79 /* Note: FREESTYLE_FE_VALLEY = (1 << 4) is no longer used */
80 #define FREESTYLE_FE_SUGGESTIVE_CONTOUR  (1 << 5)
81 #define FREESTYLE_FE_MATERIAL_BOUNDARY   (1 << 6)
82 #define FREESTYLE_FE_CONTOUR             (1 << 7)
83 #define FREESTYLE_FE_EXTERNAL_CONTOUR    (1 << 8)
84 #define FREESTYLE_FE_EDGE_MARK           (1 << 9)
85
86 /* FreestyleLineSet::qi */
87 #define FREESTYLE_QI_VISIBLE  1
88 #define FREESTYLE_QI_HIDDEN   2
89 #define FREESTYLE_QI_RANGE    3
90
91 /* FreestyleConfig::raycasting_algorithm */
92 /* Defines should be replaced with ViewMapBuilder::visibility_algo */
93 #define FREESTYLE_ALGO_REGULAR                      1
94 #define FREESTYLE_ALGO_FAST                         2
95 #define FREESTYLE_ALGO_VERYFAST                     3
96 #define FREESTYLE_ALGO_CULLED_ADAPTIVE_TRADITIONAL  4
97 #define FREESTYLE_ALGO_ADAPTIVE_TRADITIONAL         5
98 #define FREESTYLE_ALGO_CULLED_ADAPTIVE_CUMULATIVE   6
99 #define FREESTYLE_ALGO_ADAPTIVE_CUMULATIVE          7
100
101 typedef struct FreestyleLineSet {
102         struct FreestyleLineSet *next, *prev;
103
104         char name[64]; /* line set name, MAX_NAME */
105         int flags;
106
107         int selection; /* selection criteria */
108         short qi; /* quantitative invisibility */
109         short pad1;
110         int qi_start, qi_end;
111         int edge_types, exclude_edge_types; /* feature edge types */
112         int pad2;
113         struct Group *group; /* group of target objects */
114
115         struct FreestyleLineStyle *linestyle;
116 } FreestyleLineSet;
117
118 typedef struct FreestyleModuleConfig {
119         struct FreestyleModuleConfig *next, *prev;
120
121         struct Text *script;
122         short is_displayed;
123         short pad[3];
124 } FreestyleModuleConfig;
125
126 typedef struct FreestyleConfig {
127         ListBase modules;
128
129         int mode; /* scripting, editor */
130         int raycasting_algorithm  DNA_DEPRECATED;
131         int flags; /* suggestive contours, ridges/valleys, material boundaries */
132         float sphere_radius;
133         float dkr_epsilon;
134         float crease_angle; /* in radians! */
135
136         ListBase linesets;
137 } FreestyleConfig;
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143 #endif /* __DNA_FREESTYLE_TYPES_H__ */