Reference guide

Class Inheritance diagram

openalea.visualea.code_editor module

Download the source file ../../src/openalea/visualea/code_editor.py.

Python code editor

class openalea.visualea.code_editor.AbstractCodeEditor(*args)

Bases: object

External code editor

edit_file(filename)

Open file in the editor

edit_module(module, class_name=None)

Edit the source file of a python module

is_empty()

is_widget()

class openalea.visualea.code_editor.Command(command)

Bases: object

Execute a command depending on a filename. Create a process and execute the command locally.

class openalea.visualea.code_editor.EditorSelector(parent, editors, params)

Bases: AbstractCodeEditor, QWidget

Dialog to select an editor

is_widget()

on_button_clicked()

class openalea.visualea.code_editor.ExternalCodeEditor(*args)

Bases: AbstractCodeEditor

External code editor

edit_file(filename)

Open file in the editor

get_command()

Return command to execute

is_widget()

class openalea.visualea.code_editor.NodeCodeEditor(factory, parent=None)

Bases: PythonCodeEditor

Default node editor

apply_changes()

Apply

edit_class(nodefactory)

Open class source in editor

save_changes()

Save module

class openalea.visualea.code_editor.PythonCodeEditor(parent=None)

Bases: QWidget, AbstractCodeEditor

Simple Python code editor

apply_changes()

Reload file

edit_file(filename)

Open file in the editor

edit_module(module, class_name=None)

Edit the source file of a python module

getText()

Return editor text

get_editor()

Return an editor object based on QScintilla if available. Else, return a standard editor.

goToLine(linenb)

Go to line nb

is_widget()

on_file_changed(path)

save_changes()

Save module

setText(str)

Set the text of the editor

openalea.visualea.code_editor.get_editor()

Return the editor class

openalea.visualea.compositenode_widget module

Download the source file ../../src/openalea/visualea/compositenode_widget.py.

Composite Node Widgets

class openalea.visualea.compositenode_widget.DisplayGraphWidget(node, parent=None, autonomous=False)

Bases: NodeWidget, QWidget

Display widgets contained in the graph

exit()

open_widget()

run_node()

set_autonomous()

Create autonomous widget with user applications buttons and dataflow

openalea.visualea.dialogs module

Download the source file ../../src/openalea/visualea/dialogs.py.

QT4 Main window

class openalea.visualea.dialogs.ComboDelegate

Bases: QItemDelegate

Tool class used in IO editor It allows to choose an interface from a combobox in a QTable

createEditor(parent, option, index)

Create the editor

get_interfaces()

Return the list of availble interfaces

setEditorData(editor, index)

Accessor

setModelData(editor, model, index)

Accessor

class openalea.visualea.dialogs.DictEditor(pdict, parent)

Bases: QDialog, Ui_TableEditor

Dictionnary editor (used for node internals)

If accepted :

• self.pdict contains the modified dictionary

• self.modified_key contains the list of modified key

accept(self)

class openalea.visualea.dialogs.EditPackage(package, parent=None)

Bases: NewPackage

Edit package dialog

accept()

Accept dialog result

class openalea.visualea.dialogs.FactorySelector(default_factory=None, parent=None)

Bases: QDialog, Ui_FactorySelector

Dialog to select a particular CompositeNode factory

accept()

Accept dialog result

get_factory()

Return the selected factory

new_factory()

Create a new composite node

class openalea.visualea.dialogs.IOConfigDialog(inputs=(), outputs=(), parent=None)

Bases: QDialog, Ui_IOConfig

IO Configuration dialog

accept()

Valid IO

add_input()

add_output()

del_input()

del_output()

class openalea.visualea.dialogs.NewData(title, pmanager, parent=None, pkg_id=None)

Bases: QDialog, Ui_NewDataDialog

import data dialog

accept()

Accept Dialog result

browse_file()

Open File browser

create_datafactory(pkgmanager)

Create, register and return a new CompositeNodeFactory

get_data()

Return the dialog data in a tuple (name, nin, nout, category, description)

get_package()

Return the selected package

class openalea.visualea.dialogs.NewGraph(title, pmanager, parent=None, factory=None, io=True, inputs=(), outputs=(), pkg_id=None, name='')

Bases: QDialog, Ui_NewGraphDialog

New composite node dialog

accept()

Accept Dialog result

create_cnfactory(pkgmanager)

Create, register and return a new CompositeNodeFactory

create_nodefactory(pkgmanager)

Create, register and return a NodeFactory

edit_io()

Open IO Config Dialog

get_data()

Return the dialog data in a tuple (name, nin, nout, category, description)

get_package()

Return the selected package

update_factory()

Update factory with value

class openalea.visualea.dialogs.NewPackage(pkgs, name='', parent=None, metainfo=None)

