ironflow.nodes.std.special_nodes module

class ironflow.nodes.std.special_nodes.Button_Node(params)

Bases: NodeBase

color = '#99dd55'

init_inputs: List[NodeInputBP] = []

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

main_widget_class = None

main_widget_pos = 'between ports'

title = 'Button'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Checkpoint_Node(params)

Bases: NodeBase

Provides a simple checkpoint to reroute your connections

add_output()

clear_ports()

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

make_active()

make_passive()

remove_output(index)

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

style = 'small'

title = 'checkpoint'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Clock_Node(params)

Bases: NodeBase

color = '#5d95de'

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>, <ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

main_widget_class = None

main_widget_pos = 'below ports'

remove_event()

Called when the node is removed from the flow; useful for stopping threads and timers etc.

start()

stop()

timeouted()

title = 'clock'

toggle()

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.DualNodeBase(params, active=True)

Bases: NodeBase

For nodes that can be active and passive

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

make_active()

make_passive()

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Eval_Node(params)

Bases: NodeBase

add_param_input()

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = []

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

main_widget_class = None

main_widget_pos = 'between ports'

place_event()

place_event() is called once the node object has been fully initialized and placed in the flow. When loading content, place_event() is executed before the connections are built, which is important for nodes that need to update once and, during this process, set output data values, to prevent later connected (potentially sequential) nodes from receiving false updates because of that. Notice that this method gets executed every time the node is added to the flow, which can happen multiple times for the same object, for example due to undo/redo operations. Also note that GUI content is usually not accessible yet from here, for that use view_place_event().

remove_param_input(index)

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'eval'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Exec_Node(params)

Bases: _DynamicPorts_Node

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

main_widget_class = None

main_widget_pos = 'between ports'

place_event()

place_event() is called once the node object has been fully initialized and placed in the flow. When loading content, place_event() is executed before the connections are built, which is important for nodes that need to update once and, during this process, set output data values, to prevent later connected (potentially sequential) nodes from receiving false updates because of that. Notice that this method gets executed every time the node is added to the flow, which can happen multiple times for the same object, for example due to undo/redo operations. Also note that GUI content is usually not accessible yet from here, for that use view_place_event().

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'exec'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Interpreter_Node(params)

Bases: NodeBase

Provides a python interpreter via a basic console with access to the node’s properties.

COMMANDS = {'clear': <function Interpreter_Node.clear>, 'reset': <function Interpreter_Node.reset>}

clear()

init_inputs: List[NodeInputBP] = []

init_outputs: List[NodeOutputBP] = []

main_widget_class = None

process_input(cmds: str)

reset()

title = 'interpreter'

version: str = 'v0.1'

write(line: str)

class ironflow.nodes.std.special_nodes.LinkIN_Node(params)

Bases: NodeBase

You can use link OUT nodes to link them up to this node. Whenever a link IN node receives data (or an execution signal), if there is a linked OUT node, it will receive the data and propagate it further.

INSTANCES = {}

add_inp()

copy_ID()

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = []

rem_inp(index)

remove_event()

Called when the node is removed from the flow; useful for stopping threads and timers etc.

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'link IN'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.LinkOUT_Node(params)

Bases: NodeBase

The complement to the link IN node

INSTANCES = []

PENDING_LINK_BUILDS = {}

add_out()

choose_link_ID()

opens a small input dialog for providing a copied link IN ID

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = []

init_outputs: List[NodeOutputBP] = []

link_to(n: LinkIN_Node)

classmethod new_link_in_loaded(n: LinkIN_Node)

rem_out(index)

remove_event()

Called when the node is removed from the flow; useful for stopping threads and timers etc.

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'link OUT'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Log_Node(params)

Bases: DualNodeBase

color = '#5d95de'

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>, <ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

main_widget_class = None

main_widget_pos = 'below ports'

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'Log'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.NodeBase(params)

Bases: Node

color = '#FFCA00'

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Print_Node(params)

Bases: DualNodeBase

color = '#5d95de'

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>, <ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

title = 'Print'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

class ironflow.nodes.std.special_nodes.Slider_Node(params)

Bases: NodeBase

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>, <ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

input_widget

alias of SliderControl

main_widget_class = None

main_widget_pos = 'below ports'

place_event()

place_event() is called once the node object has been fully initialized and placed in the flow. When loading content, place_event() is executed before the connections are built, which is important for nodes that need to update once and, during this process, set output data values, to prevent later connected (potentially sequential) nodes from receiving false updates because of that. Notice that this method gets executed every time the node is added to the flow, which can happen multiple times for the same object, for example due to undo/redo operations. Also note that GUI content is usually not accessible yet from here, for that use view_place_event().

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'slider'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'

view_place_event()

Called once all GUI for the node has been created by the frontend, if one exists. Any initial communication to widgets is supposed to happen here, and this method is not called when running without gui.

class ironflow.nodes.std.special_nodes.Storage_Node(params)

Bases: NodeBase

Sequentially stores all the data provided at the input in an array. A COPY of the storage array is provided at the output

clear()

color = '#aadd55'

get_state() → dict

Used to store node-specific custom data that needs to be reloaded when loading a project or pasting copied components. All values will be serialized by pickle and base64. The corresponding method for the opposite operation is set_state().

init_inputs: List[NodeInputBP] = [<ryvencore.NodePortBP.NodeInputBP object>]

init_outputs: List[NodeOutputBP] = [<ryvencore.NodePortBP.NodeOutputBP object>]

set_state(data: dict, version)

Used for reloading node-specific custom data which has been previously returned by get_state()

title = 'store'

update_event(inp=-1)

Gets called when an input received a signal or some node requested data of an output in exec mode

version: str = 'v0.1'