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