Program Listing for File SceneFileObject.h#
↰ Return to documentation for file (include/Karana/Scene/SceneFileObject.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 SceneFileObject class.
*/
#pragma once
#include "Karana/Scene/Layer.h"
#include "Karana/Scene/SceneNode.h"
#include <string_view>
namespace Karana::Scene {
class SceneFileObject;
/**
* @class SceneFileObjectVars
* @brief The Vars for the SceneFileObject class.
*/
class SceneFileObjectVars : public SceneNodeVars {
public:
/**
* @brief SceneFileObjectVars constructor. The constructor is not meant to be
* called directly. Please use the create(...) method instead to create
* an instance.
*
* @param sp The SceneFileObject associated with this SceneFileObjectVars.
*/
SceneFileObjectVars(const kc::ks_ptr<const SceneFileObject> &sp);
/**
* @brief Destructor.
*/
~SceneFileObjectVars();
/**
* @brief Create an instance of the SceneFileObjectVars.
*
* @param sp The SceneFileObject associated with this SceneFileObjectVars.
* @returns A pointer to the newly created instance of SceneFileObjectVars.
*/
static kc::ks_ptr<SceneFileObjectVars> create(const kc::ks_ptr<const SceneFileObject> &sp);
/**
* @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 filepath of the SceneFileObject.
kc::ks_ptr<Karana::Core::Var_T<std::string>> filepath;
/// The layers for the SceneFileObject.
kc::ks_ptr<Karana::Core::Var_T<int>> layers;
/// Readable string representation of the layers for the SceneFileObject
kc::ks_ptr<Karana::Core::Var_T<std::string>> layers_string;
};
/**
* @class SceneFileObject
* @brief Class for an opaque node with contents loaded from a file.
*
* See \sref{scene_layer_sec} for more discussion on
* the scene layer.
*/
class SceneFileObject : public virtual SceneNode {
protected:
/**
* @brief Constructor for a SceneFileObject
*
* @param name Name of the SceneFileObject
* @param scene The Scene to add the SceneFileObject to.
* @param filepath The filepath to load
* @param layers Bitmask for which layers the part belongs to.
*/
SceneFileObject(std::string_view name,
const Karana::Core::ks_ptr<Scene> &scene,
const std::filesystem::path &filepath,
layer_t layers);
public:
/**
* @brief Destructor.
*/
virtual ~SceneFileObject();
// Delete copy constructor and assignment operator
SceneFileObject(const SceneFileObject &) = delete;
SceneFileObject &operator=(const SceneFileObject &) = delete;
/**
* @brief Create a SceneFileObject.
*
* @param name Name of the SceneFileObject.
* @param scene The Scene to add the SceneFileObject to.
* @param filepath The filepath to load
* @param layers Bitmask for which layers the part belongs to.
* @return The new scene part.
*/
static Karana::Core::ks_ptr<SceneFileObject>
create(std::string_view name,
const Karana::Core::ks_ptr<Scene> &scene,
const std::filesystem::path &filepath,
layer_t layers = LAYER_PHYSICAL);
/**
* @brief Get the file node's filepath
*
* @return The file node's filepath
*/
const std::filesystem::path &getFilepath() const;
bool isSceneFileObject() const override { return true; };
/**
* @brief Get which layers the part belongs to.
*
* @return Bitmask for which layers the part belongs to.
*/
const layer_t &getLayers() const;
/**
* @brief Convert the layer value into a more readable string form
*
* The conversion only uses the pre-defined and known layer
* values (eg. COLLISION etc)
*
* @param layer the layer value
* @return A string representation of the bitmask for which layers the part belongs to.
*/
static std::string getLayersString(layer_t layer);
protected:
Karana::Core::ks_ptr<Karana::Core::BaseVars> _getVars() const override;
/**
* @brief Discard the provided SceneFileObject.
* @param base - Base pointer to the SceneFileObject to discard.
*/
void _discard(kc::ks_ptr<Base> &base) override;
/**
* @brief Populate the SceneFileObject via AssimpImporter
*/
void _defaultPopulate();
private:
const std::filesystem::path _filepath;
const layer_t _layers;
};
} // namespace Karana::Scene