DIWNE::Node ​

More...

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

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

Inherited by DIWNE::BasicNode

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

Detailed Description ​

class DIWNE::Node;

class DIWNE::Node;

Todo: Docs

Public Functions Documentation ​

function Node ​

Node(
    const Node & other
) =delete

Node(
    const Node & other
) =delete

function Node ​

Node(
    NodeEditor & diwne,
    std::string labelDiwne ="DiwneNode"
)

Node(
    NodeEditor & diwne,
    std::string labelDiwne ="DiwneNode"
)

function afterDraw ​

virtual void afterDraw(
    DrawInfo & context
) override

virtual void afterDraw(
    DrawInfo & context
) override

Called last during drawing.

Reimplements: DIWNE::DiwneObject::afterDraw

Reimplemented by: Workspace::Sequence::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 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

Reimplemented by: Workspace::Sequence::allowDrawing, Workspace::TransformationBase::allowDrawing

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::Sequence::begin

Can be used to initialize drawing code.

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

virtual void drawSelectionIndicator(
    DrawInfo & context
)

virtual void drawSelectionIndicator(
    DrawInfo & context
)

function end ​

virtual void end(
    DrawInfo & context
) override

virtual void end(
    DrawInfo & context
) override

Called after content().

Reimplements: DIWNE::DiwneObject::end

Reimplemented by: Workspace::TransformationBase::end

Used to end content drawing.

function getFlag ​

bool getFlag(
    char index
) const

bool getFlag(
    char index
) const

Get the node bit flag value at index.

See: setFlag()

The node flag is a simple 64 bit integer used as a bit field to hold 64 user defined boolean flags. As of right now DIWNE does not use any of the flags by itself, so their meaning and usage is entirely arbitrary. The intended purpose is to use flags to identify particular node subclasses and avoid any dynamic_casts when casting to a derived type for specific functionality.

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

Reimplemented by: Workspace::Node::onDestroy, DIWNE::SequenceNodeContainer::onDestroy, Workspace::Sequence::onDestroy, Workspace::TransformationBase::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

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

virtual void onSelection(
    bool selected
) override

virtual void onSelection(
    bool selected
) override

Reimplements: DIWNE::DiwneObject::onSelection

Reimplemented by: Workspace::Screen::onSelection

function operator= ​

Node & operator=(
    const Node & other
) =delete

Node & operator=(
    const Node & other
) =delete

function setFlag ​

void setFlag(
    char index,
    bool value
)

void setFlag(
    char index,
    bool value
)

Set the node bit flag value at index.

See: getFlag()

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.

function willBeRemovedFromContainer ​

bool willBeRemovedFromContainer(
    const DiwneObject * container
)

bool willBeRemovedFromContainer(
    const DiwneObject * container
)

Protected Functions Documentation ​

function afterDrawDiwne ​

virtual void afterDrawDiwne(
    DrawInfo & context
) override

virtual void afterDrawDiwne(
    DrawInfo & context
) override

Updates layout, processes interactions and then calls the user afterDraw() method.

Reimplements: DIWNE::DiwneObject::afterDrawDiwne

function processSelectDiwne ​

virtual bool processSelectDiwne(
    DrawInfo & context
) override

virtual bool processSelectDiwne(
    DrawInfo & context
) override

Processes any interactions related to whether the object should be selected.

Parameters:

• context

See: processPressAndReleaseDiwne()

Return: Whether selection processing should end. Can be used to exit early from derived methods.

Note: This is not the only method which can select the object.

Reimplements: DIWNE::DiwneObject::processSelectDiwne

The default behavior is selection when the object is pressed and then released (clicked).

function setInitialPositionDiwne ​

virtual void setInitialPositionDiwne() override

virtual void setInitialPositionDiwne() override

Internal helper for setting the object's initial position.

Reimplements: DIWNE::DiwneObject::setInitialPositionDiwne

Public Attributes Documentation ​

variable m_forceDraw ​

bool m_forceDraw {false};

bool m_forceDraw {false};

Internal flag to force drawing of the node, used by pins (TODO: move to DiwneObject?)

Protected Attributes Documentation ​

variable m_flag ​

NodeFlag m_flag {0};

NodeFlag m_flag {0};

The node flag bit field.

See: Node::getFlag()

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