Bases: QDialog, Ui_NewPackageDialog

New package dialog

accept()

Accept dialog result

get_data()

Return a tuple (name, metainfo, path) metainfo is a dictionnary

path_clicked()

set_data(name, path, metainfo)

Set the dialog data

class openalea.visualea.dialogs.NodeChooser(parent)

Bases: QDialog, Ui_NodeChooser

Dialog allowing to choose a node (package view)

accept()

Validate result

get_selection()

Return selected factory

search(name='', nb_inputs=-1, nb_outputs=-1)

Add node to combo box selector corresponding to request @param name @param nb_inputs @param nb_outputs

class openalea.visualea.dialogs.PreferenceNode(inputs=(), outputs=())

Bases: Node

class openalea.visualea.dialogs.PreferencesDialog(parent)

Bases: QDialog, Ui_Preferences

Preferences dialog

accept()

Validate dialog results

add_search_path()

Package Manager : Add a path in the list

build_gui_for_component(componentName, conf)

remove_search_path()

Package Manager : Remove a path in the list

select_editor()

Select Python Editor command

valid_editor()

Valid editor parameter

valid_search_path()

Set the search path in the package manager

valid_ui()

Valid UI Parameters

class openalea.visualea.dialogs.ShowPortDialog(node, parent)

Bases: QDialog, Ui_ListEdit

Port show status configuration dialog

accept()

Set port status in the node

openalea.visualea.graph_operator.port module

class openalea.visualea.graph_operator.port.PortOperators(master)

Bases: Base

The PortOperators defines the output options of an output connector.

An output connector can be sent to

• the datapool,

• the python interpreter

• or print

by right clicking on the output connector and selected the appropriate option, as shown on this screenshot.

port_print_value()

Print the value of the connector

port_send_to_console()

a portconnector to send output on a port directly to the console. :authors: Thomas Cokelaer, Daniel Barbeau

port_send_to_pool()

Send data from a connector to the dataflow

This function is related to the menu that pops up when right clicking on a node.

See also

openalea.visualea.dataflowview.vertex.GraphicalPort

openalea.visualea.dataflowview.vertex module

class openalea.visualea.dataflowview.vertex.EvalObserver(callback)

Bases: AbstractListener

notify(sender, event)

This function is called by observed objects

Parameters:

• sender – the observed object which send notification

• event – the data associated to the notification

class openalea.visualea.dataflowview.vertex.GraphicalInVertex(vertex, graph, parent=None)

Bases: GraphicalVertex

initialise_from_model()

polishEvent()

class openalea.visualea.dataflowview.vertex.GraphicalOutVertex(vertex, graph, parent=None)

Bases: GraphicalVertex

initialise_from_model()

polishEvent()

class openalea.visualea.dataflowview.vertex.GraphicalPort(parent, port)

Bases: QGraphicsEllipseItem, Connector

A vertex port

HEIGHT = 7.0

MAX_TIPLEN = 400

WIDTH = 7.0

change_observed(old, new)

clear_observed(*args)

close_and_delete(obj)

contextMenuEvent(self, event: QGraphicsSceneContextMenuEvent | None)

get_id()

initialise_from_model()

itemChange(self, change: QGraphicsItem.GraphicsItemChange, value: Any) → Any

notify(sender, event)

called by the observed when something happens to it.

paint(self, painter: QPainter | None, option: QStyleOptionGraphicsItem | None, widget: QWidget | None = None)

port()

class openalea.visualea.dataflowview.vertex.GraphicalVertex(vertex, graph, parent=None)

Bases: ObserverOnlyGraphicalVertex

contextMenuEvent(event)

Context menu event : Display the menu

mouseDoubleClickEvent(self, event: QGraphicsSceneMouseEvent | None)

class openalea.visualea.dataflowview.vertex.HiddenPort(parent)

Bases: QGraphicsItem

Graphical representation of hidden ports

add_to_view(view)

boundingRect(self) → QRectF

get_id()

initialise_from_model()

paint(self, painter: QPainter | None, option: QStyleOptionGraphicsItem | None, widget: QWidget | None = None)

size()

sizeHint(blop, blip)

class openalea.visualea.dataflowview.vertex.ObserverOnlyGraphicalVertex(vertex, graph, parent=None)

Bases: Vertex, AleaQGraphicsRoundedRectItem

add_port(modelPort)

all_inputs_visible()

default_bottom_color = <PyQt5.QtGui.QColor object>

default_corner_radius = 1.2

default_error_color = <PyQt5.QtGui.QColor object>

default_margin = 3.0

default_pen_color = <PyQt5.QtGui.QColor object>

default_pen_error_color = <PyQt5.QtGui.QColor object>

default_pen_selected_color = <PyQt5.QtGui.QColor object>

