UI_Panels_Widgets.md

graph LR
    NodesPalette["NodesPalette"]
    PropertiesBin["PropertiesBin"]
    NodePropEditorWidget["NodePropEditorWidget"]
    CustomPropertyWidget["CustomPropertyWidget"]
    PropWidgetsBase["PropWidgetsBase"]
    NodeGraphQt_Core["NodeGraphQt Core"]
    NodesPalette -- "queries" --> NodeGraphQt_Core
    NodesPalette -- "signals" --> NodeGraphQt_Core
    PropertiesBin -- "listens to" --> NodeGraphQt_Core
    PropertiesBin -- "requests data from" --> NodeGraphQt_Core
    PropertiesBin -- "updates" --> NodeGraphQt_Core
    PropertiesBin -- "instantiates" --> NodePropEditorWidget
    NodePropEditorWidget -- "composes" --> CustomPropertyWidget
    CustomPropertyWidget -- "inherits from" --> PropWidgetsBase
    CustomPropertyWidget -- "notifies" --> PropertiesBin

Loading

Details

The UI Panels & Widgets subsystem in NodeGraphQt is responsible for providing auxiliary user interface elements that complement the main graph view, enabling user interaction for node creation and property editing.

NodesPalette

Acts as a view and controller for browsing and creating new nodes. It organizes available node types, typically in a categorized or searchable list, and initiates the creation of new nodes in the graph.

Related Classes/Methods:

• NodeGraphQt.custom_widgets.nodes_palette.NodesPalette:165-346

PropertiesBin

Functions as a dynamic view and controller for displaying and editing properties of selected nodes. It adapts its content based on the properties of the currently active node.

Related Classes/Methods:

• NodeGraphQt.custom_widgets.properties_bin.node_property_widgets.PropertiesBin:609-893

NodePropEditorWidget

A specific wrapper widget used by PropertiesBin to encapsulate and manage a single property's UI, including its label and the actual CustomPropertyWidget.

Related Classes/Methods:

• NodeGraphQt.custom_widgets.properties_bin.node_property_widgets.NodePropEditorWidget:298-606

CustomPropertyWidget

Concrete implementations of UI controls for specific data types (e.g., string, integer, boolean, color, file path). These are the actual interactive elements where users modify property values.

Related Classes/Methods:

• NodeGraphQt.custom_widgets.properties_bin.node_property_widgets.CustomPropertyWidget:1-9999

PropWidgetsBase

An abstract base class that defines the common interface and foundational functionalities for all individual property editor widgets. It ensures consistency across various property types.

Related Classes/Methods:

• NodeGraphQt.custom_widgets.properties_bin.prop_widgets_base.PropWidgetsBase:1-9999

NodeGraphQt Core

The core component of NodeGraphQt, responsible for managing graph data, node selection, and providing data to UI components.

Related Classes/Methods:

• NodeGraphQt:1-9999

FAQ