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 DerivedMesh;
  33 struct ListBase;
  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         double frame_step_xform;
  51         double frame_step_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
  69         unsigned int compression_type : 1;
  70
  71         /* See MOD_TRIANGULATE_NGON_xxx and MOD_TRIANGULATE_QUAD_xxx
  72          * in DNA_modifier_types.h */
  73         int quad_method;
  74         int ngon_method;
  75
  76         float global_scale;
  77 };
  78
  79 void ABC_export(
  80         struct Scene *scene,
  81         struct bContext *C,
  82         const char *filepath,
  83         const struct AlembicExportParams *params);
  84
  85 void ABC_import(struct bContext *C,
  86                 const char *filepath,
  87                 float scale,
  88                 bool is_sequence,
  89                 bool set_frame_range,
  90                 int sequence_len,
  91                 int offset,
  92                 bool validate_meshes);
  93
  94 AbcArchiveHandle *ABC_create_handle(const char *filename, struct ListBase *object_paths);
  95
  96 void ABC_free_handle(AbcArchiveHandle *handle);
  97
  98 void ABC_get_transform(struct CacheReader *reader,
  99                        float r_mat[4][4],
 100                        float time,
 101                        float scale);
 102
 103 struct DerivedMesh *ABC_read_mesh(struct CacheReader *reader,
 104                                   struct Object *ob,
 105                                   struct DerivedMesh *dm,
 106                                   const float time,
 107                                   const char **err_str,
 108                                   int flags);
 109
 110 void CacheReader_free(struct CacheReader *reader);
 111
 112 struct CacheReader *CacheReader_open_alembic_object(struct AbcArchiveHandle *handle,
 113                                                     struct CacheReader *reader,
 114                                                     struct Object *object,
 115                                                     const char *object_path);
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif  /* __ABC_ALEMBIC_H__ */