Workspace::Screen

#include "GUI/Workspace/Nodes/Screen.h"

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

Public Functions

	Name
	Screen(DIWNE::NodeEditor & diwne)
	~Screen() override
virtual void	accept(NodeVisitor & visitor) override
virtual void	centerContent(DIWNE::DrawInfo & context) override
virtual void	drawMenuLevelOfDetail() override
virtual void	finalize(DIWNE::DrawInfo & context) override<br>The final method to be called, gets called every frame and doesn't do any drawing.
ImVec2	getScreenSize() const
virtual int	maxLengthOfData() override<br>Calculates the largest number of characters/decimal places a data item has in this node.
virtual void	onSelection(bool selected) override
virtual void	popupContent(DIWNE::DrawInfo & context) override<br>Content of popup menu raised on this objec.
void	setScreenSize(ImVec2 aspect)

Additional inherited members

Public Functions inherited from Workspace::CoreNodeWithPins

	Name
	CoreNodeWithPins(DIWNE::NodeEditor & diwne, Ptr< Core::Node > nodebase, bool showDataOnPins =true)
virtual void	afterDraw(DIWNE::DrawInfo & context) override<br>Called last during drawing.
virtual bool	allowPress(const DIWNE::DrawInfo & context) const override<br>Determines whether the object can be pressed.
virtual void	begin(DIWNE::DrawInfo & context) override<br>First method to be called during object drawing.
virtual void	drawInputPins(DIWNE::DrawInfo & context)
virtual void	drawOutputPins(DIWNE::DrawInfo & context)
const std::vector< Ptr< CorePin > > &	getInputs() const<br>get vector of input pins
const std::vector< Ptr< CorePin > > &	getOutputs() const<br>get vector of output pins
virtual void	leftContent(DIWNE::DrawInfo & context) override
virtual void	onDestroy(bool logEvent) override<br>Gets called the moment the object is marked for deletion by destroy().
virtual void	rightContent(DIWNE::DrawInfo & context) override
virtual void	translate(const ImVec2 & vec) override<br>Move the object's rect and any other associated positional data.
void	unplugAll()
void	updatePinStyle(CorePin & pin)

Protected Functions inherited from Workspace::CoreNodeWithPins

	Name
bool	processPinDragAssist()<br>Inspects mouse position relative to all pins within the node and forces a pin hover operation on the nearest pin of the mouse is close enough, this allows pins to be (un)plugged more easily, not requiring the mouse to be directly over them.

Protected Attributes inherited from Workspace::CoreNodeWithPins

	Name
std::vector< CorePin * >	m_leftPins
DIWNE::VStack	m_outputPinsVstack
std::vector< CorePin * >	m_rightPins
bool	m_showDataOnPins
std::vector< Ptr< CorePin > >	m_workspaceInputs
std::vector< Ptr< CorePin > >	m_workspaceOutputs

Public Functions inherited from Workspace::CoreNode

	Name
	CoreNode(DIWNE::NodeEditor & diwne, Ptr< Core::Node > nodebase)
	~CoreNode() override
virtual bool	allowDrawing() override<br>Decide whether the object should be drawn (when outside the window for example)
virtual void	begin(DIWNE::DrawInfo & context) override<br>First method to be called during object drawing.
void	drawMenuDuplicate(DIWNE::DrawInfo & context)
void	drawMenuSetEditable()
void	drawMenuSetPrecision()
void	drawTrackingBorder(bool active, bool interpolating, float progress) const
void	drawTrackingCursor(ImRect rect, const Core::TrackedNodeData * t, bool inactiveOverlay, bool round) const
void	duplicate(DIWNE::DrawInfo & context, bool multiDuplication)
virtual void	endDiwne(DIWNE::DrawInfo & context) override
float	getDataItemsWidth()<br>Returns the desired width of data items (ImGui number fields)
FloatPopupMode &	getFloatPopupMode()
const std::string &	getKeyword() const<br>Returns the string identifier of the core node type.
LevelOfDetail	getLevelOfDetail()
virtual int	getLODCount()<br>Number of levels this node cycles through.
Ptr< Core::Node >	getNodebase() const<br>Returns the managed I3T Core node.
int	getNumberOfVisibleDecimal()
virtual void	onDestroy(bool logEvent) override<br>Gets called the moment the object is marked for deletion by destroy().
virtual void	onPopup() override
virtual void	onReleased(bool justReleased, DIWNE::DrawInfo & context) override<br>Called when the object is not pressed.
void	queueUpdateDataItemsWidth()<br>This call requests the data items width to be recalculated on the next draw of ths node.
void	setFloatPopupMode(FloatPopupMode mode)
LevelOfDetail	setLevelOfDetail(LevelOfDetail levelOfDetail)
virtual void	setNumberOfVisibleDecimal(int value)
virtual LevelOfDetail	switchLevelOfDetail(LevelOfDetail oldLevel)<br>Switches to the next LOD level.
virtual void	topContent(DIWNE::DrawInfo & context) override
virtual void	topRightHeaderContent(DIWNE::DrawInfo & context)<br>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.
void	drawMenuLevelOfDetail_builder(Ptr< CoreNode > node, std::vector< LevelOfDetail > const & levels_of_detail)

