Program Listing for File CoalSceneFileObject.h

↰ Return to documentation for file (include/Karana/CoalScene/CoalSceneFileObject.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 CoalSceneFileObject class.
 */

#pragma once
#include "Karana/CoalScene/CoalSceneNode.h"
#include "Karana/Scene/SceneFileObject.h"

namespace Karana::Scene {
    /**
     * @class CoalSceneFileObject
     * @brief SceneFileObject implementation for CoalScene
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class CoalSceneFileObject : public SceneFileObject, public CoalSceneNode {
        friend class CoalScene; // for access to _defaultPopulate

      public:
        /**
         * @brief CoalSceneFileObject constructor. The constructor is not meant to be called
         * directly. Please use the create(...) method instead to create an instance.
         *
         * @param name Name of the CoalSceneFileObject.
         * @param scene The CoalScene to add the part to.
         * @param filepath Filepath to populate the node from.
         * @param layers Layers to use for the CoalSceneFileObject.
         */
        CoalSceneFileObject(std::string_view name,
                            const kc::ks_ptr<Scene> &scene,
                            const std::filesystem::path &filepath,
                            layer_t layers);

        /**
         * @brief Create a CoalSceneFileObject.
         *
         * @param name Name of the CoalSceneFileObject.
         * @param scene The GraphicalScene to add the CoalSceneFileObject to.
         * @param filepath Filepath to populate the node from.
         * @param layers Layers to use for the CoalSceneFileObject.
         * @return The new CoalScene file node.
         */
        static kc::ks_ptr<CoalSceneFileObject> create(std::string_view name,
                                                      const kc::ks_ptr<CoalScene> &scene,
                                                      const std::filesystem::path &filepath,
                                                      layer_t layers = LAYER_PHYSICAL);
    };
} // namespace Karana::Scene