Program Listing for File CoalSceneNode.h

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

#pragma once
#include "Karana/Scene/CollisionSceneNode.h"
#include <string>

namespace Karana::Scene {
    class CoalScene;
    /**
     * @class CoalSceneNode
     * @brief CollisionSceneNode implementation for CoalScene
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class CoalSceneNode : public virtual CollisionSceneNode {
      public:
        /**
         * @brief CoalSceneNode constructor.
         * @param name - The name of the CoalSceneNode.
         * @param scene - The CoalScene to add the node to.
         */
        CoalSceneNode(std::string_view name, const kc::ks_ptr<Scene> &scene);

        /**
         * @brief Create a CoalSceneNode.
         * @param name - The name of the CoalSceneNode.
         * @param scene - The CoalScene to add the node to.
         * @return The created CoalSceneNode.
         */
        static kc::ks_ptr<CoalSceneNode> create(std::string_view name,
                                                const Karana::Core::ks_ptr<CoalScene> &scene);
    };
} // namespace Karana::Scene