Workspace::CoreLink

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

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

Public Functions

	Name
	CoreLink(DIWNE::NodeEditor & diwne)
virtual bool	allowSelectOnClick(const DIWNE::DrawInfo & context) const override<br>Determines whether the object can be selected by clicking it (eg.
virtual void	content(DIWNE::DrawInfo & context) override<br>Called after begin() during drawing.
virtual void	initialize(DIWNE::DrawInfo & context) override<br>First method to be called every frame.
virtual void	popupContent(DIWNE::DrawInfo & context) override<br>Content of popup menu raised on this objec.
virtual void	updateControlPoints() override

Protected Attributes

	Name
Core::EValueType	m_coreType

Additional inherited members

Public Functions inherited from DIWNE::Link

	Name
	Link(NodeEditor & diwne, std::string labelDiwne ="DiwneLink")
virtual bool	allowDrawing() override<br>Decide whether the object should be drawn (when outside the window for example)
virtual void	begin(DrawInfo & context) override<br>Link isn't an ImGui item, nothing to begin.
virtual bool	connect(Pin * startPin, Pin * endPin, bool logEvent =true)<br>Connect the two pins using this link.
virtual bool	disconnect(bool logEvent =true)<br>Disconnect all pins.
virtual bool	disconnectPin(bool startOrEndPin, bool logEvent =true)<br>Disconnect one of the pins.
virtual bool	disconnectPin(Pin * pin, bool logEvent =true)
virtual void	end(DrawInfo & context) override<br>No need to set m_internalHover as we handle hovering ourself.
Pin *	getAnyPin() const<br>Get any of the two pins or nullptr if neither are connected.
ImVec2	getEndControlPoint() const
Pin *	getEndPin() const
ImVec2	getEndPoint() const
Pin *	getOtherPin(Pin * pin) const<br>Get the other pin that this link connects with the specified pin.
Pin *	getSinglePin() const<br>Get the pin on either end in cases when only one pin is plugged in.
ImVec2	getStartControlPoint() const
Pin *	getStartPin() const
ImVec2	getStartPoint() const
bool	isLinkOnWorkArea() const
bool	isOnePinPlugged() const<br>Whether the link has exactly one pin plugged in at either end.
bool	isPlugged() const<br>Whether the link is connected on both ends.
virtual void	onDestroy(bool logEvent) override<br>Gets called the moment the object is marked for deletion by destroy().
virtual void	onHover(DrawInfo & context) override<br>This method gets called when the object is hovered.
void	setEndPin(Pin * pin)
void	setEndPoint(const ImVec2 & mEndDiwne)
void	setStartPin(Pin * pin)
void	setStartPoint(const ImVec2 & mStartDiwne)
virtual void	updateLayout(DrawInfo & context) override<br>Updates object's m_rect, m_displayRect and any other object size variables.

Protected Functions inherited from DIWNE::Link

	Name
virtual ImRect	getBounds()<br>Get the rect formed by the starting and ending point, as well as any curve control points.
virtual void	initializeDiwne(DrawInfo & context) override
virtual bool	isHoveredDiwne() override<br>Link isn't represented by an ImGui item so we need to detect hovering manually.
virtual void	setInitialPositionDiwne() override<br>Internal helper for setting the object's initial position.
virtual void	updateEndpoints()
void	updateSquareDistanceMouseFromLink()

Public Attributes inherited from DIWNE::Link

	Name
bool	m_previewPlugged <br>Style the link as if it was plugged in.

Protected Attributes inherited from DIWNE::Link

	Name
ImVec4	m_color
ImVec2	m_controlPointEndDiwne
ImVec2	m_controlPointStartDiwne
ImVec2	m_endDiwne
Pin *	m_endPin
float	m_squaredDistanceMouseFromLink
ImVec2	m_startDiwne
Pin *	m_startPin
float	m_widthOffset

Public Functions inherited from DIWNE::DiwneObject

	Name
	DiwneObject(DIWNE::NodeEditor & diwne, std::string labelDiwne)
virtual	~DiwneObject()
virtual void	afterDraw(DrawInfo & context)<br>Called last during drawing.
virtual bool	allowDragStart() const<br>Determines whether a drag operation can start from this object.
virtual bool	allowDrawing()<br>Decide whether the object should be drawn (when outside the window for example)
virtual bool	allowHover() const<br>Determines whether the object can be hovered.
virtual bool	allowInteraction() const<br>Decide whether the object should react to user input in general.
virtual bool	allowPopup() const<br>Determines whether a popup can be raised over the object.
virtual bool	allowPress(const DrawInfo & context) const<br>Determines whether the object can be pressed.
template <typename T =DiwneObject> <br>T *	as()<br>Returns a raw pointer to itself casted to a type.
virtual void	begin(DrawInfo & context) =0<br>First method to be called during object drawing.
virtual void	destroy(bool logEvent =true)<br>Marks the object for lazy destruction/deallocation and removal from any containers (like the node editor).
virtual void	draw(DrawMode drawMode =DrawMode_Interactive)<br>Generic draw method meant to be used by external code.
virtual void	drawDiwne(DrawInfo & context, DrawMode drawMode =DrawMode_Interactive)<br>Internal draw method.
DrawInfo	drawDiwneEx(DrawInfo & context, DrawMode drawMode =DrawMode_Interactive)
virtual void	end(DrawInfo & context) =0<br>Called after content().
virtual void	finalize(DrawInfo & context)<br>The final method to be called, gets called every frame and doesn't do any drawing.
ImRect	getDisplayRect() const<br>Object's bounds aligned to current viewport pixel boundaries.
ID	getId() const
DiwneObject *	getParentObject() const
ImVec2	getPosition() const<br>Returns the top left corner of the object's rect.
virtual ImRect	getRect() const<br>Rectangle bounds of the object in DIWNE coordinates (editor canvas coordinates).
bool	getSelectable()
virtual bool	getSelected() const<br>Whether the object is selected or not.
StyleOverride *	getStyleOverride() const
bool	isAnyParentSelected()
bool	isChildObject() const
bool	isChildOfObject(DiwneObject * parent)
bool	isDestroyed() const
bool	isDragging(DrawInfo & context)<br>Is this object the source of an active dragging operation?
bool	isFixed() const<br>Fixed objects are ones rendered at a position determined by some other object.
bool	isRendered() const
bool	isToBeBroughtToFront()
virtual void	onDestroy(bool logEvent)<br>Gets called the moment the object is marked for deletion by destroy().
virtual void	onDrag(DrawInfo & context, bool dragStart, bool dragEnd)<br>This method gets called when the object is being dragged.
virtual void	onHover(DrawInfo & context)<br>This method gets called when the object is hovered.
virtual void	onPopup()
virtual void	onPressed(bool justPressed, DrawInfo & context)<br>Called when the object is pressed, meaning a key is pressed over it.
virtual void	onReleased(bool justReleased, DrawInfo & context)<br>Called when the object is not pressed.
virtual void	onSelection(bool selected)
void	openPopup()<br>Request to open the object's popup if possible.
bool	operator!=(const DiwneObject & rhs) const
bool	operator==(const DiwneObject & rhs) const
virtual void	processInteractions(DrawInfo & context)<br>Method for reacting to user input after the object is fully drawn and its dimensions are known.
void	setBringToFront(bool val)<br>Marks the object to be brought to front (be drawn first).
void	setFixed(bool val)
void	setForceDraw(bool val)<br>When true, makes the object automatically add the ForceDraw DrawMode flag.
void	setParentObject(DiwneObject * parent)
void	setPopupEnabled(bool val)
void	setPosition(const ImVec2 & position)<br>Move the object's rect and any other associated positional data to the specified position.
void	setRendered(bool val)
void	setSelectable(bool selectable)<br>Whether the object can be selected.
virtual bool	setSelected(bool selected)<br>Set the selection state of the object.
void	setStyleOverride(StyleOverride * styleOverride)<br>Assign a StyleOverride object to this DiwneObject.
void	setTooltip(const std::string & text)
void	setTooltipEnabled(bool val)
template <typename T =DiwneObject> <br>std::shared_ptr< T >	sharedPtr()<br>Returns a shared pointer to this object.
void	showTooltip(const std::string & label, const ImColor && color, DrawInfo & context)<br>Immediately show a tooltip next to the mouse cursor with the specified text.
void	showTooltip(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.
void	stopDrag(DrawInfo & context)<br>End an active drag operation this object is a source of.
virtual Style &	style() const<br>Get the style for this object.
virtual void	tooltipContent(DrawInfo & context)<br>Content of the object's tooltip.
virtual void	translate(const ImVec2 & vec)<br>Move the object's rect and any other associated positional data.
virtual void	updateLayout(DrawInfo & context) =0<br>Updates object's m_rect, m_displayRect and any other object size variables.

Protected Functions inherited from DIWNE::DiwneObject

	Name
virtual void	afterDrawDiwne(DrawInfo & context)<br>Updates layout, processes interactions and then calls the user afterDraw() method.
virtual void	beginDiwne(DrawInfo & context)
virtual void	endDiwne(DrawInfo & context)
virtual void	finalizeDiwne(DrawInfo & context)
virtual void	initializeDiwne(DrawInfo & context)
virtual bool	isDraggedDiwne()<br>Is the object being dragged? (usually by mouse or some key combo)
virtual bool	isHoveredDiwne()<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 bool	isJustPressedDiwne()<br>Determine whether a key/s of interest was/were just pressed.
virtual bool	isPressedDiwne()<br>Determine whether a key/s of interest is/are pressed down over the object.
virtual bool	popupShouldBeOpenedDiwne() const<br>Determine whether a popup should be opened, that is, by default, that right mouse button was pressed and isn't dragging.
virtual void	processDragDiwne(DrawInfo & context)
virtual void	processHoverDiwne(DrawInfo & context)<br>Processes whether the object is currently hovered.
virtual void	processInteractionsDiwne(DrawInfo & context)
virtual void	processPopupAndTooltipDiwne(DrawInfo & context)<br>Processes whether a popup should be opened over this object.
virtual void	processPressAndReleaseDiwne(DrawInfo & context)<br>Processes whether the object is currently pressed (held) and further if it was just pressed or released.
virtual bool	processSelectDiwne(DrawInfo & context)<br>Processes any interactions related to whether the object should be selected.
virtual void	setInitialPositionDiwne()<br>Internal helper for setting the object's initial position.
void	setSize(const ImVec2 & size)
void	updateRectFromImGuiItem()

Public Attributes inherited from DIWNE::DiwneObject

	Name
NodeEditor &	diwne <br>Reference to the NodeEditor instance (also named 'editor' in some classes)
bool	m_deletable <br>Whether the object can be destroyed by the user.
bool	m_destroy <br>Indicates the object is to be deleted (and deallocated)
ImRect	m_displayRect <br>Rectangle bounds aligned with the last viewport.
bool	m_draggable <br>Whether dragging of the object is allowed by default.
DrawMode	m_drawMode <br>Read-only flag thats updated on each drawDiwne().
bool	m_drawnThisFrame <br>Read only flag indicating whether the object has been drawn this frame.
bool	m_fixed <br>Whether the object can be moved by user operations.
bool	m_forceHoverDiwne <br>Special flag that can be used to enforce hover state, used by pin drag assist.
bool	m_hoverable <br>Whether hovering is enabled by default.
bool	m_hovered <br>Is the object hovered (usually by the mouse or whatever isHoveredDiwne() tracks)
bool	m_hoverRoot <br>Whether hovering this object should prevent other objects from hovering.
ID	m_idDiwne <br>Unique numeric identifier of the object.
bool	m_isDragged <br>Is the object dragged? Returns false immediately on drag end (unlike isDragging()).
bool	m_isPressed <br>Is the object pressed down (held)? Requirement for dragging.
bool	m_justHidden <br>Read only flag indicating that this object was drawn last frame, but not this one.
bool	m_justPressed <br>Read only flag indicating the object was pressed this frame (eg.
bool	m_justReleased <br>Read only flag indicating the object was released this frame (eg.
std::string	m_labelDiwne <br>Unique string identifier, consists of <some string>:<m_idDiwne>.
ImRect	m_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 long	g_diwneIDCounter <br>Static unique ID generator, unique only for current application run.
bool	m_bringToFront <br>Request the object's rendering order to be moved to the front above other objects.
bool	m_forceDraw <br>Request the next draw of the object to have the ForceDraw DrawMode flag.
bool	m_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.
bool	m_openPopup <br>Request to open popup.
bool	m_openTooltip <br>Request to open tooltip.
DiwneObject *	m_parentObject <br>Sets the parent object of object, relevant in node container and hover hierarchy.
bool	m_popupEnabled <br>Whether this object has popup enabled.
std::string	m_popupLabelDiwne <br>ImGui popup identifier.
bool	m_rendered <br>Whether the object should be drawn, this is a general flag that overrides behavior of the allowDrawing() method.
bool	m_selectable <br>Should not be accessed directly.
bool	m_selected <br>Should not be accessed directly.
bool	m_tooltipEnabled <br>Whether this object has tooltip enabled.
std::string	m_tooltipText

Public Functions Documentation

function CoreLink

cpp

CoreLink(
    DIWNE::NodeEditor & diwne
)

CoreLink(
    DIWNE::NodeEditor & diwne
)

function allowSelectOnClick

cpp

virtual bool allowSelectOnClick(
    const DIWNE::DrawInfo & context
) const override

virtual bool allowSelectOnClick(
    const DIWNE::DrawInfo & context
) const override

Determines whether the object can be selected by clicking it (eg.

See: processSelectDiwne()

Reimplements: DIWNE::DiwneObject::allowSelectOnClick

pressing and then releasing it). This is a type of interaction and not related to whether the object is "selectable" or not. Programmatical selection using DiwneObject::setSelected() is not affected.

function content

cpp

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

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

Called after begin() during drawing.

Reimplements: DIWNE::DiwneObject::content

Draws object content.

function initialize

cpp

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

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

First method to be called every frame.

Reimplements: DIWNE::DiwneObject::initialize

Does not handle drawing.

function popupContent

cpp

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

function updateControlPoints

cpp

virtual void updateControlPoints() override

virtual void updateControlPoints() override

Reimplements: DIWNE::Link::updateControlPoints

Protected Attributes Documentation

variable m_coreType

cpp

Core::EValueType m_coreType;

Core::EValueType m_coreType;

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

Classes

Namespaces

Workspace::CoreLink

Public Functions

Protected Attributes

Additional inherited members

Public Functions Documentation

function CoreLink

function allowSelectOnClick

function content

function initialize

function popupContent

function updateControlPoints

Protected Attributes Documentation

variable m_coreType

Workspace::CoreLink ​

Public Functions ​

Protected Attributes ​

Additional inherited members ​

Public Functions Documentation ​

function CoreLink ​

function allowSelectOnClick ​

function content ​

function initialize ​

function popupContent ​

function updateControlPoints ​

Protected Attributes Documentation ​

variable m_coreType ​

Workspace::CoreLink

Public Functions

Protected Attributes

Additional inherited members

Public Functions Documentation

function CoreLink

function allowSelectOnClick

function content

function initialize

function popupContent

function updateControlPoints

Protected Attributes Documentation

variable m_coreType