Program Listing for File AbstractImporter.h

↰ Return to documentation for file (include/Karana/Scene/AbstractImporter.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 Contains the declarations for the AbstractImporter class.
 */

#pragma once
#include <Karana/KCore/SharedPointer.h>
#include <Karana/Math/Defs.h>
#include <Karana/Math/HomTran.h>
#include <Karana/Scene/Material.h>
#include <Karana/Scene/ScenePartSpec.h>
#include <Karana/Scene/StaticGeometry.h>
#include <vector>

namespace Karana::Scene {
    /// Struct for the full result of importing a file
    struct ImportResult {
        /// List of all imported parts
        std::vector<ScenePartSpec> parts;
        /// List of all imported geometries
        std::vector<VarStaticGeometry> geometries;
        /// List of all imported materials
        std::vector<VarMaterial> materials;
    };

    /**
     * @class AbstractImporter
     * @brief Interface for importing Scene assets
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class AbstractImporter {
      public:
        virtual ~AbstractImporter();

        /**
         * @brief Import geometry, material, and scene data from a file
         * @param filename - The file to import
         * @return The imported data
         */
        virtual ImportResult importFrom(const std::filesystem::path &filename) = 0;
    };
} // namespace Karana::Scene