ImNode.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved. 
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
#ifndef CPP_APP_IMNODE_H
#define CPP_APP_IMNODE_H
 
#include <string>
#include <vector>
 
#include "nlohmann/json.hpp"
 
#include "Connection.h"
 
namespace modelspace {
    /// @brief Node type definition to allow config writer to identify custom nodes
    enum node_types_e {
        STANDARD = 0,
        MODEL = 1,
        SIM_EXEC = 2,
        TEXT_NODE = 3,
        FRAME = 4,
        LOGGER = 5,
        VIZKIT = 6
    };
 
    /** @brief Hold all data related to a visual node in the ImGUI UX */
    struct ImNode {
        std::string name; ///< The name of the node
 
        long unique_id; ///< The unique ID of the node given by the ImGUI UX
 
        int hidden = 0; ///< Whether or not this node has been hidden in the GUI via deletion
 
        std::vector<Connection> inputs; ///< A list of all inputs to the node
 
        std::vector<Connection> outputs; ///< A list of all outputs from the node
 
        std::string class_type; ///< The type of the node's base class (model type or similar)
 
        std::vector<ImNode> children; ///< A list of all child nodes to this node
 
        /// @brief Node type information -- most will be STANDARD
        node_types_e node_type;
 
        /// @brief Create Node object from json
        /// @param j The json object from which Node is created
        void fromJson(const nlohmann::json &j);
 
        /// @brief Create json object from Node
        /// @return The json object from Node data
        nlohmann::json toJson();
 
        /// @brief Output all node information
        void dump();
    };
 
}
 
#endif