1 /*******************************************************************************
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.modeling.ui.sg;
14 import java.awt.Color;
15 import java.awt.event.AWTEventListener;
17 import org.eclipse.core.runtime.NullProgressMonitor;
18 import org.simantics.Simantics;
19 import org.simantics.databoard.Bindings;
20 import org.simantics.db.ReadGraph;
21 import org.simantics.db.Resource;
22 import org.simantics.db.common.ResourceArray;
23 import org.simantics.db.common.primitiverequest.PossibleAdapter;
24 import org.simantics.db.exception.DatabaseException;
25 import org.simantics.db.exception.ManyObjectsForFunctionalRelationException;
26 import org.simantics.db.exception.NoSingleResultException;
27 import org.simantics.db.exception.ServiceException;
28 import org.simantics.db.management.ISessionContext;
29 import org.simantics.db.request.Read;
30 import org.simantics.diagram.adapter.DefaultConnectionClassFactory;
31 import org.simantics.diagram.adapter.FlagClassFactory;
32 import org.simantics.diagram.adapter.GraphToDiagramSynchronizer;
33 import org.simantics.diagram.handler.CopyPasteHandler;
34 import org.simantics.diagram.handler.CopyPasteStrategy;
35 import org.simantics.diagram.handler.DefaultCopyPasteStrategy;
36 import org.simantics.diagram.handler.DeleteHandler;
37 import org.simantics.diagram.handler.SimpleElementTransformHandler;
38 import org.simantics.diagram.participant.ConnectionCrossingsParticipant;
39 import org.simantics.diagram.query.DiagramRequests;
40 import org.simantics.diagram.runtime.RuntimeDiagramManager;
41 import org.simantics.diagram.stubs.DiagramResource;
42 import org.simantics.diagram.synchronization.CopyAdvisor;
43 import org.simantics.diagram.synchronization.SynchronizationHints;
44 import org.simantics.diagram.ui.DiagramModelHints;
45 import org.simantics.g2d.canvas.Hints;
46 import org.simantics.g2d.canvas.ICanvasContext;
47 import org.simantics.g2d.canvas.impl.CanvasContext;
48 import org.simantics.g2d.diagram.DiagramHints;
49 import org.simantics.g2d.diagram.IDiagram;
50 import org.simantics.g2d.diagram.participant.DiagramParticipant;
51 import org.simantics.g2d.diagram.participant.ElementInteractor;
52 import org.simantics.g2d.diagram.participant.ElementPainter;
53 import org.simantics.g2d.diagram.participant.Selection;
54 import org.simantics.g2d.diagram.participant.ZOrderHandler;
55 import org.simantics.g2d.diagram.participant.pointertool.PointerInteractor;
56 import org.simantics.g2d.element.ElementClassProviders;
57 import org.simantics.g2d.element.ElementClasses;
58 import org.simantics.g2d.element.IElementClassProvider;
59 import org.simantics.g2d.element.handler.impl.StaticObjectAdapter;
60 import org.simantics.g2d.multileveldiagram.TransitionFunction;
61 import org.simantics.g2d.multileveldiagram.ZoomTransitionParticipant;
62 import org.simantics.g2d.page.DiagramDesc;
63 import org.simantics.g2d.participant.BackgroundPainter;
64 import org.simantics.g2d.participant.CanvasBoundsParticipant;
65 import org.simantics.g2d.participant.CanvasGrab;
66 import org.simantics.g2d.participant.GridPainter;
67 import org.simantics.g2d.participant.KeyToCommand;
68 import org.simantics.g2d.participant.KeyUtil;
69 import org.simantics.g2d.participant.MouseUtil;
70 import org.simantics.g2d.participant.MultitouchPanZoomRotateInteractor;
71 import org.simantics.g2d.participant.Notifications;
72 import org.simantics.g2d.participant.PageBorderParticipant;
73 import org.simantics.g2d.participant.PanZoomRotateHandler;
74 import org.simantics.g2d.participant.PointerPainter;
75 import org.simantics.g2d.participant.RulerPainter;
76 import org.simantics.g2d.participant.SymbolUtil;
77 import org.simantics.g2d.participant.TimeParticipant;
78 import org.simantics.g2d.participant.TransformUtil;
79 import org.simantics.g2d.participant.ZoomToAreaHandler;
80 import org.simantics.g2d.scenegraph.ICanvasSceneGraphProvider;
81 import org.simantics.modeling.ModelingResources;
82 import org.simantics.modeling.mapping.ComponentCopyAdvisor;
83 import org.simantics.modeling.mapping.ElementCopyAdvisor;
84 import org.simantics.modeling.mapping.MappedElementCopyAdvisor;
85 import org.simantics.modeling.mapping.ModelingSynchronizationHints;
86 import org.simantics.modeling.ui.diagramEditor.PopulateElementDropParticipant;
87 import org.simantics.modeling.ui.diagramEditor.PopulateElementMonitorDropParticipant;
88 import org.simantics.modeling.ui.diagramEditor.handlers.HeadlessStructuralBrowsingHandler;
89 import org.simantics.modeling.ui.diagramEditor.handlers.HeadlessStructuralBrowsingHandler.IDiagramUpdateSupport;
90 import org.simantics.scenegraph.g2d.G2DSceneGraph;
91 import org.simantics.scenegraph.g2d.events.adapter.AWTRemoteEventAdapter;
92 import org.simantics.scenegraph.g2d.events.command.CommandKeyBinding;
93 import org.simantics.structural.stubs.StructuralResource2;
94 import org.simantics.structural2.modelingRules.IModelingRules;
95 import org.simantics.utils.datastructures.hints.HintContext;
96 import org.simantics.utils.datastructures.hints.IHintContext;
97 import org.simantics.utils.page.PageDesc;
98 import org.simantics.utils.page.PageOrientation;
99 import org.simantics.utils.threads.AWTThread;
100 import org.simantics.utils.threads.IThreadWorkQueue;
101 import org.simantics.utils.ui.ErrorLogger;
105 * ISceneGraphProvider implementation for diagrams.
106 * TODO: decide if this should be stateless or stateful class
111 public class DiagramSceneGraphProvider implements ICanvasSceneGraphProvider, IDiagramUpdateSupport {
113 protected boolean isSymbol = false;
114 protected Resource resource;
115 protected ResourceArray structuralPath = null;
116 protected IDiagram diagram = null;
117 protected CanvasContext ctx = null;
118 protected boolean ownsContext = false;
119 protected GraphToDiagramSynchronizer synchronizer = null;
120 protected String view = null;
121 protected Boolean navigation = null;
123 protected AWTRemoteEventAdapter listener = null;
125 final IHintContext initialHints = new HintContext();
127 public DiagramSceneGraphProvider(ReadGraph g, final Resource diagramOrComposite) {
128 this.structuralPath = new ResourceArray();
131 StructuralResource2 sr = StructuralResource2.getInstance(g);
132 DiagramResource DIA = DiagramResource.getInstance(g);
134 Resource diagram = diagramOrComposite;
135 if(!g.isInstanceOf(diagram, DIA.Composite)) {
137 ModelingResources mr = ModelingResources.getInstance(g);
138 diagram = g.getPossibleObject(diagramOrComposite, mr.CompositeToDiagram);
139 if(diagram == null) {
140 // looks like we have a component without direct relation to composite.. try to solve this
141 // FIXME: use adapter to get composite directly from resource
142 final Resource type = g.getSingleType(diagramOrComposite, sr.Component);
146 final Resource definedBy = g.getPossibleObject(type, sr.IsDefinedBy);
147 if (definedBy == null)
150 this.structuralPath = new ResourceArray(diagramOrComposite);
151 diagram = g.getPossibleObject(definedBy, mr.CompositeToDiagram);
156 Resource possibleSymbol = g.getPossibleObject(diagram, sr.Defines);
157 if(possibleSymbol != null && g.isInstanceOf(possibleSymbol, DIA.ElementClass)) isSymbol = true;
161 this.resource = diagram;
163 } catch (ManyObjectsForFunctionalRelationException e) {
164 // TODO Auto-generated catch block
166 } catch (ServiceException e) {
167 // TODO Auto-generated catch block
169 } catch (NoSingleResultException e) {
170 // TODO Auto-generated catch block
175 public GraphToDiagramSynchronizer getGraphToDiagramSynchronizer() {
179 protected CopyPasteStrategy getCopyPasteStrategy() {
181 CopyPasteStrategy cpStrategy = Simantics.getSession().syncRequest(new PossibleAdapter<CopyPasteStrategy>(resource, CopyPasteStrategy.class));
182 if(cpStrategy != null) return cpStrategy;
183 } catch (DatabaseException e) {
185 return new DefaultCopyPasteStrategy();
188 protected CopyAdvisor getCopyAdvisor() {
190 CopyAdvisor advisor = Simantics.getSession().syncRequest(new PossibleAdapter<CopyAdvisor>(resource, CopyAdvisor.class));
191 if(advisor != null) return advisor;
192 } catch (DatabaseException e) {
194 return new MappedElementCopyAdvisor(new ElementCopyAdvisor(), new ComponentCopyAdvisor());
197 protected void initContext(CanvasContext ctx) {
198 boolean unlock = false;
199 if (!ctx.isLocked()) {
204 IHintContext h = ctx.getDefaultHintContext();
206 // Support & Util Participants
207 ctx.add( new TransformUtil() );
208 ctx.add( new MouseUtil() );
209 ctx.add( new KeyUtil() );
210 ctx.add( new CanvasGrab() );
211 ctx.add( new SymbolUtil() );
212 ctx.add( new TimeParticipant() );
213 ctx.add( new CanvasBoundsParticipant() );
214 ctx.add( new Notifications() );
216 // SGFocusParticipant does not work for remote viewer at the moment.
217 //ctx.add( new SGFocusParticipant() );
219 h.setHint(PointerPainter.KEY_PAINT_POINTER, true);
221 ctx.add( new PanZoomRotateHandler(navigation == null || navigation == true) );
222 ctx.add( new MultitouchPanZoomRotateInteractor() );
223 ctx.add( new ZoomToAreaHandler() );
224 ctx.add( new SimpleElementTransformHandler() );
227 if(navigation == null || navigation == true)
228 ctx.add( new KeyToCommand( CommandKeyBinding.DEFAULT_BINDINGS ) );
230 // Grid & Ruler & Background
231 h.setHint(RulerPainter.KEY_RULER_ENABLED, false);
232 h.setHint(GridPainter.KEY_GRID_ENABLED, false);
234 ctx.add( new GridPainter() );
235 ctx.add( new RulerPainter() );
236 ctx.add( new BackgroundPainter() );
238 h.setHint(Hints.KEY_DISPLAY_PAGE, Boolean.FALSE);
239 h.setHint(Hints.KEY_DISPLAY_MARGINS, Boolean.TRUE);
240 ctx.add( new PageBorderParticipant() );
242 h.setHint(Hints.KEY_GRID_COLOR, new Color(0.95f, 0.95f, 0.95f));
243 h.setHint(Hints.KEY_BACKGROUND_COLOR, Color.WHITE);
244 h.setHint(RulerPainter.KEY_RULER_BACKGROUND_COLOR, new Color(0.9f, 0.9f, 0.9f, 0.75f));
245 h.setHint(RulerPainter.KEY_RULER_TEXT_COLOR, Color.BLACK);
247 ////// Diagram Participants //////
248 ctx.add( new PointerInteractor(false, false, false, false, true, true, synchronizer.getElementClassProvider(), null) );
249 ctx.add( new ElementInteractor() );
250 ctx.add( new Selection() );
251 ctx.add( new DiagramParticipant() );
252 ctx.add( new ElementPainter(true) );
253 ctx.add( new ConnectionCrossingsParticipant(resource));
255 //ctx.add( new ElementHeartbeater() );
256 ctx.add( new ZOrderHandler() );
257 ctx.add( new ZoomTransitionParticipant(TransitionFunction.SIGMOID) );
259 /////// D'n'D ///////
260 ctx.add(new PopulateElementDropParticipant(synchronizer));
261 ctx.add(new PopulateElementMonitorDropParticipant(synchronizer, 0.5, 0.5));
263 h.setHint(Hints.KEY_TOOL, Hints.POINTERTOOL);
265 h.setHint(PanZoomRotateHandler.KEY_ZOOM_IN_LIMIT, 1000.0);
266 h.setHint(PanZoomRotateHandler.KEY_ZOOM_OUT_LIMIT, 10.0);
268 // Add visual browsing capabilities for structural models
269 ISessionContext sessionContext = Simantics.getSessionContext();
270 ctx.add(new HeadlessStructuralBrowsingHandler(this, sessionContext, structuralPath));
273 PageDesc pageDesc = PageDesc.DEFAULT.withOrientation(PageOrientation.Landscape);
274 // TODO: load page desc from graph
275 h.setHint(Hints.KEY_PAGE_DESC, pageDesc);
277 ctx.add(new CopyPasteHandler(getCopyPasteStrategy()));
278 ctx.add(new DeleteHandler(null));
280 if (resource != null)
281 loadPageSettings(ctx, resource);
283 ctx.assertParticipantDependencies();
285 ctx.setLocked(false);
288 protected void loadPageSettings(ICanvasContext ctx, Resource diagramResource) {
290 DiagramDesc diagramDesc = Simantics.getSession().syncRequest(DiagramRequests.getDiagramDesc(diagramResource));
291 if (diagramDesc != null)
292 setDiagramDesc(ctx, diagramDesc);
293 } catch (DatabaseException e) {
294 ErrorLogger.defaultLogError(e);
298 protected void setDiagramDesc(ICanvasContext ctx, DiagramDesc diagramDesc) {
299 IHintContext hints = ctx.getDefaultHintContext();
300 hints.setHint(Hints.KEY_PAGE_DESC, diagramDesc.getPageDesc());
301 //hints.setHint(Hints.KEY_DISPLAY_PAGE, diagramDesc.isPageBordersVisible());
302 hints.setHint(Hints.KEY_DISPLAY_MARGINS, diagramDesc.isMarginsVisible());
306 public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg) {
307 return initializeSceneGraph(sg, null);
311 public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String view) {
312 return initializeSceneGraph(sg, "", "", view);
316 public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String modelURI, String RVI) {
317 return initializeSceneGraph(sg, modelURI, RVI, "");
321 public G2DSceneGraph initializeSceneGraph(ICanvasContext context, String modelURI, String RVI) {
322 G2DSceneGraph sg = context.getSceneGraph();
323 return initializeSceneGraph(context, sg, modelURI, RVI, "");
329 * @param initialHints
332 private G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String modelURI, String RVI, String view) {
333 IThreadWorkQueue thread = AWTThread.getThreadAccess();
334 ctx = new CanvasContext(thread, sg); // By giving the scene graph instance as parameter, we can use external serializer
335 return initializeSceneGraph(ctx, sg, modelURI, RVI, view);
341 * @param initialHints
344 private G2DSceneGraph initializeSceneGraph(ICanvasContext context, G2DSceneGraph sg, String modelURI, String RVI, String view) {
345 this.ctx = (CanvasContext) context;
348 //System.out.println("using layer '"+view+"'");
349 initialHints.setHint(DiagramHints.KEY_FIXED_LAYERS, new String[] { view });
353 fillInitialDiagramHints(initialHints);
355 final RuntimeDiagramManager runtimeDiagramManager = RuntimeDiagramManager.create(Simantics.getSession(), resource, modelURI, RVI);
357 synchronizer = Simantics.getSession().syncRequest(new Read<GraphToDiagramSynchronizer>() {
359 public GraphToDiagramSynchronizer perform(ReadGraph graph) throws DatabaseException {
360 DiagramResource dr = DiagramResource.getInstance(graph);
361 Boolean val = graph.getPossibleRelatedValue(resource, dr.NavigationEnabled, Bindings.BOOLEAN);
362 if(val != null && navigation == null) { // Set only if navigation has not been set manually
365 GraphToDiagramSynchronizer sync = new GraphToDiagramSynchronizer(graph, ctx,createElementClassProvider(graph));
367 sync.set(ModelingSynchronizationHints.MODELING_RESOURCE, ModelingResources.getInstance(graph));
368 diagram = sync.loadDiagram(new NullProgressMonitor(), graph, null, resource, runtimeDiagramManager.getRuntimeDiagram(), structuralPath, initialHints); // FIXME
373 } catch (DatabaseException e) {
374 // TODO Auto-generated catch block
377 ctx.getDefaultHintContext().setHint(DiagramHints.KEY_DIAGRAM, diagram);
381 return ctx.getSceneGraph();
384 protected void fillInitialDiagramHints(IHintContext initialHints) throws DatabaseException {
385 IModelingRules modelingRules = Simantics.getSession().syncRequest(DiagramRequests.getModelingRules(resource, null));
386 if (modelingRules != null) {
387 initialHints.setHint(DiagramModelHints.KEY_MODELING_RULES, modelingRules);
390 initialHints.setHint(SynchronizationHints.COPY_ADVISOR, getCopyAdvisor());
393 protected IElementClassProvider createElementClassProvider(ReadGraph graph) throws DatabaseException {
394 DiagramResource dr = DiagramResource.getInstance(graph);
395 return ElementClassProviders.mappedProvider(
396 ElementClasses.CONNECTION, DefaultConnectionClassFactory.CLASS.newClassWith(new StaticObjectAdapter(dr.Connection)),
397 ElementClasses.FLAG, FlagClassFactory.createFlagClass(dr.Flag, dr.Flag_Terminal)
403 public void dispose() {
409 if (synchronizer != null) {
410 synchronizer.dispose();
413 if (diagram != null) {
420 * Hack for returning canvasContext for some special cases
421 * this method brakes the interface, but this is not intended to be used in production context
425 public ICanvasContext getCanvasContext() {
430 public AWTEventListener getEventListener() {
431 if(ctx == null) return null;
432 if(listener == null) {
433 listener = new AWTRemoteEventAdapter(ctx, ctx.getEventQueue());
439 public void updateDiagram(final ResourceArray structuralPath) {
440 final IHintContext hints = new HintContext();
442 System.out.println("using layer '"+view+"'");
443 hints.setHint(DiagramHints.KEY_FIXED_LAYERS, new String[] { view });
447 // FIXME: I have no idea if this works or not..
448 diagram = Simantics.getSession().syncRequest(new Read<IDiagram>() {
450 public IDiagram perform(ReadGraph graph) throws DatabaseException {
451 IDiagram d = synchronizer.loadDiagram(new NullProgressMonitor(), graph, null, structuralPath.resources[0], null, structuralPath.removeFromBeginning(0), hints);
455 ctx.getDefaultHintContext().setHint(DiagramHints.KEY_DIAGRAM, diagram);
456 } catch (DatabaseException e) {
457 // TODO Auto-generated catch block
462 public void setExperiment(ReadGraph g, String identifier) {
463 if(diagram == null) return;
464 diagram.setHint(DiagramModelHints.KEY_ACTIVE_EXPERIMENT, identifier);
465 initialHints.setHint(DiagramModelHints.KEY_ACTIVE_EXPERIMENT, identifier);
468 // DiagramExperiment.setActiveExperiment(g, diagram, (String)identifier);
469 // } catch (DatabaseException e) {
470 // // TODO Auto-generated catch block
471 // e.printStackTrace();
478 * DiagramModelHints.KEY_SESSION_ID
479 * DiagramHints.KEY_NAVIGATION_ENABLED
482 public void setHint(Object key, Object value) {
483 if(DiagramModelHints.KEY_SESSION_ID.equals(key)) {
485 diagram.setHint(DiagramModelHints.KEY_SESSION_ID, value);
486 initialHints.setHint(DiagramModelHints.KEY_SESSION_ID, value);
487 } else if(DiagramModelHints.KEY_ACTIVE_EXPERIMENT.equals(key)) {
489 diagram.setHint(DiagramModelHints.KEY_ACTIVE_EXPERIMENT, value);
490 initialHints.setHint(DiagramModelHints.KEY_ACTIVE_EXPERIMENT, value);
491 } else if(DiagramHints.KEY_NAVIGATION_ENABLED.equals(key)) {
492 navigation = (Boolean)value;