Pins in the GUI for information exchange.
More...
|
static bool | canCreateLink (const OutputPin &startPin, const InputPin &endPin) |
| Checks if pins can connect.
|
|
static bool | dataIdentifierHaveCommon (const std::vector< std::string > &a, const std::vector< std::string > &b) |
| Checks if the first list of data identifiers has a common entry with the second.
|
|
|
| Pin ()=default |
| Default constructor.
|
|
Pins in the GUI for information exchange.
Definition at line 42 of file Pin.hpp.
◆ Pin() [1/2]
NAV::Pin::Pin |
( |
ax::NodeEditor::PinId | id, |
|
|
const char * | name, |
|
|
Type | type, |
|
|
Kind | kind, |
|
|
Node * | parentNode ) |
|
inline |
Constructor.
- Parameters
-
[in] | id | Unique Id of the Pin |
[in] | name | Name of the Pin |
[in] | type | Type of the Pin |
[in] | kind | Kind of the Pin (Input/Output) |
[in] | parentNode | Reference to the parent node |
Definition at line 272 of file Pin.hpp.
◆ Pin() [2/2]
◆ canCreateLink()
Checks if pins can connect.
- Parameters
-
[in] | startPin | The start pin to create a link to |
[in] | endPin | The end pin to create a link to |
- Returns
- True if the pins can create a link
Definition at line 29 of file Pin.cpp.
◆ createLink()
bool NAV::Pin::createLink |
( |
OutputPin & | startPin, |
|
|
InputPin & | endPin, |
|
|
ax::NodeEditor::LinkId | linkId = 0 ) |
|
staticprotected |
Create a Link between the two given pins.
- Parameters
-
[in] | startPin | Start Pin of the link |
[in] | endPin | End Pin of the link |
[in] | linkId | Id of the link to create |
- Returns
- True if the link could be created
Definition at line 143 of file Pin.cpp.
◆ dataIdentifierHaveCommon()
bool NAV::Pin::dataIdentifierHaveCommon |
( |
const std::vector< std::string > & | a, |
|
|
const std::vector< std::string > & | b ) |
|
staticnodiscard |
Checks if the first list of data identifiers has a common entry with the second.
- Parameters
-
[in] | a | First list of data identifiers |
[in] | b | Second list of data identifiers |
- Returns
- True if they have a common entry
Definition at line 59 of file Pin.cpp.
◆ deleteLink()
Disconnects the link.
- Parameters
-
[in] | startPin | Start Pin of the link |
[in] | endPin | End Pin of the link |
Definition at line 206 of file Pin.cpp.
◆ drawPinIcon()
void NAV::Pin::drawPinIcon |
( |
bool | connected, |
|
|
int | alpha ) const |
Draw the Pin Icon.
- Parameters
-
[in] | connected | Flag if the pin is connected |
[in] | alpha | Alpha value of the pin |
Definition at line 98 of file Pin.cpp.
◆ getIconColor()
ImColor NAV::Pin::getIconColor |
( |
| ) |
const |
|
nodiscard |
Get the Icon Color object.
- Returns
- Color struct
Definition at line 65 of file Pin.cpp.
◆ recreateLink()
Destroys and recreates a link from this pin to another.
- Parameters
-
[in] | startPin | Start Pin of the link |
[in] | endPin | End Pin of the link |
- Returns
- True if the link could be created
Definition at line 196 of file Pin.cpp.
◆ dataIdentifier
std::vector<std::string> NAV::Pin::dataIdentifier |
One or multiple Data Identifiers (Unique name which is used for data flows)
Definition at line 305 of file Pin.hpp.
◆ id
ax::NodeEditor::PinId NAV::Pin::id |
◆ kind
◆ m_PinIconSize
int NAV::Pin::m_PinIconSize |
|
staticconstexprprivate |
Size of the Pin Icons in [px].
Definition at line 333 of file Pin.hpp.
◆ name
std::string NAV::Pin::name |
◆ parentNode
Node* NAV::Pin::parentNode |
Reference to the parent node.
Definition at line 307 of file Pin.hpp.
◆ type
The documentation for this class was generated from the following files:
- /home/runner/work/INSTINCT/INSTINCT/src/internal/Node/Pin.hpp
- /home/runner/work/INSTINCT/INSTINCT/src/internal/Node/Pin.cpp