Workspace::CoreNode ​

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

Inherits from Workspace::Node, IVisitable, DIWNE::BasicNode, DIWNE::Node, DIWNE::DiwneObject, std::enable_shared_from_this< DiwneObject >

Inherited by Workspace::CoreNodeWithPins, Workspace::TransformationBase

Public Functions ​

Protected Functions ​

Public Attributes ​

Protected Attributes ​

Additional inherited members ​

Public Functions inherited from Workspace::Node

Public Attributes inherited from Workspace::Node

Public Functions inherited from IVisitable

Public Functions inherited from DIWNE::BasicNode

Public Attributes inherited from DIWNE::BasicNode

Protected Attributes inherited from DIWNE::BasicNode

Public Functions inherited from DIWNE::Node

Protected Functions inherited from DIWNE::Node

Public Attributes inherited from DIWNE::Node

Protected Attributes inherited from DIWNE::Node

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

CoreNode(
    DIWNE::NodeEditor & diwne,
    Ptr< Core::Node > nodebase
)

CoreNode(
    DIWNE::NodeEditor & diwne,
    Ptr< Core::Node > nodebase
)

function ~CoreNode ​

~CoreNode() override

~CoreNode() override

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(
    DIWNE::DrawInfo & context
) override

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

First method to be called during object drawing.

Reimplements: DIWNE::BasicNode::begin

Reimplemented by: Workspace::CoreNodeWithPins::begin, Workspace::Cycle::begin, Workspace::Sequence::begin

Can be used to initialize drawing code.

function drawMenuDuplicate ​

void drawMenuDuplicate(
    DIWNE::DrawInfo & context
)

void drawMenuDuplicate(
    DIWNE::DrawInfo & context
)

function drawMenuLevelOfDetail ​

virtual void drawMenuLevelOfDetail() =0

virtual void drawMenuLevelOfDetail() =0

Reimplemented by: Workspace::Camera::drawMenuLevelOfDetail, Workspace::Cycle::drawMenuLevelOfDetail, Workspace::Model::drawMenuLevelOfDetail, Workspace::Operator::drawMenuLevelOfDetail, Workspace::Operator::drawMenuLevelOfDetail, Workspace::Screen::drawMenuLevelOfDetail, Workspace::ScriptingNode::drawMenuLevelOfDetail, Workspace::Sequence::drawMenuLevelOfDetail, Workspace::Transformation::drawMenuLevelOfDetail, Workspace::TransformationBase::drawMenuLevelOfDetail

function drawMenuSetEditable ​

void drawMenuSetEditable()

void drawMenuSetEditable()

function drawMenuSetPrecision ​

void drawMenuSetPrecision()

void drawMenuSetPrecision()

function drawTrackingBorder ​

void drawTrackingBorder(
    bool active,
    bool interpolating,
    float progress
) const

void drawTrackingBorder(
    bool active,
    bool interpolating,
    float progress
) const

function drawTrackingCursor ​

void drawTrackingCursor(
    ImRect rect,
    const Core::TrackedNodeData * t,
    bool inactiveOverlay,
    bool round
) const

void drawTrackingCursor(
    ImRect rect,
    const Core::TrackedNodeData * t,
    bool inactiveOverlay,
    bool round
) const

function duplicate ​

void duplicate(
    DIWNE::DrawInfo & context,
    bool multiDuplication
)

void duplicate(
    DIWNE::DrawInfo & context,
    bool multiDuplication
)

function endDiwne ​

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

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

Reimplements: DIWNE::DiwneObject::endDiwne

function getDataItemsWidth ​

float getDataItemsWidth()

float getDataItemsWidth()

Returns the desired width of data items (ImGui number fields)

function getFloatPopupMode ​

FloatPopupMode & getFloatPopupMode()

FloatPopupMode & getFloatPopupMode()

function getKeyword ​

const std::string & getKeyword() const

const std::string & getKeyword() const

