Program Listing for File GraphicalSceneNode.h

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

#pragma once
#include "Karana/Scene/Color.h"
#include "Karana/Scene/SceneNode.h"

namespace Karana::Scene {
    namespace kc = Karana::Core;

    class GraphicalScene;

    /**
     * @class GraphicalSceneNode
     * @brief SceneNode with an added graphics-specific interface
     *
     * See \sref{scene_layer_sec} for more discussion on
     * the scene layer.
     */
    class GraphicalSceneNode : public virtual SceneNode {
      protected:
        /**
         * @brief GraphicalSceneNode constructor
         * @param name - Name for the GraphicalSceneNode
         * @param scene - Scene to add the GraphicalSceneNode to.
         */
        GraphicalSceneNode(std::string_view name, const kc::ks_ptr<Scene> &scene);

        /**
         * @brief Factory for a GraphicalSceneNode.
         * @param name - Name for the GraphicalSceneNode
         * @param scene - Scene to add the GraphicalSceneNode to.
         * @return The create GraphicalSceneNode.
         */
        static Karana::Core::ks_ptr<GraphicalSceneNode>
        create(std::string_view name, const kc::ks_ptr<GraphicalScene> &scene);

      public:
        virtual ~GraphicalSceneNode();

        /**
         * @brief Show axes to visualize the node's position and orientation
         * @param size - Lengths of the axes (zero to remove the axes)
         */
        virtual void showAxes(float size = 1) = 0;

        /**
         * @brief Display a trail tracking the node's motion over time.
         * @param relative_to - Another node to draw the trail relative to.
         * @param color - The color of the Trail.
         */
        virtual void trail(const Karana::Core::ks_ptr<GraphicalSceneNode> &relative_to = nullptr,
                           const Color &color = Color::WHITE) = 0;

        /**
         * @brief Remove a trail previously created by calling trail
         */
        virtual void removeTrail() = 0;
    };
} // namespace Karana::Scene