Program Listing for File ProxySceneFileObject.h#
↰ Return to documentation for file (include/Karana/ProxyScene/ProxySceneFileObject.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 ProxySceneFileObject class.
*/
#pragma once
#include "Karana/KCore/SharedPointer.h"
#include "Karana/ProxyScene/ClientRegistry.h"
#include "Karana/ProxyScene/ImplDatabase.h"
#include "Karana/ProxyScene/ProxySceneNode.h"
#include "Karana/Scene/Scene.h"
#include "Karana/Scene/SceneFileObject.h"
namespace Karana::Scene {
namespace kc = Karana::Core;
class ProxySceneFileObject;
/**
* @class ProxySceneFileObjectVars
* @brief The Vars for the ProxySceneFileObject class.
*/
class ProxySceneFileObjectVars : public SceneFileObjectVars {
public:
/**
* @brief ProxySceneFileObjectVars constructor. The constructor is not meant to be
* called directly. Please use the create(...) method instead to create
* an instance.
*
* @param file_obj The proxy scene file node associated with this ProxySceneFileObjectVars.
*/
ProxySceneFileObjectVars(const kc::ks_ptr<const ProxySceneFileObject> &file_obj);
/**
* @brief Destructor.
*/
~ProxySceneFileObjectVars();
/**
* @brief Create an instance of the ProxySceneFileObjectVars.
*
* @param file_obj The ProxySceneFileObject associated with this ProxySceneFileObjectVars.
* @returns A pointer to the newly created instance of ProxySceneFileObjectVars.
*/
static kc::ks_ptr<ProxySceneFileObjectVars>
create(const kc::ks_ptr<const ProxySceneFileObject> &file_obj);
/**
* @brief Get all the Vars that this VarHolder has.
*
* @returns A map of Vars, where the Var name is the key and the Var is the value.
*/
kc::NestedVars getAllVars() const override;
/// The parent frame name
kc::ks_ptr<Karana::Core::Var_T<std::string>> parent_frame;
};
/**
* @class ProxySceneFileObject
* @brief SceneFileObject acting as a proxy for client SceneFileObjects
*
* See \sref{scene_layer_sec} for more discussion on
* the scene layer.
*/
class ProxySceneFileObject : public SceneFileObject, public ProxySceneNode {
// For access to _implement/_unimplement
friend ProxyScene;
public:
/**
* @brief ProxySceneFileObject constructor.
*
* @param name Name of the ProxySceneFileObject.
* @param scene The ProxyScene to add the ProxySceneFileObject to.
* @param filepath File to populate the node from.
* @param layers Layers to use for the ProxySceneFileObject.
* @param client_registry Helper to track registered client scenes
* @param impl_database Helper to track implementations of objects
* for client scenes
*/
ProxySceneFileObject(std::string_view name,
const kc::ks_ptr<ProxyScene> &scene,
const std::filesystem::path &filepath,
layer_t layers,
const Karana::Core::ks_ptr<ClientRegistry> &client_registry,
const Karana::Core::ks_ptr<ImplDatabase> &impl_database);
/**
* @brief Create a ProxySceneFileObject.
*
* @param name Name of the ProxySceneFileObject.
* @param scene The ProxyScene to add the ProxySceneFileObject to.
* @param filepath File to populate the node from.
* @param layers Layers to use for the ProxySceneFileObject.
* @return The new ProxyScene part.
*/
static kc::ks_ptr<ProxySceneFileObject> create(std::string_view name,
const kc::ks_ptr<ProxyScene> &scene,
const std::filesystem::path &filepath,
layer_t layers = LAYER_PHYSICAL);
/**
* @brief Destructor.
*/
virtual ~ProxySceneFileObject();
/**
* @brief Get the implementation for a given client
* @param scene - The client scene
* @return The implementation of this node for the client
*/
// Adding suppression, as CodeChecker complains this method has the same name as a method in
// the base version. This is just a CodeChecker false positive.
// codechecker_suppress [cppcheck-duplInheritedMember]
Karana::Core::ks_ptr<SceneFileObject> of(Scene &scene) const;
protected:
Karana::Core::ks_ptr<Karana::Core::BaseVars> _getVars() const override;
/**
* @brief Create the implementation for a client scene
*
* This is called automatically as needed and shouldn't need to be
* called outside of ProxyScene internals.
*
* @param scene - The client to create an implementation for.
*/
virtual void _implement(Scene &scene) override;
/**
* @brief Destroy the implementation for a client scene
*
* This is called automatically as needed and shouldn't need to be
* called outside of ProxyScene internals.
*
* @param scene - The client to destroy the implementation for.
*/
virtual void _unimplement(Scene &scene) override;
};
} // namespace Karana::Scene