Difference between revisions of "Org.simantics.document"

From Developer Documents
Jump to navigation Jump to search
Line 13: Line 13:
  
 
The document data model is a '''scene graph''' which is loaded with the '''scene graph loader''' described [[org.simantics.scenegraph.loader|here]].
 
The document data model is a '''scene graph''' which is loaded with the '''scene graph loader''' described [[org.simantics.scenegraph.loader|here]].
 +
 +
= Basic use =
  
 
Document scene graph models can be loaded into multiple scene graph implementations. The default implementation (via plain '''org.simantics.scenegraph.loader.ScenegraphLoader''' adaption) can be used to transform the document model into a Wiki document via the interface '''org.simantics.document.WikiDocumentNode'''.
 
Document scene graph models can be loaded into multiple scene graph implementations. The default implementation (via plain '''org.simantics.scenegraph.loader.ScenegraphLoader''' adaption) can be used to transform the document model into a Wiki document via the interface '''org.simantics.document.WikiDocumentNode'''.

Revision as of 06:37, 3 November 2011

The Simantics document subsystem is defined in various plugins including

  • Headless documentation model
    1. org.simantics.document (SVN)
    2. org.simantics.document.ontology (SVN)
  • Document editor
    1. org.simantics.document.ui (SVN)
    2. org.simantics.document.ui.ontology (SVN)
  • Scene graph
    1. org.simantics.scenegraph (SVN)
    2. org.simantics.scenegraph.ontology (SVN)
    3. org.simantics.scenegraph.loader (SVN)

The document data model is a scene graph which is loaded with the scene graph loader described here.

Basic use

Document scene graph models can be loaded into multiple scene graph implementations. The default implementation (via plain org.simantics.scenegraph.loader.ScenegraphLoader adaption) can be used to transform the document model into a Wiki document via the interface org.simantics.document.WikiDocumentNode.


ScenegraphLoaderProcess loader = new ScenegraphLoaderProcess(new Composite());
WikiDocumentNodeImpl node = loader.load(graph, desc, ScenegraphLoaderUtils.getRuntime(graph, context));

User interface

A document editor is modelled in org.simantics.document.ui.ontology. The corresponding editor class is org.simantics.document.ui.DocumentEditor.

Nodes