DIWNE::Link ​

#include "DIWNE/Core/Elements/Link.h"

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

Inherited by Workspace::CoreLink

Public Functions ​

Protected Functions ​

Public Attributes ​

Protected Attributes ​

Additional inherited members ​

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 Link ​

Link(
    NodeEditor & diwne,
    std::string labelDiwne ="DiwneLink"
)

Link(
    NodeEditor & diwne,
    std::string labelDiwne ="DiwneLink"
)

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 begin ​

inline virtual void begin(
    DrawInfo & context
) override

inline virtual void begin(
    DrawInfo & context
) override

Link isn't an ImGui item, nothing to begin.

Reimplements: DIWNE::DiwneObject::begin

function connect ​

virtual bool connect(
    Pin * startPin,
    Pin * endPin,
    bool logEvent =true
)

virtual bool connect(
    Pin * startPin,
    Pin * endPin,
    bool logEvent =true
)

Connect the two pins using this link.

Parameters:

• startPin
• endPin
• logEvent The boolean flag passed to onPlug() on successful connect

Return: True when the link was already registered with one of the pins

On success this method calls onPlug() on both pins. If the link has different pins plugged in already, the corresponding pins get unplugged.

function content ​

virtual void content(
    DrawInfo & context
) override

virtual void content(
    DrawInfo & context
) override

Called after begin() during drawing.

Reimplements: DIWNE::DiwneObject::content

Draws object content.

function disconnect ​

virtual bool disconnect(
    bool logEvent =true
)

virtual bool disconnect(
    bool logEvent =true
)

Disconnect all pins.

Parameters:

• logEvent The boolean flag passed to onPlug() on successful connect