default_top_color = <PyQt5.QtGui.QColor object>

default_unlazy_color = <PyQt5.QtGui.QColor object>

default_user_application_color = <PyQt5.QtGui.QColor object>

delayMargins = 7.0

endPos = 1.0

evalColor = <PyQt5.QtGui.QColor object>

get_editor_instance()

get_view_data(key)

initialise_from_model()

itemChange(change, value)

Used mainly to capture position changes from the QGraphicsScene and store it in the model so that it can be saved.

layout_items()

maxTipLength = 400

mousePressEvent(self, event: QGraphicsSceneMouseEvent | None)

notify(sender, event)

Notification sent by the vertex associated to the item

outMargins = 5.0

paint(painter, options, widget)

Qt-specific call to paint things.

pen_width = 1.0

portSpacing = 5.0

refresh_geometry()

remove_port(modelPort)

remove_ports(filter=<function ObserverOnlyGraphicalVertex.<lambda>>)

set_editor_instance(editor)

set_graphical_caption(caption)

Sets the name displayed in the vertex widget, doesn’t change the vertex data

set_graphical_tooltip(rawtooltip)

startPos = 0.0

store_view_data(**kwargs)

terminate_from_model()

update_colors()

update_delay_item()

update_hidden_port_item()

openalea.visualea.gui_catalog module

Catalog of InterfaceWidgets

class openalea.visualea.gui_catalog.IBoolWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

integer spin box widget

notify(sender, event)

Notification sent by node

on_stateChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.ICodeStrWidget(node, parent, parameter_str, interface)

Bases: ITextStrWidget

notify(sender, event)

Notification sent by node

valueChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.IDateTimeWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

Date widget

notify(sender, event)

Notification sent by node

on_valueChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.IDictWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

List edit widget

keyPressEvent(self, a0: QKeyEvent | None)

notify(sender, event)

Notification sent by node

on_button_clicked(*args, **kwargs)

on_itemclick(*args, **kwargs)

update_list()

Rebuild the list

update_state()

Enable or disable widget depending of its state

class openalea.visualea.gui_catalog.IDirStrWidget(node, parent, parameter_str, interface)

Bases: IStrWidget

File name Line Edit Widget

last_result = '/home/docs'

on_button_clicked()

on_valueChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.IEnumStrWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

String Enumeration widget

get_widget_value()

notify(sender, event)

Notification sent by node

set_interface(interface)

set_widget_value(newval)

valueChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.IFileStrWidget(node, parent, parameter_str, interface)

Bases: IStrWidget

File name Line Edit Widget

last_result = '/home/docs'

on_button_clicked()

on_valueChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.IFloatWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

Float spin box widget

get_widget_value()

notify(sender, event)

Notification sent by node

on_valueChanged(*args, **kwargs)

set_interface(interface)

set_widget_value(newval)

class openalea.visualea.gui_catalog.IIntWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

integer spin box widget

notify(sender, event)

Notification sent by node

on_valueChanged(*args, **kwargs)

class openalea.visualea.gui_catalog.IRGBColorWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

RGB Color Widget

notify(*args, **kwargs)

Notification sent by node

widget_clicked(event)

class openalea.visualea.gui_catalog.ISequenceWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

List edit widget

get_widget_value()

keyPressEvent(self, a0: QKeyEvent | None)

notify(sender, event)

Notification sent by node

on_button_clicked(*args, **kwargs)

on_buttonmoins_clicked(*args, **kwargs)

on_buttonplus_clicked(*args, **kwargs)

on_itemchanged(*args, **kwargs)

on_itemclick(item)

set_widget_value(seq)

update_list(*args, **kwargs)

update_state()

Enable or disable widget depending of its state

class openalea.visualea.gui_catalog.IStrWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

Line Edit widget

MAX_LEN = 100000

get_widget_value()

notify(sender, event)

Notification sent by node

on_valueChanged(*args, **kwargs)

set_widget_value(newval)

class openalea.visualea.gui_catalog.ITextStrWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

Multi-Line Edit widget

MAX_LEN = 1000000

notify(sender, event)

Notification sent by node

on_valueChanged(*args, **kwargs)

setEnabled(self, a0: bool)

class openalea.visualea.gui_catalog.ITupleWidget(node, parent, parameter_str, interface)

Bases: IInterfaceWidget, QWidget

Tuple widget

notify(sender, event)

Notification sent by node

on_valueChanged(*args, **kwargs)

openalea.visualea.gui_catalog.isiterable(seq)

openalea.visualea.images_rc module

Download the source file ../../src/openalea/visualea/images_rc.py.

openalea.visualea.images_rc.qCleanupResources()

openalea.visualea.images_rc.qInitResources()