WarpTwin
Documentation for WarpTwin models and classes.
Loading...
Searching...
No Matches
warptwin::ImNode Struct Reference

Hold all data related to a visual node in the ImGUI UX. More...

#include <ImNode.h>

Public Member Functions

void fromJson (const nlohmann::json &j)
 Create Node object from json.
nlohmann::json toJson ()
 Create json object from Node.
void dump ()
 Output all node information.

Public Attributes

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< Connectioninputs
 A list of all inputs to the node.
std::vector< Connectionoutputs
 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< ImNodechildren
 A list of all child nodes to this node.
node_types_e node_type
 Node type information – most will be STANDARD.
std::string displayname
 The display name for the node.
std::string category
 The category to which the node belongs.
ImVec2 location
 Location of the node on the GUI canvas.
std::string default_config_name = ""
 Assigned default configuration (empty if none).
std::string py_module = ""
 The module from which the ImNode is imported.

Detailed Description

Hold all data related to a visual node in the ImGUI UX.

Member Function Documentation

◆ dump()

void warptwin::ImNode::dump ( )

Output all node information.

◆ fromJson()

void warptwin::ImNode::fromJson ( const nlohmann::json & j)

Create Node object from json.

Parameters
jThe json object from which Node is created

◆ toJson()

nlohmann::json warptwin::ImNode::toJson ( )

Create json object from Node.

Returns
The json object from Node data

Member Data Documentation

◆ category

std::string warptwin::ImNode::category

The category to which the node belongs.

◆ children

std::vector<ImNode> warptwin::ImNode::children

A list of all child nodes to this node.

◆ class_type

std::string warptwin::ImNode::class_type

The type of the node's base class (model type or similar).

◆ default_config_name

std::string warptwin::ImNode::default_config_name = ""

Assigned default configuration (empty if none).

◆ displayname

std::string warptwin::ImNode::displayname

The display name for the node.

◆ hidden

int warptwin::ImNode::hidden = 0

Whether or not this node has been hidden in the GUI via deletion.

◆ inputs

std::vector<Connection> warptwin::ImNode::inputs

A list of all inputs to the node.

◆ location

ImVec2 warptwin::ImNode::location

Location of the node on the GUI canvas.

◆ name

std::string warptwin::ImNode::name

The name of the node.

◆ node_type

node_types_e warptwin::ImNode::node_type

Node type information – most will be STANDARD.

◆ outputs

std::vector<Connection> warptwin::ImNode::outputs

A list of all outputs from the node.

◆ py_module

std::string warptwin::ImNode::py_module = ""

The module from which the ImNode is imported.

◆ unique_id

long warptwin::ImNode::unique_id

The unique ID of the node given by the ImGUI UX.


The documentation for this struct was generated from the following files:
  • /Users/mickey/Documents/Projects/warptwin/cpp/src/configuration/ImNode.h
  • /Users/mickey/Documents/Projects/warptwin/cpp/src/configuration/ImNode.cpp