Return: True on success, false otherwise (if it wasn't connected)

On success this method calls onUnplug() on both pins.

function disconnectPin ​

virtual bool disconnectPin(
    bool startOrEndPin,
    bool logEvent =true
)

virtual bool disconnectPin(
    bool startOrEndPin,
    bool logEvent =true
)

Disconnect one of the pins.

Parameters:

• startOrEndPin Whether to disconnect the start or end pin.
• logEvent The boolean flag passed to onPlug() on successful connect.

Return: True on success, false otherwise (if it wasn't connected)

On success this method calls onUnplug() on the disconnected pin.

function disconnectPin ​

virtual bool disconnectPin(
    Pin * pin,
    bool logEvent =true
)

virtual bool disconnectPin(
    Pin * pin,
    bool logEvent =true
)

function end ​

virtual void end(
    DrawInfo & context
) override

virtual void end(
    DrawInfo & context
) override

No need to set m_internalHover as we handle hovering ourself.

Reimplements: DIWNE::DiwneObject::end

function getAnyPin ​

Pin * getAnyPin() const

Pin * getAnyPin() const

Get any of the two pins or nullptr if neither are connected.

function getEndControlPoint ​

inline ImVec2 getEndControlPoint() const

inline ImVec2 getEndControlPoint() const

function getEndPin ​

inline Pin * getEndPin() const

inline Pin * getEndPin() const

function getEndPoint ​

inline ImVec2 getEndPoint() const

inline ImVec2 getEndPoint() const

function getOtherPin ​

Pin * getOtherPin(
    Pin * pin
) const

Pin * getOtherPin(
    Pin * pin
) const

Get the other pin that this link connects with the specified pin.

Assumes the link is connected on both ends Returns nullptr when neither of the two pins are the passed one.

function getSinglePin ​

Pin * getSinglePin() const

Pin * getSinglePin() const

Get the pin on either end in cases when only one pin is plugged in.

Returns nullptr no pins are connected or if both ends are connected.

function getStartControlPoint ​

inline ImVec2 getStartControlPoint() const

inline ImVec2 getStartControlPoint() const

function getStartPin ​

inline Pin * getStartPin() const

inline Pin * getStartPin() const

function getStartPoint ​

inline ImVec2 getStartPoint() const

inline ImVec2 getStartPoint() const

function initialize ​

virtual void initialize(
    DrawInfo & context
) override

virtual void initialize(
    DrawInfo & context
) override

First method to be called every frame.

Reimplements: DIWNE::DiwneObject::initialize

Does not handle drawing.

function isLinkOnWorkArea ​

bool isLinkOnWorkArea() const

bool isLinkOnWorkArea() const

in fact just rectangle (from startPoint to endPoint) check - so could return true while Link is not visible

function isOnePinPlugged ​

bool isOnePinPlugged() const

bool isOnePinPlugged() const

Whether the link has exactly one pin plugged in at either end.

function isPlugged ​

bool isPlugged() const

bool isPlugged() const

Whether the link is connected on both ends.

function onDestroy ​

virtual void onDestroy(
    bool logEvent
) override

virtual void onDestroy(
    bool logEvent
) override

Gets called the moment the object is marked for deletion by destroy().

See: destroy()

Warning: It is possible that the onDestroy() callback is never called when destroy() wasn't properly called. DiwneObjects containing other DiwneObjects should always ensure to destroy their children in their onDestroy().

Reimplements: DIWNE::DiwneObject::onDestroy

It is called only once per object.

function onHover ​

virtual void onHover(
    DrawInfo & context
) override

virtual void onHover(
    DrawInfo & context
) override

This method gets called when the object is hovered.

Parameters:

• context

See: processHoverDiwne()

Reimplements: DIWNE::DiwneObject::onHover

This generally indicates mouse hover, but the behavior can be changed via isHoveredDiwne().

function setEndPin ​

inline void setEndPin(
    Pin * pin
)

inline void setEndPin(
    Pin * pin
)

function setEndPoint ​

void setEndPoint(
    const ImVec2 & mEndDiwne
)

void setEndPoint(
    const ImVec2 & mEndDiwne
)

function setStartPin ​

inline void setStartPin(
    Pin * pin
)

inline void setStartPin(
    Pin * pin
)

function setStartPoint ​

void setStartPoint(
    const ImVec2 & mStartDiwne
)

void setStartPoint(
    const ImVec2 & mStartDiwne
)

function updateLayout ​

virtual void updateLayout(
    DrawInfo & context
) override

virtual void updateLayout(
    DrawInfo & context
) override

Updates object's m_rect, m_displayRect and any other object size variables.

See: m_rect, m_displayRect

Reimplements: DIWNE::DiwneObject::updateLayout

In other words this method is responsible for keeping track of the objects size.

IMPORTANT: This method should only update the m_rect's size, NOT it's position.

The object's rectangle is often set directly from ImGui's last item rectangle. But ImGui coordinates are aligned to pixel boundries via truncation of the coordinates, if the object's rect was updated directly using the screen space ImGui rectangle, there might be a slight discrepancy in the new position converted back to DIWNE coordinates which would cause the object to drift in a feedback loop.

m_displayRect should be updated together with m_rect to preserve correct pixel-aligned rendering in afterDraw(). TODO: Figure out if m_displayRect.Max should be aligned as well or not

This method is called after end() and before the afterDraw() method which can use the calculated size values for final drawing.

Protected Functions Documentation ​

function getBounds ​

virtual ImRect getBounds()

virtual ImRect getBounds()

Get the rect formed by the starting and ending point, as well as any curve control points.

This method is used in updateLayout() to update the object's rect as well as in allowDrawing().

function initializeDiwne ​

virtual void initializeDiwne(
    DrawInfo & context
) override

virtual void initializeDiwne(
    DrawInfo & context
) override

Reimplements: DIWNE::DiwneObject::initializeDiwne

function isHoveredDiwne ​

virtual bool isHoveredDiwne() override

virtual bool isHoveredDiwne() override

Link isn't represented by an ImGui item so we need to detect hovering manually.

Reimplements: DIWNE::DiwneObject::isHoveredDiwne

function setInitialPositionDiwne ​

virtual void setInitialPositionDiwne() override

virtual void setInitialPositionDiwne() override

Internal helper for setting the object's initial position.

Reimplements: DIWNE::DiwneObject::setInitialPositionDiwne

function updateControlPoints ​

virtual void updateControlPoints()

virtual void updateControlPoints()

Reimplemented by: Workspace::CoreLink::updateControlPoints

function updateEndpoints ​

virtual void updateEndpoints()

virtual void updateEndpoints()

function updateSquareDistanceMouseFromLink ​

void updateSquareDistanceMouseFromLink()

void updateSquareDistanceMouseFromLink()

Public Attributes Documentation ​

variable m_previewPlugged ​

bool m_previewPlugged {false};

bool m_previewPlugged {false};

Style the link as if it was plugged in.

Protected Attributes Documentation ​

variable m_color ​

ImVec4 m_color;

ImVec4 m_color;

variable m_controlPointEndDiwne ​

ImVec2 m_controlPointEndDiwne;

ImVec2 m_controlPointEndDiwne;

variable m_controlPointStartDiwne ​

ImVec2 m_controlPointStartDiwne;

ImVec2 m_controlPointStartDiwne;

variable m_endDiwne ​

ImVec2 m_endDiwne;

ImVec2 m_endDiwne;

variable m_endPin ​

Pin * m_endPin {nullptr};

Pin * m_endPin {nullptr};

variable m_squaredDistanceMouseFromLink ​

float m_squaredDistanceMouseFromLink {std::numeric_limits<float>::max()};

float m_squaredDistanceMouseFromLink {std::numeric_limits<float>::max()};

variable m_startDiwne ​

ImVec2 m_startDiwne;

ImVec2 m_startDiwne;

variable m_startPin ​

Pin * m_startPin {nullptr};

Pin * m_startPin {nullptr};

variable m_widthOffset ​

float m_widthOffset {0.f};

float m_widthOffset {0.f};

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