Program Listing for File GraphicalSceneCamera.h

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

#pragma once
#include "Karana/Scene/GraphicalSceneNode.h"
#include "Karana/Scene/Layer.h"
#include "Karana/Scene/Projection.h"

namespace Karana::Scene {
    /**
     * @class GraphicalSceneCamera
     * @brief Specialized node to provide a viewpoint for the GraphicalScene
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class GraphicalSceneCamera : public virtual GraphicalSceneNode {
      protected:
        /**
         * @brief GraphicalSceneCamera constructor
         * @param name - Name for the GraphicalSceneCamera
         * @param scene - GraphicalScene to add the camera to.
         * @param proj - Camera projection parameters.
         */
        GraphicalSceneCamera(std::string_view name,
                             const kc::ks_ptr<Scene> &scene,
                             const VarProjection &proj = PerspectiveProjection{});

      public:
        /**
         * @brief Get the camera projection parameters
         * @return The camera projection parameters
         */
        const VarProjection &getProjection() const;

        /**
         * @brief Set the camera projection parameters
         * @param proj The camera projection parameters
         */
        virtual void setProjection(const VarProjection &proj);

        /**
         * @brief Get the bitmask for which layers should be visible.
         * @return The layers bitmask
         */
        layer_t getMask() const;

        /**
         * @brief Set the bitmask for which layers should be visible.
         * @param mask - The layers bitmask
         */
        virtual void setMask(layer_t mask);

        /**
         * @brief Set the pose of the camera.
         * @param offset The position of the camera.
         * @param target The position the camera will point at.
         * @param up The up vector of the camera.
         */
        virtual void pointCameraAt(const Karana::Math::Vec3 &offset,
                                   const Karana::Math::Vec3 &target,
                                   const Karana::Math::Vec3 &up) = 0;

      private:
        VarProjection _projection;
        layer_t _mask = LAYER_GRAPHICS;
    };
} // namespace Karana::Scene