Merge branch 'master' into blender2.8
[blender.git] / source / blender / alembic / ABC_alembic.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  * Contributor(s): Esteban Tovagliari, Cedric Paille, Kevin Dietrich
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __ABC_ALEMBIC_H__
24 #define __ABC_ALEMBIC_H__
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 struct bContext;
31 struct CacheReader;
32 struct ListBase;
33 struct Mesh;
34 struct Object;
35 struct Scene;
36
37 typedef struct AbcArchiveHandle AbcArchiveHandle;
38
39 enum {
40         ABC_ARCHIVE_OGAWA = 0,
41         ABC_ARCHIVE_HDF5  = 1,
42 };
43
44 int ABC_get_version(void);
45
46 struct AlembicExportParams {
47         double frame_start;
48         double frame_end;
49
50         unsigned int frame_samples_xform;
51         unsigned int frame_samples_shape;
52
53         double shutter_open;
54         double shutter_close;
55
56         bool selected_only;
57         bool uvs;
58         bool normals;
59         bool vcolors;
60         bool apply_subdiv;
61         bool flatten_hierarchy;
62         bool visible_layers_only;
63         bool renderable_only;
64         bool face_sets;
65         bool use_subdiv_schema;
66         bool packuv;
67         bool triangulate;
68         bool export_hair;
69         bool export_particles;
70
71         unsigned int compression_type : 1;
72
73         /* See MOD_TRIANGULATE_NGON_xxx and MOD_TRIANGULATE_QUAD_xxx
74          * in DNA_modifier_types.h */
75         int quad_method;
76         int ngon_method;
77
78         float global_scale;
79 };
80
81 /* The ABC_export and ABC_import functions both take a as_background_job
82  * parameter, and return a boolean.
83  *
84  * When as_background_job=true, returns false immediately after scheduling
85  * a background job.
86  *
87  * When as_background_job=false, performs the export synchronously, and returns
88  * true when the export was ok, and false if there were any errors.
89  */
90
91 bool ABC_export(
92         struct Scene *scene,
93         struct bContext *C,
94         const char *filepath,
95         const struct AlembicExportParams *params,
96         bool as_background_job);
97
98 bool ABC_import(struct bContext *C,
99                 const char *filepath,
100                 float scale,
101                 bool is_sequence,
102                 bool set_frame_range,
103                 int sequence_len,
104                 int offset,
105                 bool validate_meshes,
106                 bool as_background_job);
107
108 AbcArchiveHandle *ABC_create_handle(const char *filename, struct ListBase *object_paths);
109
110 void ABC_free_handle(AbcArchiveHandle *handle);
111
112 void ABC_get_transform(struct CacheReader *reader,
113                        float r_mat[4][4],
114                        float time,
115                        float scale);
116
117 /* Either modifies current_mesh in-place or constructs a new mesh. */
118 struct Mesh *ABC_read_mesh(struct CacheReader *reader,
119                            struct Object *ob,
120                            struct Mesh *current_mesh,
121                            const float time,
122                            const char **err_str,
123                            int flags);
124
125 void CacheReader_incref(struct CacheReader *reader);
126 void CacheReader_free(struct CacheReader *reader);
127
128 struct CacheReader *CacheReader_open_alembic_object(struct AbcArchiveHandle *handle,
129                                                     struct CacheReader *reader,
130                                                     struct Object *object,
131                                                     const char *object_path);
132
133 #ifdef __cplusplus
134 }
135 #endif
136
137 #endif  /* __ABC_ALEMBIC_H__ */