Skip to content

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

Name
NodeEditor(const char * label, SettingsDiwne * settingsDiwne)<br>Create a node editor instance.
~NodeEditor() override
voidaddLink(std::shared_ptr< Link > link)
voidaddNode(const std::shared_ptr< Node > & node)
voidaddNode(const std::shared_ptr< Node > & node, const ImVec2 position, bool shiftToLeftByNodeWidth =false)
virtual voidafterDraw(DrawInfo & context) override<br>Called last during drawing.
virtual boolallowZoom()
virtual voidbegin(DrawInfo & context) override<br>First method to be called during object drawing.
voidbringLastActiveNodeToFront()
voidbringMarkedNodesToFront()
Canvas &canvas() const<br>Get a reference to the canvas component of the node editor.
virtual voidclear()<br>Clear all nodes from the node editor.
virtual voidcontent(DrawInfo & context) override<br>Called after begin() during drawing.
template <class T ,typename... Args&gt; <br>autocreateLink(Args &&... args)<br>Create a new link of type T and add it to the node editor.
template <class T ,typename... Args&gt; <br>autocreateNode(const ImVec2 position =ImVec2(0, 0), Args &&... args)<br>Creates a new node in the node editor of the specified type.
template <class T &gt; <br>autocreateNode(const ImVec2 position =ImVec2(0, 0), bool shiftToLeftByNodeWidth =false)
voiddeleteSelectedNodes()
virtual voiddeselectAllNodes()
virtual voiddraw(DrawMode drawMode =DrawMode_Interactive) override<br>Generic draw method meant to be used by external code.
virtual voidend(DrawInfo & context) override<br>Called after content().
virtual RecursiveNodeRangegetAllNodesInnerIncluded() const
floatgetDpiScale() const
template <typename T =Node&gt; <br>std::shared_ptr< T >getLastActiveNode()
virtual NodeList &getNodeList() override<br>Get a reference to the underlying owning vector of all nodes in the node editor.
virtual NodeRangegetNodes() const override<br>Get a view of all nodes in the node editor which can be iterated over.
boolgetNodesSelectionChanged() const
const ImVec2 &getPopupPosition() const<br>Get position of the last popup in screen coordinates.
virtual FilteredNodeRangegetSelectedNodes() const
virtual FilteredRecursiveNodeRangegetSelectedNodesInnerIncluded() const
StyleOverride *getStyleOverride() const =delete
floatgetZoom() const
virtual voidinitializeDiwne(DrawInfo & context) override
NodeEditorInputAdapter &input() const<br>Get a reference to the node editors input adapter.
voidinvertSelection()
virtual boolisJustPressedDiwne() override<br>Determine whether a key/s of interest was/were just pressed.
virtual boolisPressedDiwne() override<br>Determine whether a key/s of interest is/are pressed down over the object.
virtual boolisZoomingDiwne()
virtual voidonDestroy(bool logEvent) override<br>Gets called the moment the object is marked for deletion by destroy().
virtual voidonDrag(DrawInfo & context, bool dragStart, bool dragEnd) override<br>This method gets called when the object is being dragged.
virtual voidonReleased(bool justReleased, DrawInfo & context) override<br>Called when the object is not pressed.
virtual voidonZoom()
virtual voidprocessInteractions(DrawInfo & context) override<br>Method for reacting to user input after the object is fully drawn and its dimensions are known.
virtual boolprocessPan()<br>Called by Canvas::setZoom() when the zoom level changes.
virtual boolprocessZoom()
voidpurgeAllNodes()<br>Erases objects marked for deletion or removal from the editor.
voidselectAllNodes(bool deselectIfAllAreSelected =false)<br>Selects all nodes.
voidsetDpiScale(float dpiScale)<br>Set the node editor's dpi scale. Updates dpi scale of its style as well.
template <class T ,typename... Args&gt; <br>voidsetInputAdapter(Args &&... args)
voidsetLastActiveNode(std::shared_ptr< Node > node)
voidsetNodesSelectionChanged(bool value)
voidsetPopupPosition(ImVec2 position)<br>Set position of the last popup in screen coordinates, used for placement of new nodes.
voidsetStyle(std::unique_ptr< StyleBase > && ptr)
voidsetStyleOverride(StyleOverride * styleOverride) =delete
voidsetZoom(float val)
voidshiftNodesToBegin(const NodeList & nodesToShift)
voidshiftNodesToEnd(const NodeList & nodesToShift)
virtual Style &style() const override<br>Get a reference to the editors style settings, which specify various colors and sizes much like ImStyle.
StyleBase &styleBase() const
virtual voidupdateLayout(DrawInfo & context) override<br>Updates object's m_rect, m_displayRect and any other object size variables.

