OpenAlea Grapheditor's API

API

class openalea.grapheditor.base.GraphAdapterBase(graph=None)

Base class for adapter to graph

add_edge(source, target, *args, **kwargs)

Create an edge in the model between source and target.

Upon succes it must emit the following event tuple: ("edge_added", ("edge_type", edge, sourceObs, targetObs)).

• "edge-type" is a edge-type string defined in the strategy used for a particular graph type.
• edge, sourceObs and targetObs are the observable objects

representing an egde and its two anchors.

add_vertex(vertex, *args, **kwargs)

Add an existing vertex to the model.

Upon succes it must emit the following event tuple: ("vertex_added", ("vertex_type", vertex)).

• "vertex-type" is a vertex-type string defined in the strategy used for a particular graph type.
• "vertex" is the observable object representing a vertex.

classmethod get_edge_types()

Used by the GraphListenerBase class to check if the types declared here are really implemented in the strategy

get_vertex(vid=None)

Return the vertex object matching vid. By default this is just vid!

get_vertex_input(graphicalV, pid)

get_vertex_inputs(graphicalV)

get_vertex_output(graphicalV, pid)

get_vertex_outputs(graphicalV)

classmethod get_vertex_types()

Used by the GraphListenerBase class to check if the types declared here are really implemented in the strategy

is_input(input)

is_legal_connection(src, dst)

is_output(output)

is_vertex_protected(vertex)

new_vertex(vtype=None, position=None)

Create a new vertex at the defined position and add it to the model

remove_edge(source, target)

Removes the specified vertex from the model.

Upon success it must emit the following event tuple: ("edge_removed", (edge,)).

• edge is the observable object representing an edge.

remove_edges(edgeList)

Removes a list of vertices by forwarding them to self.remove_vertex

remove_vertex(vertex)

Removes the specified vertex from the model.

Upon success it must emit the following event tuple: ("vertex_removed", (vertex,)).

• vertex is the observable object representing a vertex.

remove_vertices(vertexList)

Removes a list of vertices by forwarding them to self.remove_vertex

replace_vertex(oldVertex, newVertex)

set_graph(graph)

openalea.grapheditor.base.GraphStrategyMaker(graphView, vertexWidgetMap, edgeWidgetMap, connectorTypes=, []graphViewInitialiser=None, adapterType=None)

Interfaces for the generic graph view module. The graph view widget won't check for inheritance of the object's it is passed. Instead, it will check the interfaces match more or less.

class openalea.grapheditor.interfaces.IGraphAdapter

add_edge(*args, **kargs)

add_vertex(*args, **kargs)

get_edge_types()

get_vertex(*args, **kargs)

get_vertex_input(*args, **kargs)

get_vertex_inputs(*args, **kargs)

get_vertex_output(*args, **kargs)

get_vertex_outputs(*args, **kargs)

get_vertex_types()

is_input(*args, **kargs)

is_output(*args, **kargs)

remove_edge(*args, **kargs)

remove_vertex(*args, **kargs)

remove_vertices(*args, **kargs)

class openalea.grapheditor.interfaces.IGraphListener

clear(*args, **kwargs)

edge_added(edgeModel, srcPort, dstPort)

edge_removed(edgeModel)

find_closest_connectable(*args, **kwargs)

initialise_from_model()

is_connectable(*args, **kwargs)

post_addition(*args, **kwargs)

vertex_added(vtype, vertexModel)

vertex_removed(vtype, vertexModel)

class openalea.grapheditor.interfaces.IGraphViewAnnotation

Interface for Annotations

notify(sender, event)

("metadata_changed", "text", "a string", str)

set_text(text)

to change the visible text

class openalea.grapheditor.interfaces.IGraphViewConnectable

Interface for connectable objects

get_scene_center()

set_highlighted(*args, **kwargs)

class openalea.grapheditor.interfaces.IGraphViewEdge

Interface for edges between two vertexs.

notify(sender, event)

("metadata_changed", "canvasPosition", [x,x], list)

update_line_destination(*pos)

updates this edge's ending point. Called when dest point is moved

update_line_source(*pos)

updates this edge's starting point. Called when source point is moved

class openalea.grapheditor.interfaces.IGraphViewElement

Base class for elements in a GraphView

add_to_view(view)

add this element to the graphical view

get_view_data(key)

initialise_from_model()

notify(sender, event)

called by the observed objects Expected event = ("metadata_changed", "position", [x,x], list)

position_changed(*args)

Place the element's representation in the view space

remove_from_view(view)

remove this element from the graphical view

store_view_data(**kwargs)

class openalea.grapheditor.interfaces.IGraphViewFloatingEdge(src)

Interface for edges to be drawn during creation time, ie while the user drags.

consolidate(model)

returns whatever object is under the mouse pointer at the time the button was released

get_connections(*args)

class openalea.grapheditor.interfaces.IGraphViewStrategies

Define implementations of this trait class to define the behaviour of the graph. For example : DataFlowGraphViewTrait, TreeGraphViewTrait, NetworkGraphViewTrait...

create_edge_widget(etype, *args, **kwargs)

Instanciates an edge matching etype

create_vertex_widget(vtype, *args, **kwargs)

Instanciates a node matching vtype

create_view(parent, graph, *args, **kwargs)

Instanciates the view

get_connector_types()

get_graph_model_type()

Returns the classobj defining the graph type

initialise_graph_view(graphView, graphModel)

intialise graph view from model

class openalea.grapheditor.interfaces.IGraphViewVertex

lock_position(val=True)

class openalea.grapheditor.interfaces.IInterfaceMetaClass(name, bases, dic)

Adds a method to the interface class that checks that the given object implements the class' interface. Allows some sort of safe-ducktyping

check(obj)

Check if obj matches this interface.

Class diagrams

Graphical edges and vertices

Scene

GraphElementListenerBase