做為一個摩登的工業軟件,提供可編程的腳本能力是必不可少的能力。腳本既可以方便用戶進行二次開發,也對方便對程序進行自動化測試。本文將結合AnyCAD對Python腳本支持的能力和WPF快速開發帶腳本編輯器的CAD軟件。
1 增加腳本插件
創建一個WPF控件項目,名為Rapid.ScriptPy.Plugin。參照《開發基於WPF的摩登三維工業軟件 (6)》一文添加ScriptRibbonTab,並增加運行腳本按鈕。
<Fluent:RibbonTabItem xmlns:Fluent="urn:fluent-ribbon" x:Class="Rapid.ScriptPy.Plugin.UI.ScriptRibbonTab"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:local="clr-namespace:Rapid.ScriptPy.Plugin.UI"
mc:Ignorable="d"
Header="腳本"
d:DesignHeight="100" d:DesignWidth="400">
<Fluent:RibbonGroupBox Header="基本體" IsLauncherVisible="False" Margin="7,0,0,0">
<Fluent:Button Header="運行" Size="Large" Command="{x:Static local:ScriptRibbonTab.ExecuteCommand}"
CommandParameter="runPy" Margin="0,0,7,0"/>
</Fluent:RibbonGroupBox>
</Fluent:RibbonTabItem>
namespace Rapid.ScriptPy.Plugin.UI
{
/// <summary>
/// ScriptRibbonTab.xaml 的交互邏輯
/// </summary>
public partial class ScriptRibbonTab
{
public static readonly RoutedCommand ExecuteCommand = new("Rapid.ScriptPy", typeof(ScriptRibbonTab));
public ScriptRibbonTab()
{
InitializeComponent();
CommandBindings.Add(new CommandBinding(ExecuteCommand, OnExecuteCommand));
}
private void OnExecuteCommand(object sender, ExecutedRoutedEventArgs e)
{
}
}
}
2 腳本編輯器
基於WPF的自帶語法高亮的代碼編輯器很多,本文使用AvalonEdit作為Python代碼編輯控件。
2.1 添加程序集
在nuget.org搜索AvalonEdit, 為Rapid.CAX和Rapid.ScriptPy.Plugin增加程序集引用:
2.2 添加編輯器控件
在MainWindow.xaml中三維控件顯示窗口后增加腳本編輯器:
<ad:LayoutPanel Orientation="Vertical">
<ad:LayoutDocumentPane IsMaximized="True">
<ad:LayoutDocument Title="Python腳本" CanClose="False">
<!--Script Editor-->
<avalonEdit:TextEditor
xmlns:avalonEdit="http://icsharpcode.net/sharpdevelop/avalonedit"
Name="textEditor"
SyntaxHighlighting="Python"
FontFamily="Consolas"
FontSize="12pt" HorizontalScrollBarVisibility="Auto" VerticalScrollBarVisibility="Auto"/>
</ad:LayoutDocument>
</ad:LayoutDocumentPane>
</ad:LayoutPanel>
編譯並運行:
可以看到,我們的程序輕輕松松就具備了Python語法高亮的能力。
當然AvalonEdit也具備提示、代碼塊折疊等高級功能。
3 集成腳本
我們的目標是在Rapid.ScriptPy.Plugin中運行腳本,首先需要為MainWindow暴露獲取TextEditor的方法:
public partial class MainWindow
{
...
public ICSharpCode.AvalonEdit.TextEditor GetTextEditor()
{
return this.textEditor;
}
...
}
響應運行命令:
public partial class ScriptRibbonTab
{
//...
private void OnExecuteCommand(object sender, ExecutedRoutedEventArgs e)
{
switch (e.Parameter.ToString())
{
case "runPy":
{
var textEditor = MainWindow.Instance()?.GetTextEditor();
if(textEditor?.Text?.Length > 0)
{
AnyCAD.Py.PyScript.Instance().Run(textEditor?.Text);
}
}
break;
}
}
}
使用AnyCAD.Py.PyScript.Instance().Run(content)可以直接運行腳本內容。AnyCAD.Py.PyScript.Instance().RunFile(filePath)可以運行文件內的腳本。
編譯運行,測試一下:
box = AnyCAD.ShapeBuilder.MakeBox(AnyCAD.GAx2(), 1,1,1)
theViewer.ShowTopoShape(box, None)
theViewer.RequestUpdate(AnyCAD.EnumUpdateFlags_Scene)
4 總結
從最近的編程語言排行榜來看,Python語言高居榜首。為程序增加Python腳本支持,可以大大降低二次開發的門檻。基於AnyCAD開放的Python API,可以方便地使用Python腳本來創建模型、分析模型。
AvalonEdit是一個非常棒的代碼編輯控件,我們后續可以進一步完善智能提示、代碼塊折疊等高級功能,提供用戶體驗。
本文相關代碼:https://gitee.com/anycad/RapidCAX/tree/new-ui/
5 相關鏈接
[1] AvalonEdit: http://avalonedit.net/documentation/
[2] .NET6: 開發基於WPF的摩登三維工業軟件 (6)
[3] .NET6: 開發基於WPF的摩登三維工業軟件 (5)
[4] .NET6: 開發基於WPF的摩登三維工業軟件 (4)
[5] .NET6: 開發基於WPF的摩登三維工業軟件 (3)
[6] .NET6: 開發基於WPF的摩登三維工業軟件 (2)
[7] .NET6: 開發基於WPF的摩登三維工業軟件 (1)
[8] 本文代碼gitee/anycad/RapidCAX/