Org.simantics.diagram - Revision history

Tuukka Lehtonen: /* Creating new connection types */

2016-12-18T16:40:59Z

Creating new connection types

← Older revision		Revision as of 16:40, 18 December 2016
Line 136:		Line 136:

	To create new element types (classes) and to load them into a diagram from the graph, the following is needed:		To create new element types (classes) and to load them into a diagram from the graph, the following is needed:
	# Define the new element types in your own ontology. New elements ~~must~~ extend ''[[trac:browser/2d/trunk/2d_ontologies/diagram2.graph#L186\|DIAGRAM.Connection]]''.		# Define the new element types in your own ontology. New elements can extend ''[[trac:browser/2d/trunk/2d_ontologies/diagram2.graph#L186\|DIAGRAM.Connection]]'' but it is not absolutely necessary.
	# Define [[Resource Adaptation\|resource adapters]] for:		# Define [[Resource Adaptation\|resource adapters]] for:
	#* defining an [[org.simantics.g2d#Element_Class\|ElementClass]] for your connections		#* defining an [[org.simantics.g2d#Element_Class\|ElementClass]] for your connections

Tuukka Lehtonen: /* Interfaces */

2011-09-15T23:14:59Z

Interfaces

← Older revision		Revision as of 23:14, 15 September 2011
Line 56:		Line 56:
	{{interface\|[[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/synchronization/graph/ElementWriter.java\|ElementWriter]]\|An interface that an element instance must be adaptable to through [[Resource Adaptation]] if it needs to do any custom writing to add or remove itself to/from the graph database. In this case custom means anything else besides the plain old HasTransform property.}}		{{interface\|[[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/synchronization/graph/ElementWriter.java\|ElementWriter]]\|An interface that an element instance must be adaptable to through [[Resource Adaptation]] if it needs to do any custom writing to add or remove itself to/from the graph database. In this case custom means anything else besides the plain old HasTransform property.}}

	{{interface\|[[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/~~sychronization~~/IHintSynchronizer.java\|IHintSynchronizer]]\|A hint synchronizer is responsible for reflecting the hint values of an element into the back-end system. ''GraphElementFactory'' implementations are responsible for setting the synchronizer in elements if necessary using the [[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/synchronization/SynchronizationHints.java\|SynchronizationHints.HINT_SYNCHRONIZER]] key.}}		{{interface\|[[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/synchronization/IHintSynchronizer.java\|IHintSynchronizer]]\|A hint synchronizer is responsible for reflecting the hint values of an element into the back-end system. ''GraphElementFactory'' implementations are responsible for setting the synchronizer in elements if necessary using the [[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/synchronization/SynchronizationHints.java\|SynchronizationHints.HINT_SYNCHRONIZER]] key.}}

	=== Loading a diagram ===		=== Loading a diagram ===

Tuukka Lehtonen: /* How It Works */

2011-09-15T22:51:31Z

How It Works

← Older revision		Revision as of 22:51, 15 September 2011
Line 30:		Line 30:
	== How It Works ==		== How It Works ==

	[[Image:Diagram_Dataflow.~~png~~\|center\|thumb\|600px\|The basic data and interaction flows in the diagram framework. ([[Image:Diagram_Dataflow.graphml\|image source]])]]		[[Image:Diagram_Dataflow.svg\|center\|thumb\|600px\|The basic data and interaction flows in the diagram framework. ([[Image:Diagram_Dataflow.graphml\|image source]])]]

	The canvas context has its own thread which is used for manipulation of the context. Diagrams are specified to be single-threaded. The canvas context's thread shall also be used for manipulating the diagram after it is assigned to the context.		The canvas context has its own thread which is used for manipulation of the context. Diagrams are specified to be single-threaded. The canvas context's thread shall also be used for manipulating the diagram after it is assigned to the context.

	~~The diagram's DiagramClass should contain a TransactionContext handler. The transaction context contains a mechanism~~ for ~~readers-writers locking which should be used for synchronizing the use of DiagramMutator. GraphToDiagramSynchronizer uses~~ the ~~TransactionContext with read~~-~~locking to prevent race-conditions between itself and DiagramMutator users. Participants generally do something like this:~~		Diagram canvas participants are first and foremost responsible for translating user input into operations that change the back-end data model, i.e. the Simantics database contents. The changes are then reflected into the diagram and scene graph through the whole database request → listener → synchronizer chain.
	~~<source lang="java">~~
	~~DiagramUtils.mutateDiagram(diagram~~, ~~new Callback<DiagramMutator>() {~~
	~~@Override~~
	~~public void run(DiagramMutator mutator) {~~
	~~// Perform mutator operations~~...
	}
	~~});~~
	~~</source>~~

	~~If all you need to do is to synchronize a set of elements~~ into the ~~backend, a shorter version is to use one of:~~
	~~<source lang="java">~~
	~~public class DiagramUtils {~~

	~~public static void synchronizeHintsToBackend(IDiagram~~ diagram~~, final IElement... elements) { ... }~~

	~~public static void synchronizeHintsToBackend(IDiagram diagram, final Collection<IElement> elements) { ..~~. }

	}
	~~</source>~~

	== Development ==		== Development ==

Tuukka Lehtonen: /* Download */

2011-07-20T14:53:22Z

Download

