d5f0313ca649b987267df96c74c5401f34a8df92
[blender.git] / source / blender / blenkernel / BKE_data_transfer.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) 2014 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Bastien Montagne
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/BKE_data_transfer.h
29  *  \ingroup bke
30  */
31
32 #ifndef __BKE_DATA_TRANSFER_H__
33 #define __BKE_DATA_TRANSFER_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "BKE_customdata.h"
40
41 struct Object;
42 struct Scene;
43 struct SpaceTransform;
44 struct ReportList;
45 struct EvaluationContext;
46
47 /* Warning, those def are stored in files (TransferData modifier), *DO NOT* modify those values. */
48 enum {
49         DT_TYPE_MDEFORMVERT             = 1 << 0,
50         DT_TYPE_SHAPEKEY                = 1 << 1,
51         DT_TYPE_SKIN                    = 1 << 2,
52         DT_TYPE_BWEIGHT_VERT            = 1 << 3,
53
54         DT_TYPE_SHARP_EDGE              = 1 << 8,
55         DT_TYPE_SEAM                    = 1 << 9,
56         DT_TYPE_CREASE                  = 1 << 10,
57         DT_TYPE_BWEIGHT_EDGE            = 1 << 11,
58         DT_TYPE_FREESTYLE_EDGE          = 1 << 12,
59
60         DT_TYPE_VCOL                    = 1 << 16,
61         DT_TYPE_LNOR                    = 1 << 17,
62
63         DT_TYPE_UV                      = 1 << 24,
64         DT_TYPE_SHARP_FACE              = 1 << 25,
65         DT_TYPE_FREESTYLE_FACE          = 1 << 26,
66 #define \
67         DT_TYPE_MAX                            27
68
69         DT_TYPE_VERT_ALL                = DT_TYPE_MDEFORMVERT | DT_TYPE_SHAPEKEY | DT_TYPE_SKIN | DT_TYPE_BWEIGHT_VERT,
70         DT_TYPE_EDGE_ALL                = DT_TYPE_SHARP_EDGE | DT_TYPE_SEAM | DT_TYPE_CREASE | DT_TYPE_BWEIGHT_EDGE |
71                                           DT_TYPE_FREESTYLE_EDGE,
72         DT_TYPE_LOOP_ALL                = DT_TYPE_VCOL | DT_TYPE_LNOR | DT_TYPE_UV,
73         DT_TYPE_POLY_ALL                = DT_TYPE_UV | DT_TYPE_SHARP_FACE | DT_TYPE_FREESTYLE_FACE,
74 };
75
76
77 CustomDataMask BKE_object_data_transfer_dttypes_to_cdmask(const int dtdata_types);
78 bool BKE_object_data_transfer_get_dttypes_capacity(
79         const int dtdata_types, bool *r_advanced_mixing, bool *r_threshold);
80 int BKE_object_data_transfer_get_dttypes_item_types(const int dtdata_types);
81
82 int BKE_object_data_transfer_dttype_to_cdtype(const int dtdata_type);
83 int BKE_object_data_transfer_dttype_to_srcdst_index(const int dtdata_type);
84
85 #define DT_DATATYPE_IS_VERT(_dt) \
86         ELEM(_dt, DT_TYPE_MDEFORMVERT, DT_TYPE_SHAPEKEY, DT_TYPE_SKIN, DT_TYPE_BWEIGHT_VERT)
87 #define DT_DATATYPE_IS_EDGE(_dt) \
88         ELEM(_dt, DT_TYPE_CREASE, DT_TYPE_SHARP_EDGE, DT_TYPE_SEAM, DT_TYPE_BWEIGHT_EDGE, DT_TYPE_FREESTYLE_EDGE)
89 #define DT_DATATYPE_IS_LOOP(_dt) \
90         ELEM(_dt, DT_TYPE_UV, DT_TYPE_VCOL, DT_TYPE_LNOR)
91 #define DT_DATATYPE_IS_POLY(_dt) \
92         ELEM(_dt, DT_TYPE_UV, DT_TYPE_SHARP_FACE, DT_TYPE_FREESTYLE_FACE)
93
94 #define DT_DATATYPE_IS_MULTILAYERS(_dt) \
95         ELEM(_dt, DT_TYPE_MDEFORMVERT, DT_TYPE_SHAPEKEY, DT_TYPE_VCOL, DT_TYPE_UV)
96
97
98 enum {
99         DT_MULTILAYER_INDEX_INVALID         = -1,
100         DT_MULTILAYER_INDEX_MDEFORMVERT     = 0,
101         DT_MULTILAYER_INDEX_SHAPEKEY        = 1,
102         DT_MULTILAYER_INDEX_VCOL            = 2,
103         DT_MULTILAYER_INDEX_UV              = 3,
104         DT_MULTILAYER_INDEX_MAX             = 4,
105 };
106
107 /* Below we keep positive values for real layers idx (generated dynamically). */
108
109 /* How to select data layers, for types supporting multi-layers.
110  * Here too, some options are highly dependent on type of transferred data! */
111 enum {
112         DT_LAYERS_ACTIVE_SRC                 = -1,
113         DT_LAYERS_ALL_SRC                    = -2,
114         /* Datatype-specific. */
115         DT_LAYERS_VGROUP_SRC                 = 1 << 8,
116         DT_LAYERS_VGROUP_SRC_BONE_SELECT     = -(DT_LAYERS_VGROUP_SRC | 1),
117         DT_LAYERS_VGROUP_SRC_BONE_DEFORM     = -(DT_LAYERS_VGROUP_SRC | 2),
118         /* Other types-related modes... */
119 };
120
121 /* How to map a source layer to a destination layer, for types supporting multi-layers.
122  * Note: if no matching layer can be found, it will be created. */
123 enum {
124         DT_LAYERS_ACTIVE_DST                 = -1,  /* Only for DT_LAYERS_FROMSEL_ACTIVE. */
125         DT_LAYERS_NAME_DST                   = -2,
126         DT_LAYERS_INDEX_DST                  = -3,
127 #if 0  /* TODO */
128         DT_LAYERS_CREATE_DST                 = -4,  /* Never replace existing data in dst, always create new layers. */
129 #endif
130 };
131
132 void BKE_object_data_transfer_layout(
133         const struct EvaluationContext *eval_ctx, struct Scene *scene, struct Object *ob_src,
134         struct Object *ob_dst, const int data_types, const bool use_delete,
135         const int fromlayers_select[DT_MULTILAYER_INDEX_MAX], const int tolayers_select[DT_MULTILAYER_INDEX_MAX]);
136
137 bool BKE_object_data_transfer_mesh(
138         const struct EvaluationContext *eval_ctx, struct Scene *scene,
139         struct Object *ob_src, struct Object *ob_dst, const int data_types, const bool use_create,
140         const int map_vert_mode, const int map_edge_mode, const int map_loop_mode, const int map_poly_mode,
141         struct SpaceTransform *space_transform, const bool auto_transform,
142         const float max_distance, const float ray_radius, const float islands_handling_precision,
143         const int fromlayers_select[DT_MULTILAYER_INDEX_MAX], const int tolayers_select[DT_MULTILAYER_INDEX_MAX],
144         const int mix_mode, const float mix_factor, const char *vgroup_name, const bool invert_vgroup,
145         struct ReportList *reports);
146 bool BKE_object_data_transfer_dm(
147         const struct EvaluationContext *eval_ctx, struct Scene *scene,
148         struct Object *ob_src, struct Object *ob_dst, struct DerivedMesh *dm_dst,
149         const int data_types, bool use_create,
150         const int map_vert_mode, const int map_edge_mode, const int map_loop_mode, const int map_poly_mode,
151         struct SpaceTransform *space_transform, const bool auto_transform,
152         const float max_distance, const float ray_radius, const float islands_handling_precision,
153         const int fromlayers_select[DT_MULTILAYER_INDEX_MAX], const int tolayers_select[DT_MULTILAYER_INDEX_MAX],
154         const int mix_mode, const float mix_factor, const char *vgroup_name, const bool invert_vgroup,
155         struct ReportList *reports);
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif  /* __BKE_DATA_TRANSFER_H__ */