Workspace::CorePin ​

#include "GUI/Workspace/Nodes/Basic/CorePins.h"

Inherits from DIWNE::Pin, DIWNE::DiwneObject, std::enable_shared_from_this< DiwneObject >

Public Functions ​

Public Attributes ​

Protected Attributes ​

Additional inherited members ​

Public Functions inherited from DIWNE::Pin

Protected Functions inherited from DIWNE::Pin

Public Attributes inherited from DIWNE::Pin

Protected Attributes inherited from DIWNE::Pin

Public Functions inherited from DIWNE::DiwneObject

Protected Functions inherited from DIWNE::DiwneObject

Public Attributes inherited from DIWNE::DiwneObject

Protected Attributes inherited from DIWNE::DiwneObject

Public Functions Documentation ​

function CorePin ​

CorePin(
    DIWNE::NodeEditor & diwne,
    Core::Pin const & pin,
    CoreNode * node,
    bool isInput,
    const std::string & label ="CorePin"
)

CorePin(
    DIWNE::NodeEditor & diwne,
    Core::Pin const & pin,
    CoreNode * node,
    bool isInput,
    const std::string & label ="CorePin"
)

function allowConnection ​

virtual bool allowConnection() const override

virtual bool allowConnection() const override

A condition for starting and receiving a link connection.

Reimplements: DIWNE::Pin::allowConnection

Can be used to specify an area where the pin can be dragged from or a link dropped at.

function allowDrawing ​

virtual bool allowDrawing() override

virtual bool allowDrawing() override

Decide whether the object should be drawn (when outside the window for example)

Reimplements: DIWNE::DiwneObject::allowDrawing

function canPlug ​

bool canPlug(
    Pin * other
) const override

bool canPlug(
    Pin * other
) const override

function content ​

virtual void content(
    DIWNE::DrawInfo & context
) override

virtual void content(
    DIWNE::DrawInfo & context
) override

Called after begin() during drawing.

Reimplements: DIWNE::DiwneObject::content

Draws object content.

function createLink ​

virtual std::shared_ptr< DIWNE::Link > createLink() override

virtual std::shared_ptr< DIWNE::Link > createLink() override

Method responsible for constructing a new link for this pin.

Return: The new Link instance, it is already registered with the current editor and has no connections yet.

Reimplements: DIWNE::Pin::createLink

By default a standard Link object is used, however this method can be overriden to allow specific pins to use specialized link subclasses.

function drawData ​

bool drawData(
    DIWNE::DrawInfo & context
)

bool drawData(
    DIWNE::DrawInfo & context
)

Return: Whether a new item was created

function drawDataEx ​

bool drawDataEx(
    DIWNE::DrawInfo & context
)

bool drawDataEx(
    DIWNE::DrawInfo & context
)

Return: Whether a new item was created

function drawLabel ​

void drawLabel(
    DIWNE::DrawInfo & context,
    const std::string & label
)

void drawLabel(
    DIWNE::DrawInfo & context,
    const std::string & label
)

Return: Whether a ne;w item was created

function drawPin ​

DIWNE::PinIconDrawData drawPin(
    bool left,
    float alpha
)

DIWNE::PinIconDrawData drawPin(
    bool left,
    float alpha
)

Return: Offset by which the pin is sticking out of the node.

function ensureLinkSyncWithCore ​

bool ensureLinkSyncWithCore()

bool ensureLinkSyncWithCore()

This method ensures the state of this pin is synchronized with the core state.

Return: Whether a change was made.

Currently ONLY deletes links that should no longer exist. As to create new links it would need to search for a GUI equivalent of a certain Core pin.

function getCoreIndex ​

int getCoreIndex() const

int getCoreIndex() const

function getCorePin ​

Core::Pin const & getCorePin() const

Core::Pin const & getCorePin() const

function getType ​

Core::EValueType getType() const

Core::EValueType getType() const

function isConnected ​

bool isConnected() const

bool isConnected() const

function isDisabled ​

virtual bool isDisabled() const override

virtual bool isDisabled() const override

/// Whether the pin is disabled or not. When disabled it cannot be plugged in.

Reimplements: DIWNE::Pin::isDisabled

