imgui.extension.imnodes

Class ImNodes

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

Modifier and Type	Method and Description
static void	beginInputAttribute(int id) Create an input attribute block.
static void	beginInputAttribute(int id, int imNodesPinShape)
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 imNodesPinShape)
static void	beginStaticAttribute(int id) Create a static attribute block.
static void	clearLinkSelection()
static void	clearNodeSelection() Clears the list of selected nodes/links.
static void	createContext() Initialize the node editor system.
static void	destroyContext()
static ImNodesContext	editorContextCreate()
static void	editorContextFree(ImNodesContext context)
static void	editorContextGetPanning(ImVec2 result)
static void	editorContextSet(ImNodesContext context)
static void	editorMoveToNode(int node)
static void	editorResetPanning(float x, float y)
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 int	getHoveredLink()
static int	getHoveredNode()
static int	getHoveredPin()
static void	getNodeDimensions(int node, ImVec2 result)
static float	getNodeDimensionsX(int node)
static float	getNodeDimensionsY(int node)
static void	getNodeEditorSpacePos(int node, ImVec2 result)
static float	getNodeEditorSpacePosX(int node)
static float	getNodeEditorSpacePosY(int node)
static void	getNodeGridSpacePos(int node, ImVec2 dst)
static float	getNodeGridSpacePosX(int node)
static float	getNodeGridSpacePosY(int node)
static void	getNodeScreenSpacePos(int node, ImVec2 result)
static float	getNodeScreenSpacePosX(int node)
static float	getNodeScreenSpacePosY(int node)
static void	getSelectedLinks(int[] linkIds)
static void	getSelectedNodes(int[] nodeIds) Get the selected node/link ids.
static ImNodesStyle	getStyle() Returns the global style struct.
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 startedAtNodeId, ImInt startedAtAttributeId, ImInt endedAtNodeId, ImInt endedAtAttributeId, ImBoolean createdFromSnap)
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(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	isLinkStarted(ImInt startAtAttributeId) Did the user start dragging a new link from a pin?
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(ImNodesContext context, java.lang.String fileName)
static void	loadEditorStateFromIniString(ImNodesContext context, java.lang.String data, int dataSize)
static void	miniMap(float miniMapSizeFraction, int miniMapLocation)
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	popColorStyle()
static void	popStyleVar()
static void	pushAttributeFlag(int imNodesAttributeFlags) Push a single AttributeFlags value.
static void	pushColorStyle(int imNodesStyleColor, int color) Use PushColorStyle and PopColorStyle to modify ImNodesColorStyle mid-frame.
static void	pushStyleVar(int imNodesStyleVar, float value)
static void	saveCurrentEditorStateToIniFile(java.lang.String fileName)
static java.lang.String	saveCurrentEditorStateToIniString()
static void	saveEditorStateToIniFile(ImNodesContext context, java.lang.String fileName)
static java.lang.String	saveEditorStateToIniString(ImNodesContext context)
static void	setNodeDraggable(int node, boolean isDraggable) Enable or disable the ability to click and drag a specific node.
static void	setNodeEditorSpacePos(int node, float x, float y)
static void	setNodeGridSpacePos(int node, float x, float y)
static void	setNodeScreenSpacePos(int node, float x, float y)
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

editorContextCreate

public static ImNodesContext editorContextCreate()

editorContextFree

public static void editorContextFree(ImNodesContext context)

editorContextSet

public static void editorContextSet(ImNodesContext context)

createContext

public static void createContext()

Initialize the node editor system.

destroyContext

public static void destroyContext()

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()

pushColorStyle

public static void pushColorStyle(int imNodesStyleColor,
                                  int color)

Use PushColorStyle and PopColorStyle to modify ImNodesColorStyle mid-frame.

popColorStyle

public static void popColorStyle()

pushStyleVar

public static void pushStyleVar(int imNodesStyleVar,
                                float value)

popStyleVar

public static void popStyleVar()

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()

beginNode

public static void beginNode(int node)

endNode

public static void endNode()

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.

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()

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()

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 imNodesPinShape)

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 imNodesPinShape)

pushAttributeFlag

public static void pushAttributeFlag(int imNodesAttributeFlags)

Push a single AttributeFlags value. By default, only AttributeFlags_None is set.

endOutputAttribute

public static void endOutputAttribute()

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.

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

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.

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.

isLinkStarted

public static boolean isLinkStarted(ImInt startAtAttributeId)

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

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.

isLinkCreated

public static boolean isLinkCreated(ImInt startedAtAttributeId,
                                    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)

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.

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)

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()

setNodeDraggable

public static void setNodeDraggable(int node,
                                    boolean isDraggable)

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

getNodeDimensions

public static void getNodeDimensions(int node,
                                     ImVec2 result)

getNodeDimensionsX

public static float getNodeDimensionsX(int node)

getNodeDimensionsY

public static float getNodeDimensionsY(int node)

setNodeScreenSpacePos

public static void setNodeScreenSpacePos(int node,
                                         float x,
                                         float y)

setNodeEditorSpacePos

public static void setNodeEditorSpacePos(int node,
                                         float x,
                                         float y)

setNodeGridSpacePos

public static void setNodeGridSpacePos(int node,
                                       float x,
                                       float y)

getNodeScreenSpacePos

public static void getNodeScreenSpacePos(int node,
                                         ImVec2 result)

getNodeScreenSpacePosX

public static float getNodeScreenSpacePosX(int node)

getNodeScreenSpacePosY

public static float getNodeScreenSpacePosY(int node)

getNodeEditorSpacePos

public static void getNodeEditorSpacePos(int node,
                                         ImVec2 result)

getNodeEditorSpacePosX

public static float getNodeEditorSpacePosX(int node)

getNodeEditorSpacePosY

public static float getNodeEditorSpacePosY(int node)

getNodeGridSpacePos

public static void getNodeGridSpacePos(int node,
                                       ImVec2 dst)

getNodeGridSpacePosX

public static float getNodeGridSpacePosX(int node)

getNodeGridSpacePosY

public static float getNodeGridSpacePosY(int node)

editorResetPanning

public static void editorResetPanning(float x,
                                      float y)

editorContextGetPanning

public static void editorContextGetPanning(ImVec2 result)

editorMoveToNode

public static void editorMoveToNode(int node)

saveCurrentEditorStateToIniString

public static java.lang.String saveCurrentEditorStateToIniString()

saveEditorStateToIniString

public static java.lang.String saveEditorStateToIniString(ImNodesContext context)

loadCurrentEditorStateFromIniString

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

loadEditorStateFromIniString

public static void loadEditorStateFromIniString(ImNodesContext context,
                                                java.lang.String data,
                                                int dataSize)

saveCurrentEditorStateToIniFile

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

saveEditorStateToIniFile

public static void saveEditorStateToIniFile(ImNodesContext context,
                                            java.lang.String fileName)

loadCurrentEditorStateFromIniFile

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

loadEditorStateFromIniFile

public static void loadEditorStateFromIniFile(ImNodesContext context,
                                              java.lang.String fileName)

miniMap

public static void miniMap(float miniMapSizeFraction,
                           int miniMapLocation)