Protected Functions

Name
virtual boolisDraggedDiwne() override<br>Is the object being dragged? (usually by mouse or some key combo)
voidpurgeObjects()<br>Erases objects marked for deletion or removal from the editor.

Public Attributes

Name
InteractionStateinteractionState <br>State of multi-frame user operations.
std::vector< std::shared_ptr< Link > >m_links <br>List of links, nodes are stored in NodeContainer superclass.
boolm_takeSnap <br>Indicates that a state change has occurred, can be used for undo/redo systems.
SettingsDiwne *mp_settingsDiwne

Protected Attributes

Name
std::unique_ptr< Canvas >m_canvas
ImDrawListSplitterm_channelSplitter <br>Channel splitter used to call nodes draw methods in reverse order.
std::unique_ptr< NodeEditorInputAdapter >m_input
boolm_lastActiveNodeChanged
boolm_nodesSelectionChanged
ImVec2m_popupPosition <br>Position of the last popup in screen coordinates.
std::unique_ptr< StyleBase >m_style
std::weak_ptr< Node >mp_lastActiveNode <br>Last node that requested focus (had a logical update)

Additional inherited members

Public Functions inherited from DIWNE::DiwneObject

Name
DiwneObject(DIWNE::NodeEditor & diwne, std::string labelDiwne)
virtual~DiwneObject()
virtual boolallowDragStart() const<br>Determines whether a drag operation can start from this object.
virtual boolallowDrawing()<br>Decide whether the object should be drawn (when outside the window for example)
virtual boolallowHover() const<br>Determines whether the object can be hovered.
virtual boolallowInteraction() const<br>Decide whether the object should react to user input in general.
virtual boolallowPopup() const<br>Determines whether a popup can be raised over the object.
virtual boolallowPress(const DrawInfo & context) const<br>Determines whether the object can be pressed.
virtual boolallowSelectOnClick(const DrawInfo & context) const<br>Determines whether the object can be selected by clicking it (eg.
template <typename T =DiwneObject&gt; <br>T *as()<br>Returns a raw pointer to itself casted to a type.
virtual voiddestroy(bool logEvent =true)<br>Marks the object for lazy destruction/deallocation and removal from any containers (like the node editor).
virtual voiddrawDiwne(DrawInfo & context, DrawMode drawMode =DrawMode_Interactive)<br>Internal draw method.
DrawInfodrawDiwneEx(DrawInfo & context, DrawMode drawMode =DrawMode_Interactive)
virtual voidfinalize(DrawInfo & context)<br>The final method to be called, gets called every frame and doesn't do any drawing.
ImRectgetDisplayRect() const<br>Object's bounds aligned to current viewport pixel boundaries.
IDgetId() const
DiwneObject *getParentObject() const
ImVec2getPosition() const<br>Returns the top left corner of the object's rect.
virtual ImRectgetRect() const<br>Rectangle bounds of the object in DIWNE coordinates (editor canvas coordinates).
boolgetSelectable()
virtual boolgetSelected() const<br>Whether the object is selected or not.
virtual voidinitialize(DrawInfo & context)<br>First method to be called every frame.
boolisAnyParentSelected()
boolisChildObject() const
boolisChildOfObject(DiwneObject * parent)
boolisDestroyed() const
boolisDragging(DrawInfo & context)<br>Is this object the source of an active dragging operation?
boolisFixed() const<br>Fixed objects are ones rendered at a position determined by some other object.
boolisRendered() const
boolisToBeBroughtToFront()
virtual voidonHover(DrawInfo & context)<br>This method gets called when the object is hovered.
virtual voidonPopup()
virtual voidonPressed(bool justPressed, DrawInfo & context)<br>Called when the object is pressed, meaning a key is pressed over it.
virtual voidonSelection(bool selected)
voidopenPopup()<br>Request to open the object's popup if possible.
booloperator!=(const DiwneObject & rhs) const
booloperator==(const DiwneObject & rhs) const
virtual voidpopupContent(DrawInfo & context)<br>Content of popup menu raised on this objec.
voidsetBringToFront(bool val)<br>Marks the object to be brought to front (be drawn first).
voidsetFixed(bool val)
voidsetForceDraw(bool val)<br>When true, makes the object automatically add the ForceDraw DrawMode flag.
voidsetParentObject(DiwneObject * parent)
voidsetPopupEnabled(bool val)
voidsetPosition(const ImVec2 & position)<br>Move the object's rect and any other associated positional data to the specified position.
voidsetRendered(bool val)
voidsetSelectable(bool selectable)<br>Whether the object can be selected.
virtual boolsetSelected(bool selected)<br>Set the selection state of the object.
voidsetTooltip(const std::string & text)
voidsetTooltipEnabled(bool val)
template <typename T =DiwneObject&gt; <br>std::shared_ptr< T >sharedPtr()<br>Returns a shared pointer to this object.
voidshowTooltip(const std::string & label, const ImColor && color, DrawInfo & context)<br>Immediately show a tooltip next to the mouse cursor with the specified text.
voidshowTooltip(const std::string & label, const std::string & desc, const ImColor && color, DrawInfo & context, float wrapWidth =35.f)<br>Immediately show a tooltip next to the mouse cursor with the specified text.
voidstopDrag(DrawInfo & context)<br>End an active drag operation this object is a source of.
virtual voidtooltipContent(DrawInfo & context)<br>Content of the object's tooltip.
virtual voidtranslate(const ImVec2 & vec)<br>Move the object's rect and any other associated positional data.

Protected Functions inherited from DIWNE::DiwneObject

Name
virtual voidafterDrawDiwne(DrawInfo & context)<br>Updates layout, processes interactions and then calls the user afterDraw() method.
virtual voidbeginDiwne(DrawInfo & context)
virtual voidendDiwne(DrawInfo & context)
virtual voidfinalizeDiwne(DrawInfo & context)
virtual boolisHoveredDiwne()<br>Is the object being hovered? The default implementation mostly gets this information from ImGui::IsItemHovered() but the behavior can be changed or restricted.
virtual boolpopupShouldBeOpenedDiwne() const<br>Determine whether a popup should be opened, that is, by default, that right mouse button was pressed and isn't dragging.
virtual voidprocessDragDiwne(DrawInfo & context)
virtual voidprocessHoverDiwne(DrawInfo & context)<br>Processes whether the object is currently hovered.
virtual voidprocessInteractionsDiwne(DrawInfo & context)
virtual voidprocessPopupAndTooltipDiwne(DrawInfo & context)<br>Processes whether a popup should be opened over this object.
virtual voidprocessPressAndReleaseDiwne(DrawInfo & context)<br>Processes whether the object is currently pressed (held) and further if it was just pressed or released.
virtual boolprocessSelectDiwne(DrawInfo & context)<br>Processes any interactions related to whether the object should be selected.
virtual voidsetInitialPositionDiwne()<br>Internal helper for setting the object's initial position.
voidsetSize(const ImVec2 & size)
voidupdateRectFromImGuiItem()

Public Attributes inherited from DIWNE::DiwneObject

Name
NodeEditor &diwne <br>Reference to the NodeEditor instance (also named 'editor' in some classes)
boolm_deletable <br>Whether the object can be destroyed by the user.
boolm_destroy <br>Indicates the object is to be deleted (and deallocated)
ImRectm_displayRect <br>Rectangle bounds aligned with the last viewport.
boolm_draggable <br>Whether dragging of the object is allowed by default.
DrawModem_drawMode <br>Read-only flag thats updated on each drawDiwne().
boolm_drawnThisFrame <br>Read only flag indicating whether the object has been drawn this frame.
boolm_fixed <br>Whether the object can be moved by user operations.
boolm_forceHoverDiwne <br>Special flag that can be used to enforce hover state, used by pin drag assist.
boolm_hoverable <br>Whether hovering is enabled by default.
boolm_hovered <br>Is the object hovered (usually by the mouse or whatever isHoveredDiwne() tracks)
boolm_hoverRoot <br>Whether hovering this object should prevent other objects from hovering.
IDm_idDiwne <br>Unique numeric identifier of the object.
boolm_isDragged <br>Is the object dragged? Returns false immediately on drag end (unlike isDragging()).
boolm_isPressed <br>Is the object pressed down (held)? Requirement for dragging.
boolm_justHidden <br>Read only flag indicating that this object was drawn last frame, but not this one.
boolm_justPressed <br>Read only flag indicating the object was pressed this frame (eg.
boolm_justReleased <br>Read only flag indicating the object was released this frame (eg.
std::stringm_labelDiwne <br>Unique string identifier, consists of <some string>:<m_idDiwne>.
ImRectm_rect <br>Rectangle bounds of the object in diwne coordinates.
StyleOverride *m_styleOverride <br>Style override to allow uniquely styled object types.

Protected Attributes inherited from DIWNE::DiwneObject

Name
unsigned long longg_diwneIDCounter <br>Static unique ID generator, unique only for current application run.
boolm_bringToFront <br>Request the object's rendering order to be moved to the front above other objects.
boolm_forceDraw <br>Request the next draw of the object to have the ForceDraw DrawMode flag.
boolm_internalHover <br>Temporary storage for an internal ImGui::IsItemHovered() check Can be set in the end() method to determine if object is hovered if applicable.
boolm_openPopup <br>Request to open popup.
boolm_openTooltip <br>Request to open tooltip.
DiwneObject *m_parentObject <br>Sets the parent object of object, relevant in node container and hover hierarchy.
boolm_popupEnabled <br>Whether this object has popup enabled.
std::stringm_popupLabelDiwne <br>ImGui popup identifier.
boolm_rendered <br>Whether the object should be drawn, this is a general flag that overrides behavior of the allowDrawing() method.
boolm_selectable <br>Should not be accessed directly.
boolm_selected <br>Should not be accessed directly.
boolm_tooltipEnabled <br>Whether this object has tooltip enabled.
std::stringm_tooltipText

Public Functions inherited from DIWNE::NodeContainer

Name
NodeContainer(DiwneObject * owner)<br>Constructs the node container for a specific DiwneObject that it represents.
virtual voidaddNodeAt(const std::shared_ptr< Node > & node, int index)<br>Adds a node at a specified index.
voidpurgeNodes()<br>Erases objects marked for deletion or removal from the container.
boolremoveNode(const std::shared_ptr< Node > & node)<br>Removes a node from the container.
virtual voidremoveNodeAt(int index)<br>Removes a node at a specified index from the container.
boolreplaceNode(const std::shared_ptr< Node > & oldNode, const std::shared_ptr< Node > & newNode)<br>Replaces an existing node with a new one.
virtual voidreplaceNodeAt(const std::shared_ptr< Node > & node, int index)<br>Replaces node at a specified index with a different one.

Protected Functions inherited from DIWNE::NodeContainer

Name
virtual voidonNodeAdd(Node * node, int index)<br>Called after a node is inserted into the container.
virtual voidonNodeRemove(std::shared_ptr< Node > node, int index)<br>Called after a node is removed from the container.

Protected Attributes inherited from DIWNE::NodeContainer

Name
NodeListm_nodes
DiwneObject *m_owner <br>Diwne object associated with this node container.

Public Functions inherited from DIWNE::INodeContainer

Name
virtual~INodeContainer() =default

Detailed Description

cpp
class DIWNE::NodeEditor;
class DIWNE::NodeEditor;

The DIWNE node editor object.

Every DiwneObject has a reference to this object.

Public Functions Documentation

function NodeEditor

cpp
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

cpp
~NodeEditor() override
~NodeEditor() override
cpp
void addLink(
    std::shared_ptr< Link > link
)
void addLink(
    std::shared_ptr< Link > link
)

function addNode

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

function addNode

cpp
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

cpp
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

cpp
virtual bool allowZoom()
virtual bool allowZoom()

function begin

cpp
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

cpp
void bringLastActiveNodeToFront()
void bringLastActiveNodeToFront()

function bringMarkedNodesToFront

cpp
void bringMarkedNodesToFront()
void bringMarkedNodesToFront()

function canvas

cpp
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

cpp
virtual void clear()
virtual void clear()

Clear all nodes from the node editor.

function content

cpp
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.

cpp
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

cpp
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:

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

cpp
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

cpp
void deleteSelectedNodes()
void deleteSelectedNodes()

function deselectAllNodes

cpp
virtual void deselectAllNodes()
virtual void deselectAllNodes()

function draw

cpp
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

cpp
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

cpp
virtual RecursiveNodeRange getAllNodesInnerIncluded() const
virtual RecursiveNodeRange getAllNodesInnerIncluded() const

function getDpiScale

cpp
inline float getDpiScale() const
inline float getDpiScale() const

function getLastActiveNode

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

function getNodeList

cpp
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

cpp
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

cpp
bool getNodesSelectionChanged() const
bool getNodesSelectionChanged() const

function getPopupPosition

cpp
const ImVec2 & getPopupPosition() const
const ImVec2 & getPopupPosition() const

Get position of the last popup in screen coordinates.

function getSelectedNodes

cpp
virtual FilteredNodeRange getSelectedNodes() const
virtual FilteredNodeRange getSelectedNodes() const

function getSelectedNodesInnerIncluded

cpp
virtual FilteredRecursiveNodeRange getSelectedNodesInnerIncluded() const
virtual FilteredRecursiveNodeRange getSelectedNodesInnerIncluded() const

function getStyleOverride

cpp
StyleOverride * getStyleOverride() const =delete
StyleOverride * getStyleOverride() const =delete

function getZoom

cpp
inline float getZoom() const
inline float getZoom() const

function initializeDiwne

cpp
virtual void initializeDiwne(
    DrawInfo & context
) override
virtual void initializeDiwne(
    DrawInfo & context
) override

Reimplements: DIWNE::DiwneObject::initializeDiwne

function input

cpp
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

cpp
void invertSelection()
void invertSelection()

function isJustPressedDiwne

cpp
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

cpp
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

cpp
virtual bool isZoomingDiwne()
virtual bool isZoomingDiwne()

function onDestroy

cpp
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

cpp
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

cpp
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

cpp
inline virtual void onZoom()
inline virtual void onZoom()

Reimplemented by: Workspace::WorkspaceDiwne::onZoom

function processInteractions

cpp
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

cpp
virtual bool processPan()
virtual bool processPan()

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

function processZoom

cpp
virtual bool processZoom()
virtual bool processZoom()

function purgeAllNodes

cpp
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

cpp
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

cpp
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

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

function setLastActiveNode

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

function setNodesSelectionChanged

cpp
void setNodesSelectionChanged(
    bool value
)
void setNodesSelectionChanged(
    bool value
)

function setPopupPosition

cpp
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

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

function setStyleOverride

cpp
void setStyleOverride(
    StyleOverride * styleOverride
) =delete
void setStyleOverride(
    StyleOverride * styleOverride
) =delete

function setZoom

cpp
inline void setZoom(
    float val
)
inline void setZoom(
    float val
)

function shiftNodesToBegin

cpp
void shiftNodesToBegin(
    const NodeList & nodesToShift
)
void shiftNodesToBegin(
    const NodeList & nodesToShift
)

function shiftNodesToEnd

cpp
void shiftNodesToEnd(
    const NodeList & nodesToShift
)
void shiftNodesToEnd(
    const NodeList & nodesToShift
)

function style

cpp
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

cpp
inline StyleBase & styleBase() const
inline StyleBase & styleBase() const

function updateLayout

cpp
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

cpp
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

cpp
void purgeObjects()
void purgeObjects()

Erases objects marked for deletion or removal from the editor.

Public Attributes Documentation

variable interactionState

cpp
InteractionState interactionState;
InteractionState interactionState;

State of multi-frame user operations.

cpp
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

cpp
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

cpp
SettingsDiwne * mp_settingsDiwne;
SettingsDiwne * mp_settingsDiwne;

Protected Attributes Documentation

variable m_canvas

cpp
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

cpp
ImDrawListSplitter m_channelSplitter;
ImDrawListSplitter m_channelSplitter;

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

variable m_input

cpp
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

cpp
bool m_lastActiveNodeChanged {false};
bool m_lastActiveNodeChanged {false};

variable m_nodesSelectionChanged

cpp
bool m_nodesSelectionChanged {false};
bool m_nodesSelectionChanged {false};

variable m_popupPosition

cpp
ImVec2 m_popupPosition;
ImVec2 m_popupPosition;

Position of the last popup in screen coordinates.

variable m_style

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

variable mp_lastActiveNode

cpp
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