function maxLengthOfData ​

int maxLengthOfData()

int maxLengthOfData()

See: CoreNode::maxLengthOfData()

function onPlug ​

virtual void onPlug(
    DIWNE::Pin * otherPin,
    DIWNE::Link * link,
    bool isStartPin,
    bool logEvent =true
) override

virtual void onPlug(
    DIWNE::Pin * otherPin,
    DIWNE::Link * link,
    bool isStartPin,
    bool logEvent =true
) override

Called after the pin has been connected to another pin using a link.

Parameters:

• otherPin The pin on the other side of the link. Cannot be null.
• link The link of the new connection with both ends plugged.
• isStartPin Whether this pin is the start of the connection (otherwise it's the end).
• logEvent The flag passed to the origin of the action.

Reimplements: DIWNE::Pin::onPlug

function onReleased ​

virtual void onReleased(
    bool justReleased,
    DIWNE::DrawInfo & context
) override

virtual void onReleased(
    bool justReleased,
    DIWNE::DrawInfo & context
) override

Called when the object is not pressed.

Parameters:

• justPressed True on the frame the object is released (becomes no longer pressed)

See: onPressed()

Reimplements: DIWNE::DiwneObject::onReleased

Every frame either this or the onPressed() method is called.

function onUnplug ​

virtual void onUnplug(
    DIWNE::Pin * otherPin,
    DIWNE::Link * link,
    bool wasStartPin,
    bool logEvent =true
) override

virtual void onUnplug(
    DIWNE::Pin * otherPin,
    DIWNE::Link * link,
    bool wasStartPin,
    bool logEvent =true
) override

Called after the link connecting this pin to another is disconnected.

Parameters:

• otherPin The pin on the other side of the link. Can be null.
• link The link of the disconnected connection.
• wasStartPin Whether this pin was the start of the connection (otherwise it was the end).
• logEvent The flag passed to the origin of the action.

Reimplements: DIWNE::Pin::onUnplug

function plugLink ​

virtual bool plugLink(
    DIWNE::Pin * otherPin,
    DIWNE::Link * link,
    bool logEvent =true
) override

virtual bool plugLink(
    DIWNE::Pin * otherPin,
    DIWNE::Link * link,
    bool logEvent =true
) override

Connect this and some other pin together using an existing link.

Parameters:

• otherPin The other pin on the other side of the link.
• link
• logEvent The boolean flag passed to onUnplug() on successful disconnect

Return: true

Reimplements: DIWNE::Pin::plugLink

The other pin is considered the start of the link, except when it is an input pin. Both pins cannot be input pins. The link will get unplugged from other pins if necessary.

function preparePlug ​

bool preparePlug(
    Pin * otherPin,
    DIWNE::Link * link,
    bool hovering,
    DIWNE::DrawInfo & context
) override

bool preparePlug(
    Pin * otherPin,
    DIWNE::Link * link,
    bool hovering,
    DIWNE::DrawInfo & context
) override

Same nodes.

function renderPinDiwne ​

void renderPinDiwne(
    DIWNE::PinIconDrawData & data
) const

void renderPinDiwne(
    DIWNE::PinIconDrawData & data
) const

Internal method to render pin icon based on previously generated pin icon draw data.

Ł This method is public as the rendering is sometimes deferred to the parent node.

function tooltipContent ​

virtual void tooltipContent(
    DIWNE::DrawInfo & context
) override

virtual void tooltipContent(
    DIWNE::DrawInfo & context
) override

Content of the object's tooltip.

Reimplements: DIWNE::DiwneObject::tooltipContent

Public Attributes Documentation ​

variable m_iconType ​

DIWNE::IconType m_iconType = DIWNE::IconType::NoIcon;

DIWNE::IconType m_iconType = DIWNE::IconType::NoIcon;

variable m_pinStyle ​

PinStyle m_pinStyle {PinStyle::Square};

PinStyle m_pinStyle {PinStyle::Square};

variable m_showData ​

bool m_showData {true};

bool m_showData {true};

Protected Attributes Documentation ​

variable m_pin ​

Core::Pin const  & m_pin;

Core::Pin const  & m_pin;

Updated on 2025-05-31 at 12:55:30 +0000