ModelSpace
All Classes Namespaces Functions Variables Enumerations Pages
modelspace::Connection Struct Reference

Hold all information related to a connection point in the ImGUI UX. More...

#include <Connection.h>

Public Member Functions

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

Public Attributes

std::string name
 The name of the connection.
 
long unique_id
 The unique ID of the connection given by the ImGUI UX or other.
 
connection_type_e connection_type
 The type of connection.
 
clockwerk::dataio_types_e data_type
 The data type associated with the connection.
 
std::array< unsigned int, 2 > size
 The size of the connection as rows, columns.
 
std::vector< std::vector< std::string > > values
 The values held within the connection. All values are stored as string.
 
int writable
 Boolean indicating whether the connection is writable (true) or not (false)
 
long paired_connection_id
 The connection to which this connection is paired, given by unique ID.
 
long parent_node_id
 The parent to this connection, given by its unique ID number.
 
int user_set
 Flag to indicate whether user has set this value via the GUI.
 

Detailed Description

Hold all information related to a connection point in the ImGUI UX.

Member Function Documentation

◆ fromJson()

void modelspace::Connection::fromJson ( const nlohmann::json &  j)

Create Connection object from json.

Parameters
jThe json object from which Connection is created

◆ toJson()

nlohmann::json modelspace::Connection::toJson ( )

Create json object from Connection.

Returns
The json object from connection data

The documentation for this struct was generated from the following files: