DIWNE::NodeEditor ​

The DIWNE node editor object. More...

#include "DIWNE/Core/NodeEditor.h"

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

Inherited by Workspace::WorkspaceDiwne

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 inherited from DIWNE::NodeContainer

Protected Functions inherited from DIWNE::NodeContainer

Protected Attributes inherited from DIWNE::NodeContainer

Public Functions inherited from DIWNE::INodeContainer

Detailed Description ​

class DIWNE::NodeEditor;

class DIWNE::NodeEditor;

The DIWNE node editor object.

Every DiwneObject has a reference to this object.

Public Functions Documentation ​

function NodeEditor ​

NodeEditor(
    const char * label,
    SettingsDiwne * settingsDiwne
)

NodeEditor(
    const char * label,
    SettingsDiwne * settingsDiwne
)

Create a node editor instance.

Parameters:

• settingsDiwne

Return:

Note: NodeEditor must MUST be instantiated as a shared pointer using std::make_shared! It cannot be defined as a local stack variable or static value variable or even manually using the new operator.

function ~NodeEditor ​

~NodeEditor() override

~NodeEditor() override

function addLink ​

void addLink(
    std::shared_ptr< Link > link
)

void addLink(
    std::shared_ptr< Link > link
)

function addNode ​

void addNode(
    const std::shared_ptr< Node > & node
)

void addNode(
    const std::shared_ptr< Node > & node
)

function addNode ​

void addNode(
    const std::shared_ptr< Node > & node,
    const ImVec2 position,
    bool shiftToLeftByNodeWidth =false
)

void addNode(
    const std::shared_ptr< Node > & node,
    const ImVec2 position,
    bool shiftToLeftByNodeWidth =false
)

function afterDraw ​

virtual void afterDraw(
    DrawInfo & context
) override

virtual void afterDraw(
    DrawInfo & context
) override

Called last during drawing.

Reimplements: DIWNE::DiwneObject::afterDraw

At this point the m_rect of the object should be calculated in the updateLayout() method and this method should be able to work with it. Because of that the drawing code within shouldn't affect the objects size anymore. Interactions are processed before this method and thus interaction related member variables can be used within.

function allowZoom ​

virtual bool allowZoom()

virtual bool allowZoom()

function begin ​

virtual void begin(
    DrawInfo & context
) override

virtual void begin(
    DrawInfo & context
) override

First method to be called during object drawing.

Reimplements: DIWNE::DiwneObject::begin

Reimplemented by: Workspace::WorkspaceDiwne::begin

Can be used to initialize drawing code.

function bringLastActiveNodeToFront ​

void bringLastActiveNodeToFront()

void bringLastActiveNodeToFront()

function bringMarkedNodesToFront ​

void bringMarkedNodesToFront()

void bringMarkedNodesToFront()

function canvas ​

inline Canvas & canvas() const

inline Canvas & canvas() const

Get a reference to the canvas component of the node editor.

Canvas contains information about the position of the viewport displaying the editor's infinite 2D plane. It also holds utility methods used for drawing content within the plane (diwne coordinates).

function clear ​

virtual void clear()

virtual void clear()

Clear all nodes from the node editor.

function content ​

virtual void content(
    DrawInfo & context
) override

virtual void content(
    DrawInfo & context
) override

Called after begin() during drawing.

Reimplements: DIWNE::DiwneObject::content

Reimplemented by: Workspace::WorkspaceDiwne::content

Draws object content.

Todosee #111, wrongly computed m_takeSnap value.

function createLink ​

template <class T ,
typename... Args>
inline auto createLink(
    Args &&... args
)

template <class T ,
typename... Args>
inline auto createLink(
    Args &&... args
)

Create a new link of type T and add it to the node editor.

Template Parameters:

• T

Return: An owning shared ptr to the new link. Note that the link is already owned by the node editor at this point in time.

function createNode ​

template <class T ,
typename... Args>
inline auto createNode(
    const ImVec2 position =ImVec2(0, 0),
    Args &&... args
)

