blender-archive/source/blender/alembic/ABC_alembic.h

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Esteban Tovagliari, Cedric Paille, Kevin Dietrich
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef __ABC_ALEMBIC_H__
#define __ABC_ALEMBIC_H__

#ifdef __cplusplus
extern "C" {
#endif

struct bContext;
struct CacheReader;
struct DerivedMesh;
struct ListBase;
struct Object;
struct Scene;

typedef struct AbcArchiveHandle AbcArchiveHandle;

enum {
	ABC_ARCHIVE_OGAWA = 0,
	ABC_ARCHIVE_HDF5  = 1,
};

int ABC_get_version(void);

struct AlembicExportParams {
	double frame_start;
	double frame_end;

	unsigned int frame_samples_xform;
	unsigned int frame_samples_shape;

	double shutter_open;
	double shutter_close;

	bool selected_only;
	bool uvs;
	bool normals;
	bool vcolors;
	bool apply_subdiv;
	bool flatten_hierarchy;
	bool visible_layers_only;
	bool renderable_only;
	bool face_sets;
	bool use_subdiv_schema;
	bool packuv;
	bool triangulate;
	bool export_hair;
	bool export_particles;

	unsigned int compression_type : 1;

	/* See MOD_TRIANGULATE_NGON_xxx and MOD_TRIANGULATE_QUAD_xxx
	 * in DNA_modifier_types.h */
	int quad_method;
	int ngon_method;

	float global_scale;
};

/* The ABC_export and ABC_import functions both take a as_background_job
 * parameter, and return a boolean.
 *
 * When as_background_job=true, returns false immediately after scheduling
 * a background job.
 *
 * When as_background_job=false, performs the export synchronously, and returns
 * true when the export was ok, and false if there were any errors.
 */

bool ABC_export(
        struct Scene *scene,
        struct bContext *C,
        const char *filepath,
        const struct AlembicExportParams *params,
        bool as_background_job);

bool ABC_import(struct bContext *C,
                const char *filepath,
                float scale,
                bool is_sequence,
                bool set_frame_range,
                int sequence_len,
                int offset,
                bool validate_meshes,
                bool as_background_job);

AbcArchiveHandle *ABC_create_handle(const char *filename, struct ListBase *object_paths);

void ABC_free_handle(AbcArchiveHandle *handle);

void ABC_get_transform(struct CacheReader *reader,
                       float r_mat[4][4],
                       float time,
                       float scale);

struct DerivedMesh *ABC_read_mesh(struct CacheReader *reader,
                                  struct Object *ob,
                                  struct DerivedMesh *dm,
                                  const float time,
                                  const char **err_str,
                                  int flags);

void CacheReader_incref(struct CacheReader *reader);
void CacheReader_free(struct CacheReader *reader);

struct CacheReader *CacheReader_open_alembic_object(struct AbcArchiveHandle *handle,
                                                    struct CacheReader *reader,
                                                    struct Object *object,
                                                    const char *object_path);

#ifdef __cplusplus
}
#endif

#endif  /* __ABC_ALEMBIC_H__ */