Attempt to fix a potential name conflict between Freestyle and the compositor.
[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 #include "DNA_listBase.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct FreestyleLineStyle;
38 struct Group;
39 struct Text;
40
41 /* FreestyleConfig::flags */
42 #define FREESTYLE_SUGGESTIVE_CONTOURS_FLAG  (1 << 0)
43 #define FREESTYLE_RIDGES_AND_VALLEYS_FLAG   (1 << 1)
44 #define FREESTYLE_MATERIAL_BOUNDARIES_FLAG  (1 << 2)
45 #define FREESTYLE_FACE_SMOOTHNESS_FLAG      (1 << 3)
46 #define FREESTYLE_ADVANCED_OPTIONS_FLAG     (1 << 4)
47 #define FREESTYLE_CULLING                   (1 << 5)
48
49 /* FreestyleConfig::mode */
50 #define FREESTYLE_CONTROL_SCRIPT_MODE  1
51 #define FREESTYLE_CONTROL_EDITOR_MODE  2
52
53 /* FreestyleLineSet::flags */
54 #define FREESTYLE_LINESET_CURRENT  (1 << 0)
55 #define FREESTYLE_LINESET_ENABLED  (1 << 1)
56 #define FREESTYLE_LINESET_FE_NOT   (1 << 2)
57 #define FREESTYLE_LINESET_FE_AND   (1 << 3)
58 #define FREESTYLE_LINESET_GR_NOT   (1 << 4)
59 #define FREESTYLE_LINESET_FM_NOT   (1 << 5)
60 #define FREESTYLE_LINESET_FM_BOTH  (1 << 6)
61
62 /* FreestyleLineSet::selection */
63 #define FREESTYLE_SEL_VISIBILITY    (1 << 0)
64 #define FREESTYLE_SEL_EDGE_TYPES    (1 << 1)
65 #define FREESTYLE_SEL_GROUP         (1 << 2)
66 #define FREESTYLE_SEL_IMAGE_BORDER  (1 << 3)
67 #define FREESTYLE_SEL_FACE_MARK     (1 << 4)
68
69 /* FreestyleLineSet::edge_types, exclude_edge_types */
70 #define FREESTYLE_FE_SILHOUETTE          (1 << 0)
71 #define FREESTYLE_FE_BORDER              (1 << 1)
72 #define FREESTYLE_FE_CREASE              (1 << 2)
73 #define FREESTYLE_FE_RIDGE_VALLEY        (1 << 3)
74 /* Note: FREESTYLE_FE_VALLEY = (1 << 4) is no longer used */
75 #define FREESTYLE_FE_SUGGESTIVE_CONTOUR  (1 << 5)
76 #define FREESTYLE_FE_MATERIAL_BOUNDARY   (1 << 6)
77 #define FREESTYLE_FE_CONTOUR             (1 << 7)
78 #define FREESTYLE_FE_EXTERNAL_CONTOUR    (1 << 8)
79 #define FREESTYLE_FE_EDGE_MARK           (1 << 9)
80
81 /* FreestyleLineSet::qi */
82 #define FREESTYLE_QI_VISIBLE  1
83 #define FREESTYLE_QI_HIDDEN   2
84 #define FREESTYLE_QI_RANGE    3
85
86 /* FreestyleConfig::raycasting_algorithm */
87 /* Defines should be replaced with ViewMapBuilder::visibility_algo */
88 #define FREESTYLE_ALGO_REGULAR                      1
89 #define FREESTYLE_ALGO_FAST                         2
90 #define FREESTYLE_ALGO_VERYFAST                     3
91 #define FREESTYLE_ALGO_CULLED_ADAPTIVE_TRADITIONAL  4
92 #define FREESTYLE_ALGO_ADAPTIVE_TRADITIONAL         5
93 #define FREESTYLE_ALGO_CULLED_ADAPTIVE_CUMULATIVE   6
94 #define FREESTYLE_ALGO_ADAPTIVE_CUMULATIVE          7
95
96 typedef struct FreestyleLineSet {
97         struct FreestyleLineSet *next, *prev;
98
99         char name[64]; /* line set name, MAX_NAME */
100         int flags;
101
102         int selection; /* selection criteria */
103         short qi; /* quantitative invisibility */
104         short pad1;
105         int qi_start, qi_end;
106         int edge_types, exclude_edge_types; /* feature edge types */
107         int pad2;
108         struct Group *group; /* group of target objects */
109
110         struct FreestyleLineStyle *linestyle;
111 } FreestyleLineSet;
112
113 typedef struct FreestyleModuleConfig {
114         struct FreestyleModuleConfig *next, *prev;
115
116         struct Text *script;
117         short is_displayed;
118         short pad[3];
119 } FreestyleModuleConfig;
120
121 typedef struct FreestyleConfig {
122         ListBase modules;
123
124         int mode; /* scripting, editor */
125         int raycasting_algorithm; /* XXX deprecated */
126         int flags; /* suggestive contours, ridges/valleys, material boundaries */
127         float sphere_radius;
128         float dkr_epsilon;
129         float crease_angle; /* in radians! */
130
131         ListBase linesets;
132 } FreestyleConfig;
133
134 #ifdef __cplusplus
135 }
136 #endif
137
138 #endif /* __DNA_FREESTYLE_TYPES_H__ */