write()

bool MayaFlux::IO::VDBWriter::write ( const std::string &  filepath, const Kakshya::VolumeData &  data, const VolumeWriteOptions &  options = {}  )

overridevirtual

Write volume data to disk.

Parameters

filepath	Destination path.
data	Volume data. Must satisfy VolumeData::is_consistent().
options	Format-specific options.

Returns

true on success. On failure call get_last_error().

Implements MayaFlux::IO::VolumeWriter.

Definition at line 206 of file VDBWriter.cpp.

{
    m_last_error.clear();
 
    if (!data.is_consistent()) {
        m_last_error = "VolumeData failed is_consistent()";
        MF_ERROR(Journal::Component::IO, Journal::Context::FileIO, m_last_error);
        return false;
    }
 
    const float scalar_bg = options.background;
    const glm::vec3 vector_bg { options.background };
 
    Detail::VDBArchive archive;
 
    for (const auto& field : data.fields) {
        const ActiveSet active = extract_active(
            field, data.lattice, threshold_for(field.name, options));
 
        const auto meta = semantics_metadata(field);
 
        const auto background = active.is_vector
            ? std::as_bytes(std::span(&vector_bg, 1))
            : std::as_bytes(std::span(&scalar_bg, 1));
 
        const Detail::VDBGridSpec spec {
            .name = field.name,
            .coords = active.coords,
            .values = active.values,
            .background = background,
            .is_vector = active.is_vector,
            .metadata = meta,
        };
 
        if (!archive.add_grid(data.lattice, spec)) {
            m_last_error = std::string(archive.last_error());
            MF_ERROR(Journal::Component::IO, Journal::Context::FileIO, m_last_error);
            return false;
        }
 
        MF_DEBUG(Journal::Component::IO, Journal::Context::FileIO,
            "VDBWriter: '{}' {} of {} cells active",
            field.name, active.coords.size(), data.cell_count());
    }
 
    const auto resolved = resolve_write_path(filepath);
 
    if (!archive.save(resolved, compression_flags(options), k_deflate_level)) {
        m_last_error = std::string(archive.last_error());
        MF_ERROR(Journal::Component::IO, Journal::Context::FileIO, m_last_error);
        return false;
    }
 
    MF_INFO(Journal::Component::IO, Journal::Context::FileIO,
        "VDBWriter: wrote '{}', {} grids", resolved, archive.grid_count());
    return true;
}

References MayaFlux::IO::Detail::VDBArchive::add_grid(), MayaFlux::IO::VolumeWriteOptions::background, MayaFlux::Kakshya::VolumeData::cell_count(), MayaFlux::Kakshya::VolumeData::fields, MayaFlux::Journal::FileIO, MayaFlux::IO::Detail::VDBArchive::grid_count(), MayaFlux::Journal::IO, MayaFlux::Kakshya::VolumeData::is_consistent(), MayaFlux::IO::Detail::VDBArchive::last_error(), MayaFlux::Kakshya::VolumeData::lattice, m_last_error, MF_DEBUG, MF_ERROR, MF_INFO, MayaFlux::IO::Detail::VDBGridSpec::name, MayaFlux::IO::resolve_write_path(), and MayaFlux::IO::Detail::VDBArchive::save().

Here is the call graph for this function: