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