template <class T ,
typename... Args>
inline auto createNode(
    const ImVec2 position =ImVec2(0, 0),
    Args &&... args
)

Creates a new node in the node editor of the specified type.

Parameters:

• position Initial position of the node
• args Node constructor arguments (except the first NodeEditor reference)

Template Parameters:

• T Node type

Return: Shared pointer to the node.

It is assumed that the first argument of the node's constructor is a NodeEditor reference and can be ommited.

function createNode ​

template <class T >
inline auto createNode(
    const ImVec2 position =ImVec2(0, 0),
    bool shiftToLeftByNodeWidth =false
)

template <class T >
inline auto createNode(
    const ImVec2 position =ImVec2(0, 0),
    bool shiftToLeftByNodeWidth =false
)

function deleteSelectedNodes ​

void deleteSelectedNodes()

void deleteSelectedNodes()

function deselectAllNodes ​

virtual void deselectAllNodes()

virtual void deselectAllNodes()

function draw ​

virtual void draw(
    DrawMode drawMode =DrawMode_Interactive
) override

virtual void draw(
    DrawMode drawMode =DrawMode_Interactive
) override

Generic draw method meant to be used by external code.

Parameters:

• drawMode Drawing mode

See: drawDiwne()

Reimplements: DIWNE::DiwneObject::draw

Note that some objects are meant to only by drawn using the internal drawDiwne() method instead.

function end ​

virtual void end(
    DrawInfo & context
) override

virtual void end(
    DrawInfo & context
) override

Called after content().

Reimplements: DIWNE::DiwneObject::end

Reimplemented by: Workspace::WorkspaceDiwne::end

Used to end content drawing.

function getAllNodesInnerIncluded ​

virtual RecursiveNodeRange getAllNodesInnerIncluded() const

virtual RecursiveNodeRange getAllNodesInnerIncluded() const

function getDpiScale ​

inline float getDpiScale() const

inline float getDpiScale() const

function getLastActiveNode ​

template <typename T  =Node>
inline std::shared_ptr< T > getLastActiveNode()

template <typename T  =Node>
inline std::shared_ptr< T > getLastActiveNode()

function getNodeList ​

virtual NodeList & getNodeList() override

virtual NodeList & getNodeList() override

Get a reference to the underlying owning vector of all nodes in the node editor.

Reimplements: DIWNE::NodeContainer::getNodeList

function getNodes ​

virtual NodeRange getNodes() const override

virtual NodeRange getNodes() const override

Get a view of all nodes in the node editor which can be iterated over.

Reimplements: DIWNE::NodeContainer::getNodes

The object returned is a trivial container wrapper around a node iterator. TODO: Better docs with an example TODO: This can be const. TODO: There is an idea that iterators could filter out destroyed nodes by default. Consider.

function getNodesSelectionChanged ​

bool getNodesSelectionChanged() const

bool getNodesSelectionChanged() const

function getPopupPosition ​

const ImVec2 & getPopupPosition() const

const ImVec2 & getPopupPosition() const

Get position of the last popup in screen coordinates.

function getSelectedNodes ​

virtual FilteredNodeRange getSelectedNodes() const

virtual FilteredNodeRange getSelectedNodes() const

function getSelectedNodesInnerIncluded ​

virtual FilteredRecursiveNodeRange getSelectedNodesInnerIncluded() const

virtual FilteredRecursiveNodeRange getSelectedNodesInnerIncluded() const

function getStyleOverride ​

StyleOverride * getStyleOverride() const =delete

StyleOverride * getStyleOverride() const =delete

function getZoom ​

inline float getZoom() const

inline float getZoom() const

function initializeDiwne ​

virtual void initializeDiwne(
    DrawInfo & context
) override

virtual void initializeDiwne(
    DrawInfo & context
) override

Reimplements: DIWNE::DiwneObject::initializeDiwne

function input ​

inline NodeEditorInputAdapter & input() const

inline NodeEditorInputAdapter & input() const

Get a reference to the node editors input adapter.