Returns the string identifier of the core node type.

function getLevelOfDetail ​

LevelOfDetail getLevelOfDetail()

LevelOfDetail getLevelOfDetail()

function getLODCount ​

virtual int getLODCount()

virtual int getLODCount()

Number of levels this node cycles through.

Reimplemented by: Workspace::Transformation::getLODCount, Workspace::Camera::getLODCount, Workspace::Cycle::getLODCount, Workspace::Transformation::getLODCount, Workspace::TransformationBase::getLODCount

function getNodebase ​

Ptr< Core::Node > getNodebase() const

Ptr< Core::Node > getNodebase() const

Returns the managed I3TCore node.

function getNumberOfVisibleDecimal ​

int getNumberOfVisibleDecimal()

int getNumberOfVisibleDecimal()

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::CoreNodeWithPins::onDestroy, Workspace::Sequence::onDestroy, Workspace::TransformationBase::onDestroy

It is called only once per object.

function onPopup ​

virtual void onPopup() override

virtual void onPopup() override

Reimplements: DIWNE::DiwneObject::onPopup

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

virtual void onSelection(
    bool selected
) override

virtual void onSelection(
    bool selected
) override

Reimplements: DIWNE::DiwneObject::onSelection

Reimplemented by: Workspace::Model::onSelection, Workspace::Screen::onSelection

function popupContent ​

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

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

Content of popup menu raised on this objec.

Reimplements: DIWNE::DiwneObject::popupContent

Reimplemented by: Workspace::Model::popupContent, Workspace::Screen::popupContent, Workspace::ScriptingNode::popupContent, Workspace::Sequence::popupContent, Workspace::TransformationBase::popupContent

function queueUpdateDataItemsWidth ​

void queueUpdateDataItemsWidth()

void queueUpdateDataItemsWidth()

This call requests the data items width to be recalculated on the next draw of ths node.

function setFloatPopupMode ​

void setFloatPopupMode(
    FloatPopupMode mode
)

void setFloatPopupMode(
    FloatPopupMode mode
)

function setLevelOfDetail ​

LevelOfDetail setLevelOfDetail(
    LevelOfDetail levelOfDetail
)

LevelOfDetail setLevelOfDetail(
    LevelOfDetail levelOfDetail
)

function setNumberOfVisibleDecimal ​

virtual void setNumberOfVisibleDecimal(
    int value
)

virtual void setNumberOfVisibleDecimal(
    int value
)

Reimplemented by: Workspace::Sequence::setNumberOfVisibleDecimal

function switchLevelOfDetail ​

virtual LevelOfDetail switchLevelOfDetail(
    LevelOfDetail oldLevel
)

virtual LevelOfDetail switchLevelOfDetail(
    LevelOfDetail oldLevel
)

Switches to the next LOD level.

Return: Thew new LOD level

Reimplemented by: Workspace::Camera::switchLevelOfDetail, Workspace::Cycle::switchLevelOfDetail, Workspace::TransformationBase::switchLevelOfDetail

function topContent ​

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

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

Reimplements: DIWNE::BasicNode::topContent

function topRightHeaderContent ​

virtual void topRightHeaderContent(
    DIWNE::DrawInfo & context
)

virtual void topRightHeaderContent(
    DIWNE::DrawInfo & context
)

Special method to fill contents between the node label and the top right menu button (if present) The method call must include a m_top.spring(1.0f); call somewhere in it.

Reimplemented by: Workspace::Transformation::topRightHeaderContent, Workspace::Transformation::topRightHeaderContent, Workspace::Transformation::topRightHeaderContent, Workspace::Transformation::topRightHeaderContent, Workspace::Camera::topRightHeaderContent, Workspace::Transformation::topRightHeaderContent, Workspace::TransformationBase::topRightHeaderContent

function drawMenuLevelOfDetail_builder ​

