PropertiesBinWidget

NodeGraphQt.PropertiesBinWidget([parent, ...])

The NodeGraphQt.PropertiesBinWidget is a list widget for displaying and editing a nodes properties.

class NodeGraphQt.PropertiesBinWidget(parent=None, node_graph=None)

The NodeGraphQt.PropertiesBinWidget is a list widget for displaying and editing a nodes properties.

Inheritance diagram of NodeGraphQt.PropertiesBinWidget
../_images/prop_bin.png
1from NodeGraphQt import NodeGraph, PropertiesBinWidget
2
3# create node graph.
4graph = NodeGraph()
5
6# create properties bin widget.
7properties_bin = PropertiesBinWidget(parent=None, node_graph=graph)
8properties_bin.show()
Parameters:
  • parent (QtWidgets.QWidget) – parent of the new widget.

  • node_graph (NodeGraphQt.NodeGraph) – node graph.

Attributes:

property_changed(*args, **kwargs)

Signal emitted (node_id, prop_name, prop_value)

Methods:

create_property_editor(node)

Creates a new property editor widget from the provided node.

limit()

Returns the limit for how many nodes can be loaded into the bin.

set_limit(limit)

Set limit of nodes to display.

add_node(node)

Add node to the properties bin.

remove_node(node)

Remove node from the properties bin.

lock_bin()

Lock/UnLock the properties bin.

clear_bin()

Clear the properties bin.

get_property_editor_widget(node)

Returns the node property editor widget.

property_changed(*args, **kwargs)

Signal emitted (node_id, prop_name, prop_value)

create_property_editor(node)

Creates a new property editor widget from the provided node.

(re-implement for displaying custom node property editor widget.)

Parameters:

node (NodeGraphQt.NodeObject) – node object.

Returns:

property editor widget.

Return type:

NodePropEditorWidget

limit()

Returns the limit for how many nodes can be loaded into the bin.

Returns:

node limit.

Return type:

int

set_limit(limit)

Set limit of nodes to display.

Parameters:

limit (int) – node limit.

add_node(node)

Add node to the properties bin.

Parameters:

node (NodeGraphQt.NodeObject) – node object.

remove_node(node)

Remove node from the properties bin.

Parameters:

node (str or NodeGraphQt.BaseNode) – node id or node object.

lock_bin()

Lock/UnLock the properties bin.

clear_bin()

Clear the properties bin.

get_property_editor_widget(node)

Returns the node property editor widget.

Parameters:

node (str or NodeGraphQt.NodeObject) – node id or node object.

Returns:

node property editor widget.

Return type:

NodePropEditorWidget