Program Listing for File AbstractExporter.h

↰ Return to documentation for file (include/Karana/Scene/AbstractExporter.h)

/*
 * Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
 *
 * NOTICE TO USER:
 *
 * This source code and/or documentation (the "Licensed Materials") is
 * the confidential and proprietary information of Karana Dynamics Inc.
 * Use of these Licensed Materials is governed by the terms and conditions
 * of a separate software license agreement between Karana Dynamics and the
 * Licensee ("License Agreement"). Unless expressly permitted under that
 * agreement, any reproduction, modification, distribution, or disclosure
 * of the Licensed Materials, in whole or in part, to any third party
 * without the prior written consent of Karana Dynamics is strictly prohibited.
 *
 * THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 * KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
 * INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
 * OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
 *
 * U.S. Government End Users: The Licensed Materials are a "commercial item"
 * as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
 * only as a commercial end item under the terms of this license.
 *
 * Any use of the Licensed Materials in individual or commercial software must
 * include, in the user documentation and internal source code comments,
 * this Notice, Disclaimer, and U.S. Government Use Provision.
 */

/**
 * @file
 * @brief Declares the AbstractExporter interface for writing scene part specifications.
 */

#pragma once

#include "Karana/Scene/ScenePartSpec.h"

#include <cstddef>
#include <filesystem>
#include <string>
#include <vector>

namespace Karana::Scene {

    /**
     * @class AbstractExporter
     * @brief Interface for exporting kdFlex scene part specifications to files.
     *
     * AbstractExporter is the write-side counterpart of AbstractImporter. Implementations convert
     * a collection of ScenePartSpec values into an external scene asset. Each ScenePartSpec stores
     * a geometry, material, transform, scale, and layer mask. Exporters should preserve the
     * transform and scale at scene-node level and convert geometry through the static-geometry
     * interface.
     *
     * The exported geometry represents the local part mesh transformed by
     * \f[
     *     {}^W\mathbf{x} =
     *     {}^W\mathbf{T}_P
     *     \operatorname{diag}(s_x, s_y, s_z, 1)
     *     {}^P\mathbf{x},
     * \f]
     * where \f${}^W\mathbf{T}_P\f$ is ScenePartSpec::transform and
     * \f$\mathbf{s}\f$ is ScenePartSpec::scale.
     */
    class AbstractExporter {
      public:
        /**
         * @brief Destroy the exporter.
         */
        virtual ~AbstractExporter();

        /**
         * @brief Export scene part specifications to a file.
         *
         * @param filename Destination file path. The concrete exporter may infer the output format
         *                 from this extension.
         * @param parts ScenePartSpec collection to write.
         */
        virtual void exportTo(const std::filesystem::path &filename,
                              const std::vector<ScenePartSpec> &parts) = 0;
    };

} // namespace Karana::Scene