This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/io/alembic/ABC_alembic.h
Kévin Dietrich ccf31810d6 Cleanup: use a structure for Alembic import parameters
Also renammed some parameters and sprinkled a dash of documentation.
2022-08-16 19:59:22 +02:00

149 lines
4.4 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
/** \file
* \ingroup balembic
*/
#include "DEG_depsgraph.h"
#ifdef __cplusplus
extern "C" {
#endif
struct CacheArchiveHandle;
struct CacheFileLayer;
struct CacheReader;
struct ListBase;
struct Main;
struct Mesh;
struct Object;
struct Scene;
struct bContext;
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 orcos;
bool apply_subdiv;
bool curves_as_mesh;
bool flatten_hierarchy;
bool visible_objects_only;
bool face_sets;
bool use_subdiv_schema;
bool packuv;
bool triangulate;
bool export_hair;
bool export_particles;
bool export_custom_properties;
bool use_instancing;
enum eEvaluationMode evaluation_mode;
/* See MOD_TRIANGULATE_NGON_xxx and MOD_TRIANGULATE_QUAD_xxx
* in DNA_modifier_types.h */
int quad_method;
int ngon_method;
float global_scale;
};
struct AlembicImportParams {
/* Multiplier for the cached data scale. Mostly useful if the data is stored in a different unit
* as what Blender expects (e.g. centimeters instead of meters). */
float global_scale;
/* Number of consecutive files to expect if the cached animation is split in a sequence. */
int sequence_len;
/* Start frame of the sequence, offset from 0. */
int sequence_offset;
/* True if the cache is split in multiple files. */
bool is_sequence;
/* True if the importer should set the current scene's start and end frame based on the start and
* end frames of the cached animation. */
bool set_frame_range;
/* True if imported meshes should be validated. Error messages are sent to the console. */
bool validate_meshes;
/* True if a cache reader should be added regardless of whether there is animated data in the
* cached file. */
bool always_add_cache_reader;
};
/* 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,
const struct AlembicImportParams *params,
bool as_background_job);
struct CacheArchiveHandle *ABC_create_handle(struct Main *bmain,
const char *filename,
const struct CacheFileLayer *layers,
struct ListBase *object_paths);
void ABC_free_handle(struct CacheArchiveHandle *handle);
void ABC_get_transform(struct CacheReader *reader,
float r_mat_world[4][4],
double time,
float scale);
typedef struct ABCReadParams {
double time;
int read_flags;
const char *velocity_name;
float velocity_scale;
} ABCReadParams;
/* Either modifies existing_mesh in-place or constructs a new mesh. */
struct Mesh *ABC_read_mesh(struct CacheReader *reader,
struct Object *ob,
struct Mesh *existing_mesh,
const ABCReadParams *params,
const char **err_str);
bool ABC_mesh_topology_changed(struct CacheReader *reader,
struct Object *ob,
const struct Mesh *existing_mesh,
double time,
const char **err_str);
void ABC_CacheReader_incref(struct CacheReader *reader);
void ABC_CacheReader_free(struct CacheReader *reader);
struct CacheReader *CacheReader_open_alembic_object(struct CacheArchiveHandle *handle,
struct CacheReader *reader,
struct Object *object,
const char *object_path);
#ifdef __cplusplus
}
#endif