Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor and standardize SVG export functions #940

Merged
merged 5 commits into from
Jul 11, 2022
Merged

Refactor and standardize SVG export functions #940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e001d1a
Refactor image export functions into static class
glopesdev Jun 9, 2022
e427d2c
Ensure SVG is exported at default DPI scale
glopesdev Jun 13, 2022
01e0518
Ensure SVG export uses fixed DPI measurements
glopesdev Jun 20, 2022
f4926b9
Rename export helper class
glopesdev Jun 21, 2022
c37ea5a
Add support for exporting workflow as an image
glopesdev Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 7 additions & 29 deletions Bonsai.Editor/EditorForm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,49 +1019,27 @@ void ExportImage(WorkflowGraphView model)

void ExportImage(WorkflowGraphView model, string fileName)
{
var workflow = model.Workflow;
if (model.GraphView.SelectedNodes.Count() > 0)
{
var selectedElements = model.GraphView.SelectedNodes.ToWorkflowBuilder();
var selectedLayout = selectedElements.Workflow.ConnectedComponentLayering().ToList();
using var graphView = new GraphViewControl
{
IconRenderer = model.GraphView.IconRenderer,
Font = model.GraphView.Font,
Nodes = selectedLayout
};
ExportImage(graphView, fileName);
workflow = selectedElements.Workflow;
}
else ExportImage(model.GraphView, fileName);
}

void ExportImage(GraphViewControl graphView, string fileName)
{
var bounds = graphView.GetLayoutSize();
var extension = Path.GetExtension(fileName);
if (extension == ".svg")
{
var graphics = new SvgNet.SvgGdi.SvgGraphics();
graphView.DrawGraphics(graphics, true);
var svg = graphics.WriteSVGString();
var attributes = string.Format(
"<svg width=\"{0}\" height=\"{1}\" ",
bounds.Width, bounds.Height);
svg = svg.Replace("<svg ", attributes);
var svg = ExportHelper.ExportSvg(workflow, iconRenderer);
File.WriteAllText(fileName, svg);
}
else
{
using (var bitmap = new Bitmap((int)bounds.Width, (int)bounds.Height))
using (var graphics = Graphics.FromImage(bitmap))
using var bitmap = ExportHelper.ExportBitmap(workflow, Font, iconRenderer);
if (string.IsNullOrEmpty(fileName))
{
var gdi = new SvgNet.SvgGdi.GdiGraphics(graphics);
graphView.DrawGraphics(gdi, false);
if (string.IsNullOrEmpty(fileName))
{
Clipboard.SetImage(bitmap);
}
else bitmap.Save(fileName);
Clipboard.SetImage(bitmap);
}
else bitmap.Save(fileName);
}
}

Expand Down
71 changes: 71 additions & 0 deletions Bonsai.Editor/ExportHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using Bonsai.Editor.GraphModel;
using Bonsai.Editor.GraphView;
using Bonsai.Expressions;

namespace Bonsai.Editor
{
static class ExportHelper
{
const float ReferenceDpi = 96f;
const float ReferenceFontSize = 8.25f;
static readonly Font SvgFont = new Font(Control.DefaultFont.FontFamily, ReferenceFontSize);

static GraphViewControl CreateGraphView(
ExpressionBuilderGraph workflow,
Font font,
SvgRendererFactory iconRenderer,
Image graphicsProvider)
{
var selectedLayout = workflow.ConnectedComponentLayering().ToList();
return new GraphViewControl
{
GraphicsProvider = graphicsProvider,
Font = font,
IconRenderer = iconRenderer,
Nodes = selectedLayout
};
}

public static string ExportSvg(ExpressionBuilderGraph workflow, SvgRendererFactory iconRenderer)
{
using var graphicsProvider = new Bitmap(1, 1);
graphicsProvider.SetResolution(ReferenceDpi, ReferenceDpi);
using var graphView = CreateGraphView(workflow, SvgFont, iconRenderer, graphicsProvider);
return ExportSvg(graphView);
}

public static string ExportSvg(GraphViewControl graphView)
{
var bounds = graphView.GetLayoutSize();
var graphics = new SvgNet.SvgGdi.SvgGraphics();
graphView.DrawGraphics(graphics);
var svg = graphics.WriteSVGString();
var attributes = string.Format(
"<svg width=\"{0}\" height=\"{1}\" ",
bounds.Width, bounds.Height);
svg = svg.Replace("<svg ", attributes);
return svg;
}

public static Bitmap ExportBitmap(ExpressionBuilderGraph workflow, Font font, SvgRendererFactory iconRenderer)
{
using var graphView = CreateGraphView(workflow, font, iconRenderer, graphicsProvider: null);
return ExportBitmap(graphView);
}

public static Bitmap ExportBitmap(GraphViewControl graphView)
{
var bounds = graphView.GetLayoutSize();
var bitmap = new Bitmap((int)bounds.Width, (int)bounds.Height);
using (var graphics = Graphics.FromImage(bitmap))
{
var gdi = new SvgNet.SvgGdi.GdiGraphics(graphics);
graphView.DrawGraphics(gdi);
return bitmap;
}
}
}
}
39 changes: 18 additions & 21 deletions Bonsai.Editor/GraphView/GraphViewControl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ partial class GraphViewControl : UserControl, IGraphView
Pen SolidPen;
Pen DashPen;
Font DefaultIconFont;
Font ExportFont;

