ImNodes (imgui-binding 1.87.2 API)

java.lang.Object
- imgui.extension.imnodes.ImNodes

```
public final class ImNodes
extends java.lang.Object
```
Bindings for Imnodes (https://github.com/Nelarius/imnodes/) Original library author - Johann Muszynski (https://github.com/Nelarius)
Refer to the library's Github page for examples and support

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`beginInputAttribute(int id)` Create an input attribute block.
`static void`	`beginInputAttribute(int id, int shape)` Create an input attribute block.
`static void`	`beginNode(int node)`
`static void`	`beginNodeEditor()` The top-level function call.
`static void`	`beginNodeTitleBar()` Place your node title bar content (such as the node title, using ImGui::Text) between the following function calls.
`static void`	`beginOutputAttribute(int id)` Create an output attribute block.
`static void`	`beginOutputAttribute(int id, int shape)` Create an output attribute block.
`static void`	`beginStaticAttribute(int id)` Create a static attribute block.
`static void`	`clearLinkSelection()` Clears the list of selected nodes/links.
`static void`	`clearLinkSelection(int linkId)`
`static void`	`clearNodeSelection()` Clears the list of selected nodes/links.
`static void`	`clearNodeSelection(int nodeId)`
`static ImNodesContext`	`createContext()`
`static void`	`destroyContext()`
`static void`	`destroyContext(ImNodesContext ctx)`
`static ImNodesEditorContext`	`editorContextCreate()`
`static void`	`editorContextFree(ImNodesEditorContext context)`
`static ImVec2`	`editorContextGetPanning()`
`static void`	`editorContextGetPanning(ImVec2 dst)`
`static float`	`editorContextGetPanningX()`
`static float`	`editorContextGetPanningY()`
`static void`	`editorContextMoveToNode(int nodeId)`
`static void`	`editorContextResetPanning(float posX, float posY)`
`static void`	`editorContextResetPanning(ImVec2 pos)`
`static void`	`editorContextSet(ImNodesEditorContext context)`
`static void`	`endInputAttribute()`
`static void`	`endNode()`
`static void`	`endNodeEditor()`
`static void`	`endNodeTitleBar()`
`static void`	`endOutputAttribute()`
`static void`	`endStaticAttribute()`
`static int`	`getActiveAttribute()` Binding notice: getActiveAttribute() returns id the active attribute.
`static ImNodesContext`	`getCurrentContext()`
`static int`	`getHoveredLink()`
`static int`	`getHoveredNode()`
`static int`	`getHoveredPin()`
`static ImNodesIO`	`getIO()`
`static void`	`getNodeDimensions(ImVec2 dst, int id)`
`static ImVec2`	`getNodeDimensions(int id)`
`static float`	`getNodeDimensionsX(int id)`
`static float`	`getNodeDimensionsY(int id)`
`static void`	`getNodeEditorSpacePos(int nodeId)`
`static void`	`getNodeGridSpacePos(int nodeId)`
`static void`	`getNodeScreenSpacePos(int nodeId)`
`static void`	`getSelectedLinks(int[] linkIds)` Get the selected node/link ids.
`static void`	`getSelectedNodes(int[] nodeIds)` Get the selected node/link ids.
`static ImNodesStyle`	`getStyle()` Returns the global style struct.
`static boolean`	`isAnyAttributeActive()`
`static boolean`	`isAnyAttributeActive(ImInt attributeId)`
`static boolean`	`isAttributeActive()` Was the previous attribute active? This will continuously return true while the left mouse button is being pressed over the UI content of the attribute.
`static boolean`	`isEditorHovered()` Returns true if the current node editor canvas is being hovered over by the mouse, and is not blocked by any other windows.
`static boolean`	`isLinkCreated(ImInt startedAtAttributeId, ImInt endedAtAttributeId)` Did the user finish creating a new link?
`static boolean`	`isLinkCreated(ImInt startedAtAttributeId, ImInt endedAtAttributeId, ImBoolean createdFromSnap)` Did the user finish creating a new link?
`static boolean`	`isLinkCreated(ImInt startedAtNodeId, ImInt startedAtAttributeId, ImInt endedAtNodeId, ImInt endedAtAttributeId)` Did the user finish creating a new link?
`static boolean`	`isLinkCreated(ImInt startedAtNodeId, ImInt startedAtAttributeId, ImInt endedAtNodeId, ImInt endedAtAttributeId, ImBoolean createdFromSnap)` Did the user finish creating a new link?
`static boolean`	`isLinkDestroyed(ImInt linkId)` Was an existing link detached from a pin by the user? The detached link's id is assigned to the output argument link_id.
`static boolean`	`isLinkDropped()` Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.
`static boolean`	`isLinkDropped(boolean includingDetachedLinks)` Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.
`static boolean`	`isLinkDropped(ImInt startedAtAttributeId)` Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.
`static boolean`	`isLinkDropped(ImInt startedAtAttributeId, boolean includingDetachedLinks)` Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.
`static boolean`	`isLinkHovered(ImInt linkId)`
`static boolean`	`isLinkSelected(int linkId)`
`static boolean`	`isLinkStarted(ImInt startedAtAttributeId)` Did the user start dragging a new link from a pin?
`static boolean`	`isNodeHovered(ImInt nodeId)`
`static boolean`	`isNodeSelected(int nodeId)`
`static boolean`	`isPinHovered(ImInt attributeId)`
`static void`	`link(int id, int source, int target)` Render a link between attributes.
`static void`	`loadCurrentEditorStateFromIniFile(java.lang.String fileName)`
`static void`	`loadCurrentEditorStateFromIniString(java.lang.String data, int dataSize)`
`static void`	`loadEditorStateFromIniFile(ImNodesEditorContext editor, java.lang.String fileName)`
`static void`	`loadEditorStateFromIniString(ImNodesEditorContext editor, java.lang.String data, int dataSize)`
`static void`	`miniMap()` Add a navigable minimap to the editor; call before EndNodeEditor after all nodes and links have been specified // TODO: add callback
`static void`	`miniMap(float miniMapSizeFraction)` Add a navigable minimap to the editor; call before EndNodeEditor after all nodes and links have been specified // TODO: add callback
`static void`	`miniMap(float miniMapSizeFraction, int miniMapLocation)` Add a navigable minimap to the editor; call before EndNodeEditor after all nodes and links have been specified // TODO: add callback
`static int`	`numSelectedLinks()`
`static int`	`numSelectedNodes()` Use The following two functions to query the number of selected nodes or links in the current editor.
`static void`	`popAttributeFlag()`
`static void`	`popColorStyle()`
`static void`	`popStyleVar()`
`static void`	`pushAttributeFlag(int flag)` Push a single AttributeFlags value.
`static void`	`pushColorStyle(int item, int color)` Use PushColorStyle and PopColorStyle to modify ImNodesColorStyle mid-frame.
`static void`	`pushStyleVar(int styleItem, float value)`
`static void`	`pushStyleVar(int styleItem, float valueX, float valueY)`
`static void`	`pushStyleVar(int styleItem, ImVec2 value)`
`static void`	`saveCurrentEditorStateToIniFile(java.lang.String fileName)`
`static java.lang.String`	`saveCurrentEditorStateToIniString()`
`static void`	`saveEditorStateToIniFile(ImNodesEditorContext editor, java.lang.String fileName)`
`static java.lang.String`	`saveEditorStateToIniString(ImNodesEditorContext editor)`
`static void`	`selectLink(int linkId)`
`static void`	`selectNode(int nodeId)` Manually select a node or link.
`static void`	`setCurrentContext(ImNodesContext ctx)`
`static void`	`setImGuiContext(ImGuiContext ctx)`
`static void`	`setNodeDraggable(int nodeId, boolean draggable)` Enable or disable the ability to click and drag a specific node.
`static void`	`setNodeEditorSpacePos(int nodeId, float editorSpacePosX, float editorSpacePosY)`
`static void`	`setNodeEditorSpacePos(int nodeId, ImVec2 editorSpacePos)`
`static void`	`setNodeGridSpacePos(int nodeId, float gridPosX, float gridPosY)`
`static void`	`setNodeGridSpacePos(int nodeId, ImVec2 gridPos)`
`static void`	`setNodeScreenSpacePos(int nodeId, float screenSpacePosX, float screenSpacePosY)`
`static void`	`setNodeScreenSpacePos(int nodeId, ImVec2 screenSpacePos)`
`static void`	`styleColorsClassic()`
`static void`	`styleColorsDark()`
`static void`	`styleColorsLight()`

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

Method Detail

setImGuiContext

public static void setImGuiContext(ImGuiContext ctx)

createContext

public static ImNodesContext createContext()

destroyContext
```
public static void destroyContext()
```

destroyContext

public static void destroyContext(ImNodesContext ctx)

getCurrentContext

public static ImNodesContext getCurrentContext()

setCurrentContext

public static void setCurrentContext(ImNodesContext ctx)

editorContextCreate

public static ImNodesEditorContext editorContextCreate()

editorContextFree

public static void editorContextFree(ImNodesEditorContext context)

editorContextSet

public static void editorContextSet(ImNodesEditorContext context)

editorContextGetPanning

public static ImVec2 editorContextGetPanning()

editorContextGetPanningX

public static float editorContextGetPanningX()

editorContextGetPanningY

public static float editorContextGetPanningY()

editorContextGetPanning

public static void editorContextGetPanning(ImVec2 dst)

editorContextResetPanning

public static void editorContextResetPanning(ImVec2 pos)

editorContextResetPanning

public static void editorContextResetPanning(float posX,
                                             float posY)

editorContextMoveToNode

public static void editorContextMoveToNode(int nodeId)

getIO
```
public static ImNodesIO getIO()
```

getStyle
```
public static ImNodesStyle getStyle()
```
Returns the global style struct. See the struct declaration for default values.

styleColorsDark
```
public static void styleColorsDark()
```

styleColorsClassic

public static void styleColorsClassic()

styleColorsLight
```
public static void styleColorsLight()
```

beginNodeEditor
```
public static void beginNodeEditor()
```
The top-level function call. Call this before calling BeginNode/EndNode. Calling this function will result the node editor grid workspace being rendered.

endNodeEditor
```
public static void endNodeEditor()
```

miniMap
```
public static void miniMap()
```
Add a navigable minimap to the editor; call before EndNodeEditor after all nodes and links have been specified // TODO: add callback

miniMap
```
public static void miniMap(float miniMapSizeFraction)
```
Add a navigable minimap to the editor; call before EndNodeEditor after all nodes and links have been specified // TODO: add callback

miniMap
```
public static void miniMap(float miniMapSizeFraction,
                           int miniMapLocation)
```
Add a navigable minimap to the editor; call before EndNodeEditor after all nodes and links have been specified // TODO: add callback

pushColorStyle

public static void pushColorStyle(int item,
                                  int color)

Use PushColorStyle and PopColorStyle to modify ImNodesColorStyle mid-frame.

popColorStyle
```
public static void popColorStyle()
```

pushStyleVar

public static void pushStyleVar(int styleItem,
                                float value)

pushStyleVar

public static void pushStyleVar(int styleItem,
                                ImVec2 value)

pushStyleVar

public static void pushStyleVar(int styleItem,
                                float valueX,
                                float valueY)

popStyleVar
```
public static void popStyleVar()
```

beginNode

public static void beginNode(int node)

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

getNodeDimensions

public static ImVec2 getNodeDimensions(int id)

getNodeDimensionsX

public static float getNodeDimensionsX(int id)

getNodeDimensionsY

public static float getNodeDimensionsY(int id)

getNodeDimensions

public static void getNodeDimensions(ImVec2 dst,
                                     int id)

beginNodeTitleBar
```
public static void beginNodeTitleBar()
```
Place your node title bar content (such as the node title, using ImGui::Text) between the following function calls. These functions have to be called before adding any attributes, or the layout of the node will be incorrect.

endNodeTitleBar
```
public static void endNodeTitleBar()
```

beginInputAttribute
```
public static void beginInputAttribute(int id)
```
Create an input attribute block. The pin is rendered on left side.

beginInputAttribute

public static void beginInputAttribute(int id,
                                       int shape)

Create an input attribute block. The pin is rendered on left side.

endInputAttribute

public static void endInputAttribute()

beginOutputAttribute
```
public static void beginOutputAttribute(int id)
```
Create an output attribute block. The pin is rendered on the right side.

beginOutputAttribute

public static void beginOutputAttribute(int id,
                                        int shape)

Create an output attribute block. The pin is rendered on the right side.

endOutputAttribute

public static void endOutputAttribute()

beginStaticAttribute
```
public static void beginStaticAttribute(int id)
```
Create a static attribute block. A static attribute has no pin, and therefore can't be linked to anything. However, you can still use IsAttributeActive() and IsAnyAttributeActive() to check for attribute activity.

endStaticAttribute

public static void endStaticAttribute()

pushAttributeFlag
```
public static void pushAttributeFlag(int flag)
```
Push a single AttributeFlags value. By default, only AttributeFlags_None is set.

popAttributeFlag
```
public static void popAttributeFlag()
```

link
```
public static void link(int id,
                        int source,
                        int target)
```
Render a link between attributes. The attributes ids used here must match the ids used in Begin(Input|Output)Attribute function calls. The order of source and target doesn't make a difference for rendering the link.

setNodeDraggable

public static void setNodeDraggable(int nodeId,
                                    boolean draggable)

Enable or disable the ability to click and drag a specific node.

setNodeScreenSpacePos

public static void setNodeScreenSpacePos(int nodeId,
                                         ImVec2 screenSpacePos)

setNodeScreenSpacePos

public static void setNodeScreenSpacePos(int nodeId,
                                         float screenSpacePosX,
                                         float screenSpacePosY)

setNodeEditorSpacePos

public static void setNodeEditorSpacePos(int nodeId,
                                         ImVec2 editorSpacePos)

setNodeEditorSpacePos

public static void setNodeEditorSpacePos(int nodeId,
                                         float editorSpacePosX,
                                         float editorSpacePosY)

setNodeGridSpacePos

public static void setNodeGridSpacePos(int nodeId,
                                       ImVec2 gridPos)

setNodeGridSpacePos

public static void setNodeGridSpacePos(int nodeId,
                                       float gridPosX,
                                       float gridPosY)

getNodeScreenSpacePos

public static void getNodeScreenSpacePos(int nodeId)

getNodeEditorSpacePos

public static void getNodeEditorSpacePos(int nodeId)

getNodeGridSpacePos

public static void getNodeGridSpacePos(int nodeId)

isEditorHovered
```
public static boolean isEditorHovered()
```
Returns true if the current node editor canvas is being hovered over by the mouse, and is not blocked by any other windows.

isNodeHovered

public static boolean isNodeHovered(ImInt nodeId)

isLinkHovered

public static boolean isLinkHovered(ImInt linkId)

isPinHovered

public static boolean isPinHovered(ImInt attributeId)

getHoveredNode
```
public static int getHoveredNode()
```
Returns:

id of the hovered node or -1 if there is no such object

getHoveredLink
```
public static int getHoveredLink()
```
Returns:

id of the hovered link or -1 if there is no such object

getHoveredPin
```
public static int getHoveredPin()
```
Returns:

id of the hovered pin or -1 if there is no such object

numSelectedNodes
```
public static int numSelectedNodes()
```
Use The following two functions to query the number of selected nodes or links in the current editor. Use after calling EndNodeEditor().

numSelectedLinks
```
public static int numSelectedLinks()
```

getSelectedNodes
```
public static void getSelectedNodes(int[] nodeIds)
```
Get the selected node/link ids. The pointer argument should point to an integer array with at least as many elements as the respective NumSelectedNodes/NumSelectedLinks function call returned.

getSelectedLinks
```
public static void getSelectedLinks(int[] linkIds)
```
Get the selected node/link ids. The pointer argument should point to an integer array with at least as many elements as the respective NumSelectedNodes/NumSelectedLinks function call returned.

clearNodeSelection
```
public static void clearNodeSelection()
```
Clears the list of selected nodes/links. Useful if you want to delete a selected node or link.

clearLinkSelection
```
public static void clearLinkSelection()
```
Clears the list of selected nodes/links. Useful if you want to delete a selected node or link.

selectNode

public static void selectNode(int nodeId)

Manually select a node or link.

clearNodeSelection

public static void clearNodeSelection(int nodeId)

isNodeSelected

public static boolean isNodeSelected(int nodeId)

selectLink

public static void selectLink(int linkId)

clearLinkSelection

public static void clearLinkSelection(int linkId)

isLinkSelected

public static boolean isLinkSelected(int linkId)

isAttributeActive
```
public static boolean isAttributeActive()
```
Was the previous attribute active? This will continuously return true while the left mouse button is being pressed over the UI content of the attribute.

isAnyAttributeActive

public static boolean isAnyAttributeActive()

isAnyAttributeActive

public static boolean isAnyAttributeActive(ImInt attributeId)

getActiveAttribute
```
public static int getActiveAttribute()
```
Binding notice: getActiveAttribute() returns id the active attribute. If there is no active attribute -1 will be returned.
This method implemented instead of the original bool ImNodes::IsAnyAttributeActive(int* attribute_id) for convenience.

isLinkStarted

public static boolean isLinkStarted(ImInt startedAtAttributeId)

Did the user start dragging a new link from a pin?

isLinkDropped
```
public static boolean isLinkDropped()
```
Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.

isLinkDropped
```
public static boolean isLinkDropped(ImInt startedAtAttributeId)
```
Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.

isLinkDropped
```
public static boolean isLinkDropped(ImInt startedAtAttributeId,
                                    boolean includingDetachedLinks)
```
Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.

isLinkDropped
```
public static boolean isLinkDropped(boolean includingDetachedLinks)
```
Did the user drop the dragged link before attaching it to a pin? There are two different kinds of situations to consider when handling this event: 1) a link which is created at a pin and then dropped 2) an existing link which is detached from a pin and then dropped Use the including_detached_links flag to control whether this function triggers when the user detaches a link and drops it.