Protected Functions inherited from Workspace::CoreNode

	Name
virtual float	updateDataItemsWidth()<br>Calculates the final desired pixel width of data items (floats inside vectors, matrices etc.).

Public Attributes inherited from Workspace::CoreNode

	Name
constexpr char	CORE_NODE_FLAG
bool	m_referenceSpaceSource <br>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 inherited from Workspace::CoreNode

	Name
float	m_dataItemsWidth
bool	m_drawContextMenuButton
FloatPopupMode	m_floatPopupMode
bool	m_isFirstDraw
bool	m_isLabelBeingEdited
LevelOfDetail	m_levelOfDetail
const Ptr< Core::Node >	m_nodebase <br>Reference to the I3T Core node @description Each Workspace GUI node represents a single I3T Core node.
int	m_numberOfVisibleDecimal <br>number of decimal places used while display floats in the workspace
bool	m_topBottomSpacingDefault <br>Whether this node has spacing between content and header / end.
bool	m_updateDataItemsWidth

Public Functions inherited from Workspace::Node

	Name
	Node(DIWNE::NodeEditor & diwne, std::string label ="Header")
virtual bool	allowDragStart() const override<br>Determines whether a drag operation can start from this object.
virtual void	drawMenuDelete()
bool	getDuplicateNode() const
virtual void	onDestroy(bool logEvent)<br>Gets called the moment the object is marked for deletion by destroy().
void	setDuplicateNode(bool value)

Public Attributes inherited from Workspace::Node

	Name
bool	m_duplicateNode

Public Functions inherited from DIWNE::BasicNode

	Name
	BasicNode(NodeEditor & editor, std::string label)
virtual void	begin(DrawInfo & context) override<br>First method to be called during object drawing.
virtual void	bottomContent(DrawInfo & context)
virtual void	content(DrawInfo & context) override<br>Called after begin() during drawing.
virtual void	drawBody()
virtual void	drawHeader(ImDrawFlags corners =ImDrawFlags_RoundCornersTop)
virtual void	end(DrawInfo & context) override<br>Called after content().
const std::string &	getTopLabel() const
virtual void	leftContent(DrawInfo & context)
virtual void	rightContent(DrawInfo & context)
void	setTopLabel(const std::string & str)
virtual void	topContent(DrawInfo & context)
virtual void	translate(const ImVec2 & vec) override<br>Move the object's rect and any other associated positional data.
virtual void	updateLayout(DrawInfo & context) override<br>Updates object's m_rect, m_displayRect and any other object size variables.

Public Attributes inherited from DIWNE::BasicNode

	Name
DiwnePanel	m_center
DiwnePanel	m_left
DiwnePanel	m_middle
DiwnePanel	m_right
DiwnePanel	m_top

Protected Attributes inherited from DIWNE::BasicNode

	Name
bool	m_bottomSpacing <br>Whether to add a gap between the node content and the end.
float	m_contentSpacing <br>Gap between left, center and right panels (-1 for default item spacing).
bool	m_headerSpacing <br>Whether to add a gap between the node header and its content.
std::string	m_topLabel
float	m_topLabelWidth <br>Top label width in DIWNE coordinates.
float	m_topLabelWidthChange <br>Change of top label width since last frame, used to prevent layout flicker.

Public Functions inherited from DIWNE::Node

	Name
	Node(const Node & other) =delete
	Node(NodeEditor & diwne, std::string labelDiwne ="DiwneNode")
virtual void	afterDraw(DrawInfo & context) override<br>Called last during drawing.
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>First method to be called during object drawing.
virtual void	content(DrawInfo & context) override<br>Called after begin() during drawing.
virtual void	drawSelectionIndicator(DrawInfo & context)
virtual void	end(DrawInfo & context) override<br>Called after content().
bool	getFlag(char index) const<br>Get the node bit flag value at index.
virtual void	onDestroy(bool logEvent) override<br>Gets called the moment the object is marked for deletion by destroy().
virtual void	onDrag(DrawInfo & context, bool dragStart, bool dragEnd) override<br>This method gets called when the object is being dragged.
virtual void	onHover(DrawInfo & context) override<br>This method gets called when the object is hovered.
Node &	operator=(const Node & other) =delete
void	setFlag(char index, bool value)<br>Set the node bit flag value at index.
virtual void	updateLayout(DrawInfo & context) override<br>Updates object's m_rect, m_displayRect and any other object size variables.
bool	willBeRemovedFromContainer(const DiwneObject * container)

Protected Functions inherited from DIWNE::Node

	Name
virtual void	afterDrawDiwne(DrawInfo & context) override<br>Updates layout, processes interactions and then calls the user afterDraw() method.
virtual bool	processSelectDiwne(DrawInfo & context) override<br>Processes any interactions related to whether the object should be selected.
virtual void	setInitialPositionDiwne() override<br>Internal helper for setting the object's initial position.

Public Attributes inherited from DIWNE::Node

	Name
bool	m_forceDraw <br>Internal flag to force drawing of the node, used by pins (TODO: move to DiwneObject?)

Protected Attributes inherited from DIWNE::Node

	Name
NodeFlag	m_flag <br>The node flag bit field.

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.
virtual bool	allowSelectOnClick(const DrawInfo & context) const<br>Determines whether the object can be selected by clicking it (eg.
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	content(DrawInfo & context) =0<br>Called after begin() during 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().
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
virtual void	initialize(DrawInfo & context)<br>First method to be called every frame.
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.
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 Screen

cpp

explicit Screen(
    DIWNE::NodeEditor & diwne
)

explicit Screen(
    DIWNE::NodeEditor & diwne
)

function ~Screen

cpp

~Screen() override

~Screen() override

function accept

cpp

inline virtual void accept(
    NodeVisitor & visitor
) override

inline virtual void accept(
    NodeVisitor & visitor
) override

Reimplements: IVisitable::accept

function centerContent

cpp

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

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

Reimplements: DIWNE::BasicNode::centerContent

function drawMenuLevelOfDetail

cpp

virtual void drawMenuLevelOfDetail() override

virtual void drawMenuLevelOfDetail() override

Reimplements: Workspace::CoreNode::drawMenuLevelOfDetail

function finalize

cpp

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

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

The final method to be called, gets called every frame and doesn't do any drawing.

Reimplements: DIWNE::DiwneObject::finalize

function getScreenSize

cpp

ImVec2 getScreenSize() const

ImVec2 getScreenSize() const

function maxLengthOfData

cpp

virtual int maxLengthOfData() override

virtual int maxLengthOfData() override

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

Reimplements: Workspace::CoreNode::maxLengthOfData

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

function onSelection

cpp

virtual void onSelection(
    bool selected
) override

virtual void onSelection(
    bool selected
) override

Reimplements: Workspace::CoreNode::onSelection

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: Workspace::CoreNode::popupContent

function setScreenSize

cpp

void setScreenSize(
    ImVec2 aspect
)

void setScreenSize(
    ImVec2 aspect
)

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

Classes

Namespaces

Workspace::Screen

Public Functions

Additional inherited members

Public Functions Documentation

function Screen

function ~Screen

function accept

function centerContent

function drawMenuLevelOfDetail

function finalize

function getScreenSize

function maxLengthOfData

function onSelection

function popupContent

function setScreenSize

Workspace::Screen ​

Public Functions ​

Additional inherited members ​

Public Functions Documentation ​

function Screen ​

function ~Screen ​

function accept ​

function centerContent ​

function drawMenuLevelOfDetail ​

function finalize ​

function getScreenSize ​

function maxLengthOfData ​

function onSelection ​

function popupContent ​

function setScreenSize ​

Workspace::Screen

Public Functions

Additional inherited members

Public Functions Documentation

function Screen

function ~Screen

function accept

function centerContent

function drawMenuLevelOfDetail

function finalize

function getScreenSize

function maxLengthOfData

function onSelection

function popupContent

function setScreenSize