This object contains input bindings and can be set on the fly externally to swap input schemes.

function invertSelection ​

void invertSelection()

void invertSelection()

function isJustPressedDiwne ​

virtual bool isJustPressedDiwne() override

virtual bool isJustPressedDiwne() override

Determine whether a key/s of interest was/were just pressed.

See: isPressedDiwne()

Reimplements: DIWNE::DiwneObject::isJustPressedDiwne

For the press action to be carried out this method must return true at least once during the key press and release cycle. This method is needed to avoid starting the press and release cycle when the key was not pressed initially over this object (Dragging pressed mouse over the object).

function isPressedDiwne ​

virtual bool isPressedDiwne() override

virtual bool isPressedDiwne() override

Determine whether a key/s of interest is/are pressed down over the object.

See: When overriding also modify isJustPressedDiwne()

Note: Overriding the pressed state behavior will modify the dragging and selection behavior.

Reimplements: DIWNE::DiwneObject::isPressedDiwne

While the key is down this method should return true until the key is released.

When this method returns true and other conditions are met (hovered, press allowed), the object pressed flag is set to true and onPress() method is called.

If multiple keys make this method return true it is necessary to distinguish between them later in the implementation if different functionality for each key is desired.

function isZoomingDiwne ​

virtual bool isZoomingDiwne()

virtual bool isZoomingDiwne()

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

virtual void onDrag(
    DrawInfo & context,
    bool dragStart,
    bool dragEnd
) override

virtual void onDrag(
    DrawInfo & context,
    bool dragStart,
    bool dragEnd
) override

This method gets called when the object is being dragged.

Parameters:

• dragStart The drag has just started this frame.
• dragEnd The drag is ending this frame.

See: processDragDiwne(), processPressAndReleaseDiwne()

Reimplements: DIWNE::DiwneObject::onDrag

Reimplemented by: Workspace::WorkspaceDiwne::onDrag

Drag begins when the object is pressed and isDraggedDiwne() returns true.

A call with dragStart true, should always be followed by a call with dragEnd true.

function onReleased ​

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