isLinkCreated

public static boolean isLinkCreated(ImInt startedAtAttributeId,
                                    ImInt endedAtAttributeId)

Did the user finish creating a new link?

isLinkCreated

public static boolean isLinkCreated(ImInt startedAtAttributeId,
                                    ImInt endedAtAttributeId,
                                    ImBoolean createdFromSnap)

Did the user finish creating a new link?

isLinkCreated

public static boolean isLinkCreated(ImInt startedAtNodeId,
                                    ImInt startedAtAttributeId,
                                    ImInt endedAtNodeId,
                                    ImInt endedAtAttributeId)

Did the user finish creating a new link?

isLinkCreated

public static boolean isLinkCreated(ImInt startedAtNodeId,
                                    ImInt startedAtAttributeId,
                                    ImInt endedAtNodeId,
                                    ImInt endedAtAttributeId,
                                    ImBoolean createdFromSnap)

Did the user finish creating a new link?

isLinkDestroyed
```
public static boolean isLinkDestroyed(ImInt linkId)
```
Was an existing link detached from a pin by the user? The detached link's id is assigned to the output argument link_id.

saveCurrentEditorStateToIniString

public static java.lang.String saveCurrentEditorStateToIniString()

saveEditorStateToIniString

public static java.lang.String saveEditorStateToIniString(ImNodesEditorContext editor)

