Program Listing for File ScenePart.h

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

#pragma once
#include "Karana/Scene/Layer.h"
#include "Karana/Scene/Material.h"
#include "Karana/Scene/SceneNode.h"
#include "Karana/Scene/StaticGeometry.h"

namespace Karana::Scene {
    /**
     * @class ScenePart
     * @brief Class for objects with geometry and material in the scene
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class ScenePart : public virtual SceneNode {
      protected:
        /**
         * @brief Constructor for a ScenePart
         *
         * @param name - Name of the ScenePart
         * @param scene - The Scene to add the ScenePart to.
         * @param geometry - Geometry of the ScenePart.
         * @param material - Material of the ScenePart.
         * @param layers - Bitmask for which layers the part belongs to.
         */
        ScenePart(std::string_view name,
                  const Karana::Core::ks_ptr<Scene> &scene,
                  const VarStaticGeometry &geometry,
                  const VarMaterial &material,
                  layer_t layers);

      public:
        virtual ~ScenePart();

        /**
         * @brief Create a ScenePart.
         *
         * @param name - Name of the ScenePart.
         * @param scene - The Scene to add the ScenePart to.
         * @param geometry - Geometry of the ScenePart.
         * @param material - Material for the ScenePart.
         * @param layers - Bitmask for which layers the part belongs to.
         * @return The new scene part.
         */
        static Karana::Core::ks_ptr<ScenePart>
        create(std::string_view name,
               const Karana::Core::ks_ptr<Scene> &scene,
               const VarStaticGeometry &geometry,
               const VarMaterial &material = defaultMaterial(),
               layer_t layers = LAYER_PHYSICAL);

        /**
         * @brief Get the part's geometry
         *
         * @return The part's geometry
         */
        const VarStaticGeometry &getGeometry() const;

        /**
         * @brief Get the part's material
         *
         * @return The part's material
         */
        const VarMaterial &getMaterial() const;

        /**
         * @brief Set the part's material
         *
         * @param material - The part's new material.
         */
        virtual void setMaterial(const VarMaterial &material);

        /**
         * @brief Get which layers the part belongs to.
         *
         * @return Bitmask for which layers the part belongs to.
         */
        const layer_t &getLayers() const;

        /**
         * @brief Set the part's intrinsic scale.
         *
         * The intrinsic scale can be non-uniform but does not apply to
         * attached nodes.
         *
         * @param scale - The part's intrinsic scale.
         */
        virtual void setIntrinsicScale(const Karana::Math::Vec3 &scale);

        /**
         * @brief Get the part's intrinsic scale.
         *
         * The intrinsic scale can be non-uniform but does not apply to
         * attached nodes.
         *
         * @return The part's intrinsic scale.
         */
        virtual const Karana::Math::Vec3 &getIntrinsicScale() const;

      protected:
        /// The part's intrinsic scale
        Karana::Math::Vec3 _intrinsic_scale = {1.0, 1.0, 1.0};

        /**
         * @brief Discard the provided ScenePart.
         * @param base - Base pointer to the ScenePart to discard.
         */
        void _discard(kc::ks_ptr<Base> &base) override;

      private:
        const VarStaticGeometry _geometry;
        VarMaterial _material;
        const layer_t _layers;
    };
} // namespace Karana::Scene