static void drawMenuLevelOfDetail_builder(
    Ptr< CoreNode > node,
    std::vector< LevelOfDetail > const & levels_of_detail
)

static void drawMenuLevelOfDetail_builder(
    Ptr< CoreNode > node,
    std::vector< LevelOfDetail > const & levels_of_detail
)

Protected Functions Documentation ​

function maxLengthOfData ​

virtual int maxLengthOfData() =0

virtual int maxLengthOfData() =0

Calculates the largest number of characters/decimal places a data item has in this node.

Reimplemented by: Workspace::Camera::maxLengthOfData, Workspace::Cycle::maxLengthOfData, Workspace::Model::maxLengthOfData, Workspace::Operator::maxLengthOfData, Workspace::Operator::maxLengthOfData, Workspace::Screen::maxLengthOfData, Workspace::ScriptingNode::maxLengthOfData, Workspace::Sequence::maxLengthOfData, Workspace::Transformation::maxLengthOfData, Workspace::TransformationBase::maxLengthOfData

This call will often be delegated to the pins of the node.

function updateDataItemsWidth ​

virtual float updateDataItemsWidth()

virtual float updateDataItemsWidth()

Calculates the final desired pixel width of data items (floats inside vectors, matrices etc.).

See: maxLengthOfData(), queueUpdateDataItemsWidth()

Note: Could it be called every frame? I don't know, someone profile it please -><-.

Calls maxLengthOfData() internally. Despite this method not being particularly time intensive it is NOT called every frame. A call to this method can be queued for the next frame via queueUpdateDataItemsWidth()

Public Attributes Documentation ​

variable CORE_NODE_FLAG ​

static constexpr char CORE_NODE_FLAG = 16;

static constexpr char CORE_NODE_FLAG = 16;

variable m_referenceSpaceSource ​

bool m_referenceSpaceSource {false};

bool m_referenceSpaceSource {false};

Indicates that this node is the source of a custom scene view reference space TODO: What if it's a source for multiple windows? Would be nice to keep track of that.

Protected Attributes Documentation ​

variable m_dataItemsWidth ​

float m_dataItemsWidth {32.f};

float m_dataItemsWidth {32.f};

variable m_drawContextMenuButton ​

bool m_drawContextMenuButton = false;

bool m_drawContextMenuButton = false;

variable m_floatPopupMode ​

FloatPopupMode m_floatPopupMode {FloatPopupMode::Value};

FloatPopupMode m_floatPopupMode {FloatPopupMode::Value};

variable m_isFirstDraw ​

bool m_isFirstDraw = true;

bool m_isFirstDraw = true;

variable m_isLabelBeingEdited ​

bool m_isLabelBeingEdited = false;

bool m_isLabelBeingEdited = false;

variable m_levelOfDetail ​

LevelOfDetail m_levelOfDetail {LevelOfDetail::Full};

LevelOfDetail m_levelOfDetail {LevelOfDetail::Full};

variable m_nodebase ​

const Ptr< Core::Node > m_nodebase;

const Ptr< Core::Node > m_nodebase;

Reference to the I3TCore node @description Each WorkspaceGUI node represents a single I3TCore node.

It also manages its lifetime and destruction. The UI and Core representations are not implicitly synced. Right now the idea is that any changes to the Core nodes is made through Workspace nodes, which sync the UI and Core state explicitly in the moments of immediate change + some continual asserts. Workspace is however not ready to react to external changes to the Core node graph and would result in sync fail.

variable m_numberOfVisibleDecimal ​

int m_numberOfVisibleDecimal;

int m_numberOfVisibleDecimal;

number of decimal places used while display floats in the workspace

variable m_topBottomSpacingDefault ​

bool m_topBottomSpacingDefault = true;

bool m_topBottomSpacingDefault = true;

Whether this node has spacing between content and header / end.

variable m_updateDataItemsWidth ​

bool m_updateDataItemsWidth {true};

bool m_updateDataItemsWidth {true};

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