← Older revision		Revision as of 14:53, 20 July 2011
Line 288:		Line 288:
	\|- style="background-color: #f9f9f9; " \|		\|- style="background-color: #f9f9f9; " \|
	\| HEAD		\| HEAD
			\| -
			\| [[svn:2d/trunk/org.simantics.diagram]]
	\|}		\|}

Tuukka Lehtonen: /* Download */

2011-07-20T14:52:47Z

Download

@@ Line 288: / Line 288: @@
 |- style="background-color: #f9f9f9; " |
 | HEAD
 |}

Juha Kortelainen at 16:02, 28 January 2011

2011-01-28T16:02:54Z

← Older revision		Revision as of 16:02, 28 January 2011
Line 323:		Line 323:
	= Contact =		= Contact =
	* [[User:Tuukka Lehtonen]]		* [[User:Tuukka Lehtonen]]

			[[Category: Diagram Development]]

Tuukka Lehtonen: /* How It Works */

2010-12-23T09:15:27Z

How It Works

← Older revision		Revision as of 09:15, 23 December 2010
Line 36:		Line 36:
	The diagram's DiagramClass should contain a TransactionContext handler. The transaction context contains a mechanism for readers-writers locking which should be used for synchronizing the use of DiagramMutator. GraphToDiagramSynchronizer uses the TransactionContext with read-locking to prevent race-conditions between itself and DiagramMutator users. Participants generally do something like this:		The diagram's DiagramClass should contain a TransactionContext handler. The transaction context contains a mechanism for readers-writers locking which should be used for synchronizing the use of DiagramMutator. GraphToDiagramSynchronizer uses the TransactionContext with read-locking to prevent race-conditions between itself and DiagramMutator users. Participants generally do something like this:
	<source lang="java">		<source lang="java">
	~~final DiagramMutator mutator = diagram.getHint(DiagramHints.KEY_MUTATOR);~~		DiagramUtils.mutateDiagram(diagram, new Callback<DiagramMutator>() {
	DiagramUtils.~~inDiagramTransaction~~(diagram~~, TransactionType.WRITE~~, new ~~Runnable~~() {
	@Override		@Override
	public void run() {		public void run(DiagramMutator mutator) {
	// Perform mutator operations...		// Perform mutator operations...
	~~mutator.commit();~~
	}		}
	});		});

Tuukka Lehtonen: /* Graph Data Model */

2010-12-23T09:12:47Z

Graph Data Model

← Older revision		Revision as of 09:12, 23 December 2010
Line 23:		Line 23:
	=== Graph Data Model ===		=== Graph Data Model ===

	This section describes how diagrams are modelled in the semantic graph using [[Graphical ontology notation]].		This section describes how diagrams are modelled in the semantic graph using [https://www.simantics.org/wiki/index.php/Graphical_ontology_notation Graphical ontology notation].

	[[Image:diagrams.png\|700px\|none\|thumb\|The diagram level model containing diagrams, layers and diagram elements. ([[:Image:diagrams.graphml\|image source]])]]		[[Image:diagrams.png\|700px\|none\|thumb\|The diagram level model containing diagrams, layers and diagram elements. ([[:Image:diagrams.graphml\|image source]])]]

Tuukka Lehtonen: /* Creating new connection types */

2010-12-23T09:04:03Z

Creating new connection types

← Older revision		Revision as of 09:04, 23 December 2010
Line 161:		Line 161:
	#* defining an [[org.simantics.g2d#Element_Class\|ElementClass]] for your connections		#* defining an [[org.simantics.g2d#Element_Class\|ElementClass]] for your connections

	The current diagramming system is fixed to having connections the format defined in [[#Graph Data Model]]. The logic of loading connections from the graph is also currently hardcoded in [[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/adapter/GraphToDiagramSynchronizer.java\|GraphToDiagramSynchronizer]]. ~~Summa summarum,~~ only ElementClass aspects of connections can currently be customized.		The current diagramming system is fixed to having connections the format defined in [[#Graph Data Model]]. The logic of loading connections from the graph is also currently hardcoded in [[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/adapter/GraphToDiagramSynchronizer.java\|GraphToDiagramSynchronizer]]. This means that only ElementClass-related aspects and behavior of connections can currently be customized.

	The customizable aspects of a connection are:		The customizable aspects of a connection are:

Tuukka Lehtonen: /* Creating new connection types */

2010-12-23T09:03:19Z

Creating new connection types

← Older revision		Revision as of 09:03, 23 December 2010
Line 161:		Line 161:
	#* defining an [[org.simantics.g2d#Element_Class\|ElementClass]] for your connections		#* defining an [[org.simantics.g2d#Element_Class\|ElementClass]] for your connections

	The current diagramming system is fixed to having connections the format defined in [[#~~Graph_Data_Model~~]]. The logic of loading connections from the graph is also currently hardcoded in [[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/adapter/GraphToDiagramSynchronizer.java\|GraphToDiagramSynchronizer]]. Summa summarum, only ElementClass aspects of connections can currently be customized.		The current diagramming system is fixed to having connections the format defined in [[#Graph Data Model]]. The logic of loading connections from the graph is also currently hardcoded in [[svn:2d/trunk/org.simantics.diagram/src/org/simantics/diagram/adapter/GraphToDiagramSynchronizer.java\|GraphToDiagramSynchronizer]]. Summa summarum, only ElementClass aspects of connections can currently be customized.

	The customizable aspects of a connection are:		The customizable aspects of a connection are: