NAV::gui::NodeEditorApplication Class Reference

Application class providing all relevant GUI callbacks. More...

Public Types
enum	Colors : uint8_t {   COLOR_GROUP_HEADER_TEXT ,   COLOR_GROUP_HEADER_BG ,   COLOR_GROUP_OUTER_BORDER }
	Available color settings. More...

Public Member Functions
	NodeEditorApplication ()=delete
	Default constructor.
	NodeEditorApplication (const NodeEditorApplication &)=delete
	Copy constructor.
	NodeEditorApplication (NodeEditorApplication &&)=delete
	Move constructor.
void	OnFrame (float deltaTime) override
	Called on every frame.
bool	OnQuitRequest () override
	Called when the user request the application to close.
void	OnStart () override
	Called when the application is started.
void	OnStop () override
	Called when the application is stopped.
NodeEditorApplication &	operator= (const NodeEditorApplication &)=delete
	Copy assignment operator.
NodeEditorApplication &	operator= (NodeEditorApplication &&)=delete
	Move assignment operator.
void	ShowClearNodesRequested ()
	Shows a PopupModel to clear the current flow.
void	ShowLoadRequested ()
	Shows a PopupModel loading a new flow.
void	ShowQuitRequested ()
	Shows a PopupModal asking the user if he wants to quit with unsaved changes.
void	ShowSaveAsRequested ()
	Shows a PopupModel where the user can select a path to save his flow to.
	~NodeEditorApplication () override=default
	Destructor.

Static Public Member Functions
static float	defaultFontRatio ()
	Ratio to multiply for default GUI elements.
static float	headerFontRatio ()
	Ratio to multiply for node header elements.
static float	monoFontRatio ()
	Ratio to multiply for log output GUI elements.
static float	panelFontRatio ()
	Ratio to multiply for GUI editor elements.
static void	ShowRenameNodeRequest (Node *&renameNode)
	Shows a PopupModal where the user can rename the node.
static void	ShowRenamePinRequest (Pin *&renamePin)
	Shows a PopupModal where the user can rename the pin.
static float	windowFontRatio ()
	Ratio to multiply for GUI window elements.

Public Attributes
int	frameCountNavigate
	Frame counter to block the navigate to content function till nodes are correctly loaded.

Static Public Attributes
static bool	_showQueueSizeOnPins
	Shows the queue size on the pins (every frame the queue mutex will be locked)
static float	bottomViewHeight
	Height of the log viewer.
static bool	hideFPS
	Hide FPS counter.
static bool	hideLeftPane
	Hide left pane.
static ImPlotStyle	imPlotReferenceStyle
	Default style of the ImPlot library to compare changes against.
static float	leftPaneWidth
	Width of the left pane.
static std::vector< ImVec4 >	m_colors
	Color settings.
static std::vector< const char * >	m_colorsNames
	Color names.
static std::array< ImTextureID, 2 >	m_InsLogo
	Pointer to the texture for the INS logo.
static std::array< ImTextureID, 2 >	m_InstinctLogo
	Pointer to the texture for the instinct logo.
static ImTextureID	m_RoseFigure
	Pointer to the texture for the rose figure (ImuSimulator node)
static ImTextureID	m_SaveButtonImage
	Pointer to the texture for the save button.
static float	menuBarHeight
	Height of the menu bar on top.
static float	rightPaneWidth
	Width of the right pane.
static constexpr float	SPLITTER_THICKNESS
	Thickness of the splitter between left and right pane.

Private Types
enum class	BottomViewTabItem : uint8_t {   None ,   LogOutput }
	Tabs displayed in the bottom view. More...

Private Attributes
BottomViewTabItem	bottomViewSelectedTab
	Selected Tab item in the bottom view.
GlobalActions	globalAction
	Global action to execute.
ImTextureID	m_HeaderBackground
	Pointer to the texture for the node headers.

Static Private Attributes
static constexpr float	BOTTOM_VIEW_COLLAPSED_MIN_HEIGHT
	Minimal height of the bottom view if it is collapsed.
static constexpr float	BOTTOM_VIEW_UNCOLLAPSED_MIN_HEIGHT
	Minimal height of the bottom view if it is not collapsed.

Friends
void	windows::ShowFontSizeEditor (bool *show)
	Shows a window for choosing the font size.

Detailed Description

Application class providing all relevant GUI callbacks.

Member Enumeration Documentation

BottomViewTabItem

enum class NAV::gui::NodeEditorApplication::BottomViewTabItem : uint8_t

strongprivate

Tabs displayed in the bottom view.

Enumerator
None	The cross item is selected.
LogOutput	The log output item is selected.

Colors

enum NAV::gui::NodeEditorApplication::Colors : uint8_t

Available color settings.

Enumerator
COLOR_GROUP_HEADER_TEXT	Color of the group header text.
COLOR_GROUP_HEADER_BG	Color of the group header background.
COLOR_GROUP_OUTER_BORDER	Color of the group outer border.

Member Function Documentation

OnFrame()

void NAV::gui::NodeEditorApplication::OnFrame ( float deltaTime )

override

Called on every frame.

Parameters

[in]

deltaTime

Time since last frame

OnQuitRequest()

bool NAV::gui::NodeEditorApplication::OnQuitRequest ( )

override

Called when the user request the application to close.

Checks whether there are unsaved changes and then prompts the user to save them before quit

Returns

True if no unsaved changes

ShowRenameNodeRequest()

static void NAV::gui::NodeEditorApplication::ShowRenameNodeRequest ( Node *& renameNode )

static

Shows a PopupModal where the user can rename the node.

Parameters

[in,out]

renameNode

Pointer to the node to rename. Pointer gets nulled when finished.

ShowRenamePinRequest()

static void NAV::gui::NodeEditorApplication::ShowRenamePinRequest ( Pin *& renamePin )

static

Shows a PopupModal where the user can rename the pin.

Parameters

[in,out]

renamePin

Pointer to the pin to rename. Pointer gets nulled when finished.

Friends And Related Symbol Documentation

windows::ShowFontSizeEditor

void windows::ShowFontSizeEditor ( bool * show )

friend

Shows a window for choosing the font size.

Parameters

[in,out]

show

Flag which indicates whether the window is shown

---

The documentation for this class was generated from the following file:

• /home/runner/work/INSTINCT/INSTINCT/src/internal/gui/NodeEditorApplication.hpp