How to extract Images from Capella model?

Rohit · 22 March 2021 10:05

Hello,
I want to extract/export diagrams from Capella model in the image format.
Could you please help with this?

Thank you in advance

SamuelRochet · 22 March 2021 10:22

Hi,

Yes, we can. You will find that in the documentation.

Rohit · 22 March 2021 10:29

Hello,
Thank you for quick answer.

But I want to do it programmatically

pdulth · 26 March 2021 15:55

Hi,
You can do it with command line

github.com

eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.commandline.doc/html/19. Command Line Support/19.1. Core Mechanism and Applications.mediawiki#export-representations-as-images


= Command Line Support =

== Overview ==

Capella provides the capacity to launch actions from command line. Potential actions are Model Validation, Model Migration, HTML Production, Refresh Representations, Remove Hidden Elements from Representations and Export Representations as Images.

The core mechanism provides the following parameters:

{| id="commonParameters"
!Name
!Category
!Description
|-
|appid
|mandatory
|defines the id of the command line application to launch. Command line applications are plugins that extend the core mechanism (e.g. model validation)
|-
|data
|optional

This file has been truncated. show original

Or programmatically like the code of the command line :

github.com

eclipse/capella/blob/master/core/plugins/org.polarsys.capella.core.sirius.ui/src/org/polarsys/capella/core/sirius/ui/commandline/ExportRepresentationsCommandLine.java#L68


if (!session.isOpen()) {

  session.open(new NullProgressMonitor());

}



if (CapellaResourceHelper.isAirdResource(uri)) {

  Collection<DRepresentation> representations = DialectManager.INSTANCE.getAllRepresentations(session);

  IPath outputPath = getOrCreateOutputFolderForAird(uri).getLocation();

  ImageFileFormat imageFormat = ImageFileFormat.resolveImageFormat(args.getImageFormat());

  boolean exportToHtml = args.getExportToHtml();

  boolean exportDecorations = args.getExportDecorations();

  ExportAction exportRepresentationsAction = new ExportAction( //

      session, representations, outputPath, imageFormat, exportToHtml, exportDecorations);

  try {

    exportRepresentationsAction.run(new NullProgressMonitor());



  } catch (InterruptedException e1) {

    return Status.CANCEL_STATUS;



  } catch (InvocationTargetException e) {

    return new Status(IStatus.ERROR, SiriusUIPlugin.getDefault().getPluginId(), e.getMessage(), e);

Philippe

Rohit · 1 April 2021 05:39

This API is for Collection but I want to extract a single image by using only DRepresentation

I am trying to use this code:

org.eclipse.sirius.ui.business.api.dialect.DialectUIManager.INSTANCE.export(
											representation, session, fullOutputPath,
											new ExportFormat(ExportDocumentFormat.NONE, ImageFileFormat.JPG),
											new NullProgressMonitor());

but by using this I get the popup message in Capell:
The following file is out of synchronization with the workspace:
output folder path (it is in the project )

pdulth · 1 April 2021 07:51

Hi,

If you already have a representation, you can use Arrays.asList(representation) to create a collection with your representation.

The “The following file is out of synchronization with the workspace:” can be fixed by clicking on the project in Capella project explorer and do a “rightclick > refresh” on it.

Programmatically, you can retrieve a given project by its name
IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
and do project.refreshLocal(IResource.DEPTH_INFINITE, null); on it.

Rohit · 1 April 2021 07:58

Hello,

IPath absoluteImagePath = ResourcesPlugin.getWorkspace().getRoot()
											.getProject(p.getName()).getLocation().append("temp.jpg");

									org.eclipse.sirius.ui.business.api.dialect.DialectUIManager.INSTANCE.export(
											representation, session, absoluteImagePath,
											new ExportFormat(ExportDocumentFormat.NONE, ImageFileFormat.JPG),
											new NullProgressMonitor());

now my code is work fine because I am passing path argument as file you can see in code.
it works fine.

Thank you for your help