NodeEditor (imgui-binding 1.83.1 API)

java.lang.Object
- imgui.extension.nodeditor.NodeEditor

```
public final class NodeEditor
extends java.lang.Object
```
Bindings for Imgui Node Editor (https://github.com/thedmd/imgui-node-editor) Original library author - Michał Cichoń (https://github.com/thedmd) An implementation of node editor with ImGui-like API. Project purpose is to serve as a basis for more complex solutions like blueprint editors. Refer to the library's Github page for examples and support Before you can start drawing editor you have to create ImNodeEditorContext (either by invoking constructor directly or using ImNodeEditor.createEditor()) and switch current editor via ImNodeEditor.setCurrentEditor(NodeEditorContext) Binding notice: instead of special types for ids of nodes, links and pins which used in native library we use longs to reduce boilerplate and garbage production

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`acceptCopy()`
`static boolean`	`acceptCreateNode()`
`static boolean`	`acceptCut()`
`static boolean`	`acceptDeletedItem()`
`static boolean`	`acceptDuplicate()`
`static boolean`	`acceptNewItem()`
`static boolean`	`acceptNewItem(float r, float g, float b, float a, float thickness)`
`static boolean`	`acceptPaste()`
`static boolean`	`areShortcutsEnabled()`
`static void`	`begin(java.lang.String title)`
`static boolean`	`beginCreate()`
`static boolean`	`beginCreate(float r, float g, float b, float a, float thickness)`
`static boolean`	`beginDelete()`
`static boolean`	`beginGroupHint(long id)`
`static void`	`beginNode(long id)`
`static void`	`beginPin(long pin, int imNodeEditorPinKind)`
`static boolean`	`beginShortcut()`
`static void`	`centerNodeOnScreen(long node)`
`static void`	`clearSelection()`
`static NodeEditorContext`	`createEditor()` This method exists for api consistency and you can just call NodeEditorContext manually
`static NodeEditorContext`	`createEditor(NodeEditorConfig config)`
`static boolean`	`deleteLink(long linkId)`
`static boolean`	`deleteNode(long nodeId)`
`static void`	`deselectLink(long id)`
`static void`	`deselectNode(long id)`
`static void`	`destroyEditor(NodeEditorContext editorContext)` This method exists for api consistency and you can just call NodeEditorContext.destroy() manually
`static void`	`enableShortcuts(boolean enable)`
`static void`	`end()`
`static void`	`endCreate()`
`static void`	`endDelete()`
`static void`	`endGroupHint()`
`static void`	`endNode()`
`static void`	`endPin()`
`static void`	`endShortcut()`
`static void`	`flow(long linkId)`
`static int`	`getActionContextLinks(long[] links, int size)`
`static int`	`getActionContextNodes(long[] nodes, int size)`
`static int`	`getActionContextSize()`
`static float`	`getCurrentZoom()`
`static long`	`getDoubleClickedLink()`
`static long`	`getDoubleClickedNode()`
`static long`	`getDoubleClickedPin()`
`static float`	`getGroupMaxX()`
`static float`	`getGroupMaxY()`
`static float`	`getGroupMinX()`
`static float`	`getGroupMinY()`
`static ImDrawList`	`getHintBackgroundDrawList()`
`static ImDrawList`	`getHintForegroundDrawList()` Binding notice: both getHintForegroundDrawList(), getHintBackgroundDrawList() and getNodeBackgroundDrawList(long) return singleton objects which shouldn't be used outside of the scope of current hint/node
`static long`	`getLinkWithContextMenu()`
`static ImDrawList`	`getNodeBackgroundDrawList(long nodeId)`
`static void`	`getNodePosition(long node, ImVec2 dst)`
`static float`	`getNodePositionX(long node)`
`static float`	`getNodePositionY(long node)`
`static float`	`getNodeSizeX(long node)`
`static float`	`getNodeSizeY(long node)`
`static long`	`getNodeWithContextMenu()` Binding notice: getNodeWithContextMenu(), getPinWithContextMenu() and getLinkWithContextMenu() return id of the object for which context menu should be shown.
`static long`	`getPinWithContextMenu()`
`static float`	`getScreenSizeX()`
`static float`	`getScreenSizeY()`
`static int`	`getSelectedLinks(long[] links, int size)`
`static int`	`getSelectedNodes(long[] nodes, int size)`
`static int`	`getSelectedObjectCount()`
`static NodeEditorStyle`	`getStyle()`
`static java.lang.String`	`getStyleColorName(int imNodeEditorStyleColor)`
`static void`	`group(float w, float h)`
`static boolean`	`hasSelectionChanged()`
`static boolean`	`isActive()`
`static boolean`	`isBackgroundClicked()`
`static boolean`	`isBackgroundDoubleClicked()`
`static boolean`	`isSuspended()`
`static void`	`link(long id, long startPinId, long endPinId)`
`static void`	`link(long id, long startPinId, long endPinId, float r, float g, float b, float a, float thickness)`
`static void`	`navigateToContent(float duration)`
`static void`	`navigateToSelection(boolean zoomIn, float duration)`
`static boolean`	`pinHadAnyLinks(long pinId)`
`static void`	`pinPivotAlignment(float x, float y)`
`static void`	`pinPivotRect(float x, float y, float w, float h)`
`static void`	`pinPivotScale(float w, float h)`
`static void`	`pinPivotSize(float w, float h)`
`static void`	`pinRect(float x, float y, float w, float h)`
`static void`	`popStyleColor(int count)`
`static void`	`popStyleVar(int count)`
`static void`	`pushStyleColor(int imNodeEditorStyleColor, float r, float g, float b, float a)`
`static void`	`pushStyleVar(int imNodeEditorStyleVar, float v)`
`static void`	`pushStyleVar(int imNodeEditorStyleVar, float x, float y)`
`static void`	`pushStyleVar(int imNodeEditorStyleVar, float r, float g, float b, float a)`
`static boolean`	`queryDeletedLink(ImLong linkId, ImLong startId, ImLong endId)`
`static boolean`	`queryDeletedNode(ImLong nodeId)`
`static boolean`	`queryNewLink(ImLong startId, ImLong endId)`
`static boolean`	`queryNewLink(ImLong startId, ImLong endId, float r, float g, float b, float a, float thickness)`
`static void`	`rejectDeletedItem()`
`static void`	`rejectNewItem()`
`static void`	`rejectNewItem(float r, float g, float b, float a, float thickness)`
`static void`	`restoreNodeState(long node)`
`static void`	`resume()`
`static void`	`selectLink(long id, boolean append)`
`static void`	`selectNode(long id, boolean append)`
`static void`	`setCurrentEditor(NodeEditorContext editorContext)`
`static void`	`setNodePosition(long node, float x, float y)`
`static boolean`	`showBackgroundContextMenu()`
`static boolean`	`showLinkContextMenu(ImLong linkId)`
`static boolean`	`showNodeContextMenu(ImLong nodeId)`
`static boolean`	`showPinContextMenu(ImLong pinId)`
`static void`	`suspend()`
`static float`	`toCanvasX(float screenSpacePosX)`
`static float`	`toCanvasY(float screenSpacePosY)`
`static float`	`toScreenX(float canvasSpacePosX)`
`static float`	`toScreenY(float canvasSpacePosY)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createEditor
```
public static NodeEditorContext createEditor()
```
This method exists for api consistency and you can just call NodeEditorContext manually

createEditor

public static NodeEditorContext createEditor(NodeEditorConfig config)

destroyEditor
```
public static void destroyEditor(NodeEditorContext editorContext)
```
This method exists for api consistency and you can just call NodeEditorContext.destroy() manually

setCurrentEditor

public static void setCurrentEditor(NodeEditorContext editorContext)

begin

public static void begin(java.lang.String title)

beginNode

public static void beginNode(long id)

group

public static void group(float w,
                         float h)

beginGroupHint

public static boolean beginGroupHint(long id)

beginPin

public static void beginPin(long pin,
                            int imNodeEditorPinKind)

endGroupHint
```
public static void endGroupHint()
```

endPin
```
public static void endPin()
```

endNode
```
public static void endNode()
```

end
```
public static void end()
```

getScreenSizeX
```
public static float getScreenSizeX()
```

getScreenSizeY
```
public static float getScreenSizeY()
```

toCanvasX

public static float toCanvasX(float screenSpacePosX)

toCanvasY

public static float toCanvasY(float screenSpacePosY)

toScreenX

public static float toScreenX(float canvasSpacePosX)

toScreenY

public static float toScreenY(float canvasSpacePosY)

getStyle

public static NodeEditorStyle getStyle()

getStyleColorName

public static java.lang.String getStyleColorName(int imNodeEditorStyleColor)

pushStyleColor

public static void pushStyleColor(int imNodeEditorStyleColor,
                                  float r,
                                  float g,
                                  float b,
                                  float a)

popStyleColor

public static void popStyleColor(int count)

pushStyleVar

public static void pushStyleVar(int imNodeEditorStyleVar,
                                float v)

pushStyleVar

public static void pushStyleVar(int imNodeEditorStyleVar,
                                float x,
                                float y)

pushStyleVar

public static void pushStyleVar(int imNodeEditorStyleVar,
                                float r,
                                float g,
                                float b,
                                float a)

popStyleVar

public static void popStyleVar(int count)

getGroupMinX
```
public static float getGroupMinX()
```

getGroupMinY
```
public static float getGroupMinY()
```

getGroupMaxX
```
public static float getGroupMaxX()
```

getGroupMaxY
```
public static float getGroupMaxY()
```

getHintForegroundDrawList
```
public static ImDrawList getHintForegroundDrawList()
```
Binding notice: both getHintForegroundDrawList(), getHintBackgroundDrawList() and getNodeBackgroundDrawList(long) return singleton objects which shouldn't be used outside of the scope of current hint/node

getHintBackgroundDrawList

public static ImDrawList getHintBackgroundDrawList()

getNodeBackgroundDrawList

public static ImDrawList getNodeBackgroundDrawList(long nodeId)

getDoubleClickedNode

public static long getDoubleClickedNode()

getDoubleClickedPin

public static long getDoubleClickedPin()

getDoubleClickedLink

public static long getDoubleClickedLink()

isBackgroundClicked

public static boolean isBackgroundClicked()

isBackgroundDoubleClicked

public static boolean isBackgroundDoubleClicked()

pinHadAnyLinks

public static boolean pinHadAnyLinks(long pinId)

getCurrentZoom
```
public static float getCurrentZoom()
```

pinRect

public static void pinRect(float x,
                           float y,
                           float w,
                           float h)

pinPivotRect

public static void pinPivotRect(float x,
                                float y,
                                float w,
                                float h)

pinPivotSize

public static void pinPivotSize(float w,
                                float h)

pinPivotScale

public static void pinPivotScale(float w,
                                 float h)

pinPivotAlignment

public static void pinPivotAlignment(float x,
                                     float y)

showNodeContextMenu

public static boolean showNodeContextMenu(ImLong nodeId)

showPinContextMenu

public static boolean showPinContextMenu(ImLong pinId)

showLinkContextMenu

public static boolean showLinkContextMenu(ImLong linkId)

getNodeWithContextMenu
```
public static long getNodeWithContextMenu()
```
Binding notice: getNodeWithContextMenu(), getPinWithContextMenu() and getLinkWithContextMenu() return id of the object for which context menu should be shown. If there is no such object -1 will be returned.
These methods implemented as convenient alternative to showNodeContextMenu(ImLong), showPinContextMenu(ImLong) and showLinkContextMenu(ImLong)

getPinWithContextMenu

public static long getPinWithContextMenu()

getLinkWithContextMenu

public static long getLinkWithContextMenu()

showBackgroundContextMenu

public static boolean showBackgroundContextMenu()

restoreNodeState

public static void restoreNodeState(long node)

suspend
```
public static void suspend()
```

resume
```
public static void resume()
```

isSuspended
```
public static boolean isSuspended()
```

isActive
```
public static boolean isActive()
```

setNodePosition

public static void setNodePosition(long node,
                                   float x,
                                   float y)

link

public static void link(long id,
                        long startPinId,
                        long endPinId)

link

public static void link(long id,
                        long startPinId,
                        long endPinId,
                        float r,
                        float g,
                        float b,
                        float a,
                        float thickness)

flow
```
public static void flow(long linkId)
```

beginCreate
```
public static boolean beginCreate()
```

beginCreate

public static boolean beginCreate(float r,
                                  float g,
                                  float b,
                                  float a,
                                  float thickness)

queryNewLink

public static boolean queryNewLink(ImLong startId,
                                   ImLong endId)

queryNewLink

public static boolean queryNewLink(ImLong startId,
                                   ImLong endId,
                                   float r,
                                   float g,
                                   float b,
                                   float a,
                                   float thickness)

acceptNewItem
```
public static boolean acceptNewItem()
```

acceptNewItem

public static boolean acceptNewItem(float r,
                                    float g,
                                    float b,
                                    float a,
                                    float thickness)

rejectNewItem
```
public static void rejectNewItem()
```

rejectNewItem

public static void rejectNewItem(float r,
                                 float g,
                                 float b,
                                 float a,
                                 float thickness)

endCreate
```
public static void endCreate()
```

beginDelete
```
public static boolean beginDelete()
```

queryDeletedLink

public static boolean queryDeletedLink(ImLong linkId,
                                       ImLong startId,
                                       ImLong endId)

queryDeletedNode

public static boolean queryDeletedNode(ImLong nodeId)

acceptDeletedItem

public static boolean acceptDeletedItem()

rejectDeletedItem

public static void rejectDeletedItem()

endDelete
```
public static void endDelete()
```

navigateToContent

public static void navigateToContent(float duration)

navigateToSelection

public static void navigateToSelection(boolean zoomIn,
                                       float duration)

getNodePosition

public static void getNodePosition(long node,
                                   ImVec2 dst)

getNodePositionX

public static float getNodePositionX(long node)

getNodePositionY

public static float getNodePositionY(long node)

getNodeSizeX

public static float getNodeSizeX(long node)

getNodeSizeY

public static float getNodeSizeY(long node)

centerNodeOnScreen

public static void centerNodeOnScreen(long node)

hasSelectionChanged

public static boolean hasSelectionChanged()

getSelectedObjectCount

public static int getSelectedObjectCount()

getSelectedNodes

public static int getSelectedNodes(long[] nodes,
                                   int size)

getSelectedLinks

public static int getSelectedLinks(long[] links,
                                   int size)

clearSelection
```
public static void clearSelection()
```

selectNode

public static void selectNode(long id,
                              boolean append)

selectLink

public static void selectLink(long id,
                              boolean append)

deselectNode

public static void deselectNode(long id)

deselectLink

public static void deselectLink(long id)

deleteNode

public static boolean deleteNode(long nodeId)

deleteLink

public static boolean deleteLink(long linkId)

enableShortcuts

public static void enableShortcuts(boolean enable)

areShortcutsEnabled

public static boolean areShortcutsEnabled()

beginShortcut
```
public static boolean beginShortcut()
```

acceptCut
```
public static boolean acceptCut()
```

acceptCopy
```
public static boolean acceptCopy()
```

acceptPaste
```
public static boolean acceptPaste()
```

acceptDuplicate

public static boolean acceptDuplicate()

acceptCreateNode

public static boolean acceptCreateNode()

getActionContextSize

public static int getActionContextSize()

getActionContextNodes

public static int getActionContextNodes(long[] nodes,
                                        int size)

getActionContextLinks

public static int getActionContextLinks(long[] links,
                                        int size)

endShortcut
```
public static void endShortcut()
```

Class NodeEditor

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createEditor

createEditor

destroyEditor

setCurrentEditor

begin

beginNode

group

beginGroupHint

beginPin

endGroupHint

endPin

endNode

end

getScreenSizeX

getScreenSizeY

toCanvasX

toCanvasY

toScreenX

toScreenY

getStyle

getStyleColorName

pushStyleColor

popStyleColor

pushStyleVar

pushStyleVar

pushStyleVar

popStyleVar

getGroupMinX

getGroupMinY

getGroupMaxX

getGroupMaxY

getHintForegroundDrawList

getHintBackgroundDrawList

getNodeBackgroundDrawList

getDoubleClickedNode

getDoubleClickedPin

getDoubleClickedLink

isBackgroundClicked

isBackgroundDoubleClicked

pinHadAnyLinks

getCurrentZoom

pinRect

pinPivotRect

pinPivotSize

pinPivotScale

pinPivotAlignment

showNodeContextMenu

showPinContextMenu

showLinkContextMenu

getNodeWithContextMenu

getPinWithContextMenu

getLinkWithContextMenu

showBackgroundContextMenu

restoreNodeState

suspend

resume

isSuspended

isActive

setNodePosition

link

link

flow

beginCreate

beginCreate

queryNewLink

queryNewLink

acceptNewItem

acceptNewItem

rejectNewItem

rejectNewItem

endCreate

beginDelete

queryDeletedLink

queryDeletedNode

acceptDeletedItem

rejectDeletedItem