virtual void onReleased(
    bool justReleased,
    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 onZoom ​

inline virtual void onZoom()

inline virtual void onZoom()

Reimplemented by: Workspace::WorkspaceDiwne::onZoom

function processInteractions ​

virtual void processInteractions(
    DrawInfo & context
) override

virtual void processInteractions(
    DrawInfo & context
) override

Method for reacting to user input after the object is fully drawn and its dimensions are known.

Reimplements: DIWNE::DiwneObject::processInteractions

Reimplemented by: Workspace::WorkspaceDiwne::processInteractions

It is called after end() and updateLayout(), but before the afterDraw() lifecycle method. Internal interactions are processed right before.

function processPan ​

virtual bool processPan()

virtual bool processPan()

Called by Canvas::setZoom() when the zoom level changes.

function processZoom ​

virtual bool processZoom()

virtual bool processZoom()

function purgeAllNodes ​

void purgeAllNodes()

void purgeAllNodes()

Erases objects marked for deletion or removal from the editor.

Also iterates through all NodeContainers in the editor and purges their nodes.

function selectAllNodes ​

void selectAllNodes(
    bool deselectIfAllAreSelected =false
)

void selectAllNodes(
    bool deselectIfAllAreSelected =false
)

Selects all nodes.

Parameters:

• deselectIfAllAreSelected If true and all nodes were already selected, deselect them all.

function setDpiScale ​

inline void setDpiScale(
    float dpiScale
)

inline void setDpiScale(
    float dpiScale
)

Set the node editor's dpi scale. Updates dpi scale of its style as well.

function setInputAdapter ​

template <class T ,
typename... Args>
void setInputAdapter(
    Args &&... args
)

template <class T ,
typename... Args>
void setInputAdapter(
    Args &&... args
)

function setLastActiveNode ​

inline void setLastActiveNode(
    std::shared_ptr< Node > node
)

inline void setLastActiveNode(
    std::shared_ptr< Node > node
)

function setNodesSelectionChanged ​

void setNodesSelectionChanged(
    bool value
)

void setNodesSelectionChanged(
    bool value
)

function setPopupPosition ​

void setPopupPosition(
    ImVec2 position
)

void setPopupPosition(
    ImVec2 position
)

Set position of the last popup in screen coordinates, used for placement of new nodes.

function setStyle ​

inline void setStyle(
    std::unique_ptr< StyleBase > && ptr
)

inline void setStyle(
    std::unique_ptr< StyleBase > && ptr
)

function setStyleOverride ​

void setStyleOverride(
    StyleOverride * styleOverride
) =delete

void setStyleOverride(
    StyleOverride * styleOverride
) =delete

function setZoom ​

inline void setZoom(
    float val
)

inline void setZoom(
    float val
)

function shiftNodesToBegin ​

void shiftNodesToBegin(
    const NodeList & nodesToShift
)

void shiftNodesToBegin(
    const NodeList & nodesToShift
)

function shiftNodesToEnd ​

void shiftNodesToEnd(
    const NodeList & nodesToShift
)

void shiftNodesToEnd(
    const NodeList & nodesToShift
)

function style ​

inline virtual Style & style() const override

inline virtual Style & style() const override

Get a reference to the editors style settings, which specify various colors and sizes much like ImStyle.

Reimplements: DIWNE::DiwneObject::style

function styleBase ​

inline StyleBase & styleBase() const

inline StyleBase & styleBase() const

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

virtual bool isDraggedDiwne() override

virtual bool isDraggedDiwne() override

Is the object being dragged? (usually by mouse or some key combo)

Reimplements: DIWNE::DiwneObject::isDraggedDiwne

function purgeObjects ​

void purgeObjects()

void purgeObjects()

Erases objects marked for deletion or removal from the editor.

Public Attributes Documentation ​

variable interactionState ​

InteractionState interactionState;

InteractionState interactionState;

State of multi-frame user operations.

variable m_links ​

std::vector< std::shared_ptr< Link > > m_links;

std::vector< std::shared_ptr< Link > > m_links;

List of links, nodes are stored in NodeContainer superclass.

variable m_takeSnap ​

bool m_takeSnap {false};

bool m_takeSnap {false};

Indicates that a state change has occurred, can be used for undo/redo systems.

variable mp_settingsDiwne ​

SettingsDiwne * mp_settingsDiwne;

SettingsDiwne * mp_settingsDiwne;

Protected Attributes Documentation ​

variable m_canvas ​

std::unique_ptr< Canvas > m_canvas = std::make_unique<Canvas>(*this);

std::unique_ptr< Canvas > m_canvas = std::make_unique<Canvas>(*this);

variable m_channelSplitter ​

ImDrawListSplitter m_channelSplitter;

ImDrawListSplitter m_channelSplitter;

Channel splitter used to call nodes draw methods in reverse order.

variable m_input ​

std::unique_ptr< NodeEditorInputAdapter > m_input = std::make_unique<NodeEditorInputAdapter>(*this);

std::unique_ptr< NodeEditorInputAdapter > m_input = std::make_unique<NodeEditorInputAdapter>(*this);

variable m_lastActiveNodeChanged ​

bool m_lastActiveNodeChanged {false};

bool m_lastActiveNodeChanged {false};

variable m_nodesSelectionChanged ​

bool m_nodesSelectionChanged {false};

bool m_nodesSelectionChanged {false};

variable m_popupPosition ​

ImVec2 m_popupPosition;

ImVec2 m_popupPosition;

Position of the last popup in screen coordinates.

variable m_style ​

std::unique_ptr< StyleBase > m_style = std::make_unique<StyleBase>();

std::unique_ptr< StyleBase > m_style = std::make_unique<StyleBase>();

variable mp_lastActiveNode ​

std::weak_ptr< Node > mp_lastActiveNode;

std::weak_ptr< Node > mp_lastActiveNode;

Last node that requested focus (had a logical update)

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