float drawScale;
bool ignoreMouseUp;
Expand Down Expand Up @@ -238,6 +237,8 @@ public event EventHandler SelectedNodeChanged

public SvgRendererFactory IconRenderer { get; set; }

public Image GraphicsProvider { get; set; }

public IEnumerable<GraphNodeGrouping> Nodes
{
get { return nodes; }
Expand Down Expand Up @@ -310,6 +311,11 @@ public IEnumerable<GraphNode> SelectedNodes
}
}

Graphics CreateVectorGraphics()
{
return GraphicsProvider != null ? Graphics.FromImage(GraphicsProvider) : CreateGraphics();
}

void UpdateSelection(Action update)
{
InvalidateSelection();
Expand Down Expand Up @@ -342,12 +348,6 @@ void DisposeDrawResources()
DashPen.Dispose();
SolidPen = DashPen = null;
}

if (ExportFont != null)
{
ExportFont.Dispose();
ExportFont = null;
}
}

void UpdateCursorPen()
Expand All @@ -372,9 +372,13 @@ void UpdateCursorPen()
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
{
DisposeDrawResources();
using (var graphics = CreateGraphics())
using (var graphics = CreateVectorGraphics())
{
drawScale = graphics.DpiY / DefaultDpi * Font.SizeInPoints / Control.DefaultFont.SizeInPoints;
drawScale = graphics.DpiY / DefaultDpi;
if (GraphicsProvider == null)
{
drawScale *= Font.SizeInPoints / DefaultFont.SizeInPoints;
}
}

iconRendererState.Scale = drawScale;
Expand Down Expand Up @@ -407,7 +411,7 @@ Rectangle GetBoundingRectangle(GraphNode node)
var labelRectangle = nodeLayout.LabelRectangle;
if (nodeText != nodeLayout.Text)
{
using (var graphics = CreateGraphics())
using (var graphics = CreateVectorGraphics())
{
nodeLayout.SetNodeLabel(nodeText, Font, graphics);
labelRectangle = RectangleF.Union(labelRectangle, nodeLayout.LabelRectangle);
Expand Down Expand Up @@ -809,7 +813,7 @@ private void UpdateModelLayout()
var size = SizeF.Empty;
if (model != null)
{
using (var graphics = CreateGraphics())
using (var graphics = CreateVectorGraphics())
{
var layerCount = model.Count();
foreach (var layer in model)
Expand Down Expand Up @@ -1122,21 +1126,14 @@ private void DrawEdges(IGraphics graphics, Size offset)
}
}

public void DrawGraphics(IGraphics graphics, bool scaleFont)
public void DrawGraphics(IGraphics graphics)
{
graphics.SmoothingMode = SmoothingMode.AntiAlias;
graphics.Clear(Color.White);

using (var measureGraphics = CreateGraphics())
using (var measureGraphics = CreateVectorGraphics())
{
var font = Font;
var fontScale = measureGraphics.DpiY / DefaultDpi;
if (scaleFont && fontScale != 1.0)
{
ExportFont = ExportFont ?? new Font(Font.FontFamily, Font.SizeInPoints * fontScale);
font = ExportFont;
}

using (var fill = new SolidBrush(Color.White))
using (var stroke = new Pen(NodeEdgeColor, PenWidth))
{
Expand All @@ -1152,7 +1149,7 @@ public void DrawGraphics(IGraphics graphics, bool scaleFont)
{
int charactersFitted, linesFilled;
var size = measureGraphics.MeasureString(
line, Font,
line, font,
labelRect.Size,
VectorTextFormat,
out charactersFitted, out linesFilled);
Expand Down
51 changes: 51 additions & 0 deletions Bonsai.Editor/WorkflowExporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
using System;
using System.IO;
using System.Windows.Forms;
using System.Xml;
using System.Xml.Serialization;
using Bonsai.Editor.GraphView;

namespace Bonsai.Editor
{
public static class WorkflowExporter
{
public static void ExportImage(string fileName, string imageFileName)
{
if (string.IsNullOrEmpty(fileName))
{
throw new ArgumentNullException(nameof(fileName));
}

if (!File.Exists(fileName))
{
throw new ArgumentException("Specified workflow file does not exist.", nameof(fileName));
}

if (string.IsNullOrEmpty(imageFileName))
{
throw new ArgumentException("No output image file is specified.", nameof(imageFileName));
}

WorkflowBuilder workflowBuilder;
using (var reader = XmlReader.Create(fileName))
{
reader.MoveToContent();
var serializer = new XmlSerializer(typeof(WorkflowBuilder), reader.NamespaceURI);
workflowBuilder = (WorkflowBuilder)serializer.Deserialize(reader);
}

var iconRenderer = new SvgRendererFactory();
var extension = Path.GetExtension(imageFileName);
if (extension == ".svg")
{
var svg = ExportHelper.ExportSvg(workflowBuilder.Workflow, iconRenderer);
File.WriteAllText(imageFileName, svg);
}
else
{
using var bitmap = ExportHelper.ExportBitmap(workflowBuilder.Workflow, Control.DefaultFont, iconRenderer);
bitmap.Save(imageFileName);
}
}
}
}
21 changes: 21 additions & 0 deletions Bonsai/Launcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,27 @@ internal static int LaunchWorkflowPlayer(
return Program.NormalExitCode;
}

internal static int LaunchExportImage(
string fileName,
string imageFileName,
PackageConfiguration packageConfiguration)
{
if (string.IsNullOrEmpty(fileName))
{
Console.WriteLine("No workflow file was specified.");
return Program.NormalExitCode;
}

if (string.IsNullOrEmpty(imageFileName))
{
Console.WriteLine("No image file was specified.");
return Program.NormalExitCode;
}

WorkflowExporter.ExportImage(fileName, imageFileName);
return Program.NormalExitCode;
}

static int ShowManifestReadError(string path, string message)
{
MessageBox.Show(
Expand Down
5 changes: 5 additions & 0 deletions Bonsai/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ static class Program
const string PackageManagerCommand = "--package-manager";
const string PackageManagerUpdates = "updates";
const string ExportPackageCommand = "--export-package";
const string ExportImageCommand = "--export-image";
const string ReloadEditorCommand = "--reload-editor";
const string GalleryCommand = "--gallery";
const string EditorDomainName = "EditorDomain";
Expand All @@ -45,9 +46,11 @@ internal static int Main(string[] args)
var launchEditor = true;
var debugScripts = false;
var editorScale = 1.0f;
var exportImage = false;
var updatePackages = false;
var launchResult = default(EditorResult);
var initialFileName = default(string);
var imageFileName = default(string);
var layoutPath = default(string);
var libFolders = new List<string>();
var propertyAssignments = new Dictionary<string, string>();
Expand All @@ -59,6 +62,7 @@ internal static int Main(string[] args)
parser.RegisterCommand(DebugScriptCommand, () => debugScripts = true);
parser.RegisterCommand(SuppressBootstrapCommand, () => bootstrap = false);
parser.RegisterCommand(SuppressEditorCommand, () => launchEditor = false);
parser.RegisterCommand(ExportImageCommand, fileName => { imageFileName = fileName; exportImage = true; });
parser.RegisterCommand(ExportPackageCommand, () => { launchResult = EditorResult.ExportPackage; bootstrap = false; });
parser.RegisterCommand(ReloadEditorCommand, () => { launchResult = EditorResult.ReloadEditor; bootstrap = false; });
parser.RegisterCommand(GalleryCommand, () => { launchResult = EditorResult.OpenGallery; bootstrap = false; });
Expand Down Expand Up @@ -143,6 +147,7 @@ internal static int Main(string[] args)
libFolders.ForEach(path => ConfigurationHelper.RegisterPath(packageConfiguration, path));
using var scriptExtensions = ScriptExtensionsProvider.CompileAssembly(Launcher.ProjectFramework, packageConfiguration, editorRepositoryPath, debugScripts);
ConfigurationHelper.SetAssemblyResolve(packageConfiguration);
if (exportImage) return Launcher.LaunchExportImage(initialFileName, imageFileName, packageConfiguration);
if (!launchEditor) return Launcher.LaunchWorkflowPlayer(initialFileName, layoutPath, packageConfiguration, propertyAssignments);
else return Launcher.LaunchWorkflowEditor(
packageConfiguration,
Expand Down