loadCurrentEditorStateFromIniString

public static void loadCurrentEditorStateFromIniString(java.lang.String data,
                                                       int dataSize)

loadEditorStateFromIniString

public static void loadEditorStateFromIniString(ImNodesEditorContext editor,
                                                java.lang.String data,
                                                int dataSize)

saveCurrentEditorStateToIniFile

public static void saveCurrentEditorStateToIniFile(java.lang.String fileName)

saveEditorStateToIniFile

public static void saveEditorStateToIniFile(ImNodesEditorContext editor,
                                            java.lang.String fileName)

loadCurrentEditorStateFromIniFile

public static void loadCurrentEditorStateFromIniFile(java.lang.String fileName)

loadEditorStateFromIniFile

public static void loadEditorStateFromIniFile(ImNodesEditorContext editor,
                                              java.lang.String fileName)

Class ImNodes

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setImGuiContext

createContext

destroyContext

destroyContext

getCurrentContext

setCurrentContext

editorContextCreate

editorContextFree

editorContextSet

editorContextGetPanning

editorContextGetPanningX

editorContextGetPanningY

editorContextGetPanning

editorContextResetPanning

editorContextResetPanning

editorContextMoveToNode

getIO

getStyle

styleColorsDark

styleColorsClassic

styleColorsLight

beginNodeEditor

endNodeEditor

miniMap

miniMap

miniMap

pushColorStyle

popColorStyle

pushStyleVar

pushStyleVar

pushStyleVar

popStyleVar

beginNode

endNode

getNodeDimensions

getNodeDimensionsX

getNodeDimensionsY

getNodeDimensions

beginNodeTitleBar

endNodeTitleBar

beginInputAttribute

beginInputAttribute

endInputAttribute

beginOutputAttribute

beginOutputAttribute

endOutputAttribute

beginStaticAttribute

endStaticAttribute

pushAttributeFlag

popAttributeFlag

link

setNodeDraggable

setNodeScreenSpacePos

setNodeScreenSpacePos

setNodeEditorSpacePos

setNodeEditorSpacePos

setNodeGridSpacePos

setNodeGridSpacePos

getNodeScreenSpacePos

getNodeEditorSpacePos

getNodeGridSpacePos

isEditorHovered

isNodeHovered

isLinkHovered

isPinHovered

getHoveredNode

getHoveredLink

getHoveredPin

numSelectedNodes

numSelectedLinks

getSelectedNodes

getSelectedLinks

clearNodeSelection

clearLinkSelection

selectNode

clearNodeSelection