Sybren A. Stüvel
ee97add4c4
Write custom properties (aka ID properties) to Alembic, to the `.userProperties` compound property. Manifest Task: https://developer.blender.org/T50725 Scalar properties (so single-value/non-array properties) are written as single-element array properties to Alembic. This is also what's done by Houdini and Maya exporters, so it seems to be the standard way of doing things. It also simplifies the implementation. Two-dimensional arrays are flattened by concatenating all the numbers into a single array. This is because ID properties have a limited type system. This means that a 3x3 "matrix" could just as well be a list of three 3D vectors. Alembic has two container properties to store custom data: - `.userProperties`, which is meant for properties that aren't necessarily understood by other software packages, and - `.arbGeomParams`, which can contain the same kind of data as `.userProperties`, but can also specify that these vary per face of a mesh. This property is mostly intended for renderers. Most industry packages write their custom data to `.arbGeomParams`. However, given their goals I feel that `.userProperties` is the more appropriate one for Blender's ID Properties. The code is a bit more involved than I would have liked. An `ABCAbstractWriter` has a `uniqueptr` to its `CustomPropertiesExporter`, but the `CustomPropertiesExporter` also has a pointer back to its owning `ABCAbstractWriter`. It's the latter pointer that I'm not too happy with, but it has a reason. Getting the aforementioned `.userProperties` from the Alembic library will automatically create it if it doesn't exist already. If it's not used to actually add custom properties to, it will crash the Alembic CLI tools (and maybe others too). This is what the pointer back to the `ABCAbstractWriter` is used for: to get the `.userProperties` at the last moment, when it's 100% sure at least one custom property will be written. Differential Revision: https://developer.blender.org/D8869 Reviewed by: sergey, dbystedt
93 lines
3.3 KiB
C++
93 lines
3.3 KiB
C++
/*
|
|
* 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.
|
|
*/
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup balembic
|
|
*/
|
|
|
|
#include "abc_writer_abstract.h"
|
|
#include "intern/abc_customdata.h"
|
|
|
|
#include <Alembic/AbcGeom/OPolyMesh.h>
|
|
#include <Alembic/AbcGeom/OSubD.h>
|
|
|
|
struct ModifierData;
|
|
|
|
namespace blender::io::alembic {
|
|
|
|
/* Writer for Alembic geometry. Does not assume the object is a mesh object. */
|
|
class ABCGenericMeshWriter : public ABCAbstractWriter {
|
|
private:
|
|
/* Either polymesh or subd is used, depending on is_subd_.
|
|
* References to the schema must be kept, or Alembic will not properly write. */
|
|
Alembic::AbcGeom::OPolyMesh abc_poly_mesh_;
|
|
Alembic::AbcGeom::OPolyMeshSchema abc_poly_mesh_schema_;
|
|
|
|
Alembic::AbcGeom::OSubD abc_subdiv_;
|
|
Alembic::AbcGeom::OSubDSchema abc_subdiv_schema_;
|
|
|
|
/* Determines whether a poly mesh or a subdivision surface is exported.
|
|
* The value is set by an export option but only true if there is a subdivision modifier on the
|
|
* exported object. */
|
|
bool is_subd_;
|
|
ModifierData *subsurf_modifier_;
|
|
ModifierData *liquid_sim_modifier_;
|
|
|
|
CDStreamConfig m_custom_data_config;
|
|
|
|
public:
|
|
explicit ABCGenericMeshWriter(const ABCWriterConstructorArgs &args);
|
|
virtual ~ABCGenericMeshWriter();
|
|
|
|
virtual void create_alembic_objects(const HierarchyContext *context) override;
|
|
virtual Alembic::Abc::OObject get_alembic_object() const override;
|
|
Alembic::Abc::OCompoundProperty abc_prop_for_custom_props() override;
|
|
|
|
protected:
|
|
virtual bool is_supported(const HierarchyContext *context) const override;
|
|
virtual void do_write(HierarchyContext &context) override;
|
|
|
|
virtual Mesh *get_export_mesh(Object *object_eval, bool &r_needsfree) = 0;
|
|
virtual void free_export_mesh(Mesh *mesh);
|
|
|
|
virtual bool export_as_subdivision_surface(Object *ob_eval) const;
|
|
|
|
private:
|
|
void write_mesh(HierarchyContext &context, Mesh *mesh);
|
|
void write_subd(HierarchyContext &context, Mesh *mesh);
|
|
template<typename Schema> void write_face_sets(Object *object, Mesh *mesh, Schema &schema);
|
|
|
|
ModifierData *get_liquid_sim_modifier(Scene *scene_eval, Object *ob_eval);
|
|
|
|
void write_arb_geo_params(Mesh *me);
|
|
void get_velocities(Mesh *mesh, std::vector<Imath::V3f> &vels);
|
|
void get_geo_groups(Object *object,
|
|
Mesh *mesh,
|
|
std::map<std::string, std::vector<int32_t>> &geo_groups);
|
|
};
|
|
|
|
/* Writer for Alembic geometry of Blender Mesh objects. */
|
|
class ABCMeshWriter : public ABCGenericMeshWriter {
|
|
public:
|
|
ABCMeshWriter(const ABCWriterConstructorArgs &args);
|
|
|
|
protected:
|
|
virtual Mesh *get_export_mesh(Object *object_eval, bool &r_needsfree) override;
|
|
};
|
|
|
|
} // namespace blender::io::alembic
|