NodeObject

class NodeGraphQt.NodeObject(qgraphics_item=None)

The NodeGraphQt.NodeObject class is the main base class that all nodes inherit from.

Inheritance diagram of NodeGraphQt.NodeObject

Parameters:: qgraphics_item (AbstractNodeItem) – QGraphicsItem item used for drawing.

Attributes:

`__identifier__`	Unique node identifier domain.
`NODE_NAME`	Initial base node name.
`type_`
`id`	The node unique id.
`graph`	The parent node graph.
`view`	Returns the `QtWidgets.QGraphicsItem` used in the scene.
`model`	Return the node model.

Methods:

`set_view`(item)	Set a new `QGraphicsItem` item to be used as the view.
`set_model`(model)	Set a new model to the node model.
`update_model`()	Update the node model from view.
`update`()	Update the node view from model.
`serialize`()	Serialize node model to a dictionary.
`name`()	Name of the node.
`set_name`([name])	Set the name of the node.
`color`()	Returns the node color in (red, green, blue) value.
`set_color`([r, g, b])	Sets the color of the node in (red, green, blue) value.
`disabled`()	Returns whether the node is enabled or disabled.
`set_disabled`([mode])	Set the node state to either disabled or enabled.
`selected`()	Returns the selected state of the node.
`set_selected`([selected])	Set the node to be selected or not selected.
`create_property`(name, value[, items, range, ...])	Creates a custom property to the node.
`properties`()	Returns all the node properties.
`get_property`(name)	Return the node custom property.
`set_property`(name, value[, push_undo])	Set the value on the node custom property.
`has_property`(name)	Check if node custom property exists.
`set_x_pos`(x)	Set the node horizontal X position in the node graph.
`set_y_pos`(y)	Set the node horizontal Y position in the node graph.
`set_pos`(x, y)	Set the node X and Y position in the node graph.
`x_pos`()	Get the node X position in the node graph.
`y_pos`()	Get the node Y position in the node graph.
`pos`()	Get the node XY position in the node graph.
`layout_direction`()	Returns layout direction for this node.
`set_layout_direction`([value])	Sets the node layout direction to either horizontal or vertical on the current node only.

__identifier__

Unique node identifier domain. eg. "io.github.jchanvfx"

Important

re-implement this attribute to provide a unique node type.

from NodeGraphQt import NodeObject

class ExampleNode(NodeObject):

    # unique node identifier domain.
    __identifier__ = 'io.github.jchanvfx'

    def __init__(self):
        ...

Returns:: node type domain.
Return type:: str

NODE_NAME

Initial base node name.

Important

re-implement this attribute to provide a base node name.

from NodeGraphQt import NodeObject

class ExampleNode(NodeObject):

    # initial default node name.
    NODE_NAME = 'Example Node'

    def __init__(self):
        ...

Returns:: node name
Return type:: str

type_ = 'nodeGraphQt.nodes.NodeObject'

property id

The node unique id.

Returns:: unique identifier string to the node.
Return type:: str

property graph

The parent node graph.

Returns:: node graph instance.
Return type:: NodeGraphQt.NodeGraph

property view

Returns the QtWidgets.QGraphicsItem used in the scene.

Returns:: node item.
Return type:: NodeGraphQt.qgraphics.node_abstract.AbstractNodeItem

set_view(item)

Set a new QGraphicsItem item to be used as the view. (the provided qgraphics item must be subclassed from the AbstractNodeItem object.)

Parameters:: item (NodeGraphQt.qgraphics.node_abstract.AbstractNodeItem) – node item.

property model

Return the node model.

Returns:: node model object.
Return type:: NodeGraphQt.base.model.NodeModel

set_model(model)

Set a new model to the node model. (Setting a new node model will also update the views qgraphics item.)

Parameters:: model (NodeGraphQt.base.model.NodeModel) – node model object.

update_model(): Update the node model from view.

update(): Update the node view from model.

serialize()

Serialize node model to a dictionary.

example:

{'0x106cf75a8': {
    'name': 'foo node',
    'color': (48, 58, 69, 255),
    'border_color': (85, 100, 100, 255),
    'text_color': (255, 255, 255, 180),
    'type': 'io.github.jchanvfx.MyNode',
    'selected': False,
    'disabled': False,
    'visible': True,
    'inputs': {
        <port_name>: {<node_id>: [<port_name>, <port_name>]}
    },
    'outputs': {
        <port_name>: {<node_id>: [<port_name>, <port_name>]}
    },
    'input_ports': [<port_name>, <port_name>],
    'output_ports': [<port_name>, <port_name>],
    'width': 0.0,
    'height: 0.0,
    'pos': (0.0, 0.0),
    'layout_direction': 0,
    'custom': {},
    }
}

Returns:: serialized node
Return type:: dict

name()

Name of the node.

Returns:: name of the node.
Return type:: str

set_name(name='')

Set the name of the node.

Parameters:: name (str) – name for the node.

color()

Returns the node color in (red, green, blue) value.

Returns:: (r, g, b) from 0-255 range.
Return type:: tuple

set_color(r=0, g=0, b=0)

Sets the color of the node in (red, green, blue) value.

Parameters:

r (int) – red value 0-255 range.
g (int) – green value 0-255 range.
b (int) – blue value 0-255 range.

disabled()

Returns whether the node is enabled or disabled.

Returns:: True if the node is disabled.
Return type:: bool

set_disabled(mode=False)

Set the node state to either disabled or enabled.

Parameters:: mode (bool) – True to disable node.

selected()

Returns the selected state of the node.

Returns:: True if the node is selected.
Return type:: bool

set_selected(selected=True)

Set the node to be selected or not selected.

Parameters:: selected (bool) – True to select the node.

create_property(name, value, items=None, range=None, widget_type=None, widget_tooltip=None, tab=None)

Creates a custom property to the node.