Python SolidWorks 二次开发---SolidWorks插件(addin)的实现,增加SolidWorks菜单项

Python SolidWorks 二次开发—SolidWorks插件(addin)的实现,增加SolidWorks菜单项



前言

上次我们用Python实现了创建属性页的功能,这次我们用python实现插件功能,在SolidWorks工具中的插件都需要加载dll来实现,Python无法直接实现生成dll的功能,但是也可以实现插件的功能,这里就简单演示一个用Python实现的菜单项,并点击菜单项能实现相应的功能,实现过程其实是类似属性页面的创建的,只是略有不同,依然是在SolidWorks2022上测试完成的。友情提醒下,要实现商业插件的,不建议用Python通过COM实现,因为COM实现的过程有很多坑。


第一步,创建com接口

Python创建com接口其实非常简单,以下为一个简单是示例

  • reg_clsid 是随机生成的
  • reg_progid 是自己定义的名称
  • public_methods 是需要公开的方法

其中_reg_clsid_ 可以使用print(pythoncom.CreateGuid())随机生成。
将以下代码拷贝到PropertyManagerPageHandler.py文件中,直接运行后就完成了com的注册,注册时需要管理员身份,否则后期可能无法调用。注册执行一次就可以了,后面可直接修改此文件即可,不用重复注册。

#SldAddin.py

# 创建com接口
class SldAddin:
    _public_methods_ = ["testfun"]
    _reg_clsid_ = "{F155709E-EAB4-4EA5-9B41-479702905241}"
    _reg_progid_ = "mycom.sldaddin"

    def testfun(self,arg):
        print('com测试')
        print(f'com测试,{arg}')

if __name__=="__main__":
    # 注册接口
    import win32com.server.register
    win32com.server.register.UseCommandLine(SldAddin)

第二步,com接口测试

新建main.py文件,拷贝以下代码后,运行,即可在终端看到运行后的结果。

    pagehandler=win32com.client.Dispatch("mycom.SldAddin")
    pagehandler.testfun('我是第一个参数')

运行以上代码终端显示的结果,可以看到com的函数已经成功运行,并传递了参数,实现了我们想要的结果
在这里插入图片描述

第三步,关联com接口和属性页

上面第二步只是测试了接口是否正常,接力来将逐步实现属性的各项功能,先删除main.py中的代码,将以下代码拷贝到main.py中

#main.py

import win32com.client
import pythoncom

def main():
    # SolidWorks年份版本
    sldver=2022
    # 建立com连接,如只有一个版本,可以只写"SldWorks.Application"
    swApp=win32com.client.Dispatch(f'SldWorks.Application.{sldver-1992}')
    # 提升API交互效率
    swApp.CommandInProgress =True
    # swApp.SendMsgToUser('就是我被点击了')
    # 显示SolidWorks界面
    swApp.Visible =True
    # 获取接口对象
    sldaddin=win32com.client.Dispatch('mycom.sldaddin')
    # 给插件设置接口
    res=swApp.SetAddinCallbackInfo2(0, sldaddin, 1)
    # 获取插件
    iCmdMgr = swApp.GetCommandManager(1)
    errors=win32com.client.VARIANT(pythoncom.VT_BYREF | pythoncom.VT_I4, -1)
    # 创建菜单
    cmdGroup = iCmdMgr.CreateCommandGroup2(1, "python插件", "", "", -1,True,errors)
    # 创建子菜单
    cmdIndex0 = cmdGroup.AddCommandItem2("第一个命令", 
                                         -1,"","",0, "hellosld", "", 0, 1)
    # 显示菜单
    cmdGroup.Activate
    while True:
        pythoncom.PumpWaitingMessages()   

if __name__=="__main__":
    main()

第四步,显示属性页

运行第三步中的代码,将会在SolidWorks中看到在工具菜单下增加了python插件菜单,此时点击第一个命令不会有任何效果在这里插入图片描述

第五步,修改SldAddin.py

将第一步创建的SldAddin.py文件内容修改如下,注意,这里要再以管理员身份运行下此文件,主要是为了注册ISwAddin接口

#SldAddin.py

from win32com import universal

universal.RegisterInterfaces("{C71C31CD-898C-11D4-AEF6-00C04F603FAF}", 0, 30,0, ["ISwAddin"])
# 创建com接口
class SldAddin:
    _com_interfaces_ = ["ISwAddin"]
    _public_methods_ = []
    _reg_clsid_ = "{F155709E-EAB4-4EA5-9B41-479702905241}"
    _reg_progid_ = "mycom.sldaddin"

if __name__=="__main__":
    # # 注册接口
    import win32com.server.register
    win32com.server.register.UseCommandLine(SldAddin)

第六步,继续修改SldAddin.py

增加两个函数,一个是用来接受当前运行的swapp的,一个是实现"第一个命令"的函数

#SldAddin.py

def getswapp(self,swapp):
    self.swapp=swapp
        
def hellosld(self):
    self.swapp.SendMsgToUser('hello solidworks')

同时将以上两个函数添加到_public_methods_中去

#SldAddin.py

_public_methods_ = ['getswapp','hellosld']

第七步,修改main.py

主要增加getswapp函数的调用,将swapp对象传递给com,这里要注意下第六步定义的hellosld函数的名称其实是来自 cmdGroup.AddCommandItem2(“第一个命令”,-1,“”,“”,0, “hellosld”, “”, 0, 1)中的,一定要和第六个参数名称一致,参数的详细说明可以看API帮助文档。

#main.py
sldaddin.getswapp(swApp)

第八步,查看运行结果

设置完成后再次运行,点击第四步出现的第一个命令,就会弹出以下的对话框,内容就是第六步定义的内容。
在这里插入图片描述

注:如果运行后报错"AttributeError: ‘PyIDispatch’ object has no attribute ‘SendMsgToUser’",则将第六步定义的函数修改下,修改后的代码如下,这个错误之前的文章也都说过如何解决,另外不是每个版本都会报错:

#SldAddin.py

def getswapp(self,swapp):
    self.swapp=win32com.client.Dispatch(swapp)

总结:至此用Python创建的SolidWorks插件(addin)的实现,增加SolidWorks菜单项就完成了,可以在此基础上增加自己想要的功能。以下为两个文件的源码。

  • PropertyManagerPageHandler.py文件源码
#SldAddin.py

from win32com import universal
import win32com.client
universal.RegisterInterfaces("{C71C31CD-898C-11D4-AEF6-00C04F603FAF}", 0, 30,0, ["ISwAddin"])
# 创建com接口
class SldAddin:
    _com_interfaces_ = ["ISwAddin"]
    _public_methods_ = ['getswapp','hellosld']
    _reg_clsid_ = "{F155709E-EAB4-4EA5-9B41-479702905241}"
    _reg_progid_ = "mycom.sldaddin"
    
    def getswapp(self,swapp):
        self.swapp=win32com.client.Dispatch(swapp)
    
    def hellosld(self):
        self.swapp.SendMsgToUser('hello solidworks')


if __name__=="__main__":
    # # 注册接口
    import win32com.server.register
    win32com.server.register.UseCommandLine(SldAddin)

  • main.py文件源码
#main.py

import win32com.client
import pythoncom
from swconst import constants
def main():
    # SolidWorks年份版本
    sldver=2022
    # 建立com连接,如只有一个版本,可以只写"SldWorks.Application"
    swApp=win32com.client.Dispatch(f'SldWorks.Application.{sldver-1992}')
    # 提升API交互效率
    swApp.CommandInProgress =True
    # swApp.SendMsgToUser('就是我被点击了')
    # 显示SolidWorks界面
    swApp.Visible =True
    # 获取接口对象
    sldaddin=win32com.client.Dispatch('mycom.sldaddin')
    sldaddin.getswapp(swApp)
    # 给插件设置接口
    res=swApp.SetAddinCallbackInfo2(0, sldaddin, 1)
    # 获取插件
    iCmdMgr = swApp.GetCommandManager(1)
    errors=win32com.client.VARIANT(pythoncom.VT_BYREF | pythoncom.VT_I4, -1)
    # 创建菜单
    cmdGroup = iCmdMgr.CreateCommandGroup2(1, "python插件", "", "", -1,True,errors)
    # 创建子菜单
    cmdIndex0 = cmdGroup.AddCommandItem2("第一个命令", 
                                         -1,"","",0, "hellosld", "", 0, 1)
    # 显示菜单
    cmdGroup.Activate
    while True:
        pythoncom.PumpWaitingMessages()   

if __name__=="__main__":
    main()

### 使用Python进行SolidWorks二次开发 #### 建立PythonSolidWorks之间的关联 为了使Python能够控制和操作SolidWorks,需要建立两者间的连接。这通常涉及到使用COM(Component Object Model)技术来创建SolidWorks的应用程序对象实例[^2]。 ```python import win32com.client as win32 swApp = win32.Dispatch('SldWorks.Application') ``` 这段代码展示了如何利用`win32com.client`库启动并获取到SolidWorks应用的对象引用,从而为进一步的操作打下基础。 #### 创建简单的自动化脚本 一旦建立了上述链接之后,就可以编写一些基本的命令来执行诸如打开文件、保存文档等常见任务。下面是一个简单例子: ```python def open_and_save_solidworks_file(file_path, save_as=None): swDoc = None try: # 打开指定路径下的模型文件 swDoc = swApp.OpenDoc6( file_path, 1, 0, "", 0, 0) if not swDoc is None and isinstance(save_as, str): # 如果指定了新的保存位置,则另存为新文件 swDoc.SaveAs3(save_as, 0, False) finally: if not swDoc is None: swDoc.Close() ``` 此函数接收两个参数:一个是现有零件或装配体的位置;另一个可选参数用于指示是否要将该文件另存为其他名称。它会尝试加载给定路径中的文件,并在必要时将其重命名存储。 #### 添加自定义菜单项 除了直接调用API外,还可以扩展SolidWorks界面,在其中加入自己的功能按钮或者子菜单选项。这里给出了一种方法来向SolidWorks添加一个新的菜单条目[^3]: ```python from win32com.client import DispatchWithEvents class AddInHandler(object): def OnConnect(self, ThisAddInInst, ConnectMode): self.swApp = ThisAddInInst.Parent commandManager = self.swApp.GetCommandManager(0) newMenuId = commandManager.AddMenuItem(-1,"My Custom Menu", "Click Me!") print(f"Added menu item with ID {newMenuId}") addin_handler_instance = AddInHandler() DispatchWithEvents(ThisAddInInst, addin_handler_instance) ``` 以上代码片段实现了当插件被激活时自动注册一个名为"My Custom Menu"的新菜单入口,并为其分配了一个回调事件处理器以便后续处理用户的点击动作。 #### 遍历零部件结构树 对于复杂的装配体而言,可能还需要遍历内部组件的信息。以下是采用递归方式访问所有子节点的方法之一[^4]: ```python def traverse_components(component_system, indent_level=0): prefix = ' '*indent_level*4 comp_name = component_system.Name2 print(prefix + f"- Component Name: '{comp_name}'") sub_comps = component_system.GetChildren() for sc in sub_comps: traverse_components(sc, indent_level+1) active_doc = swApp.ActiveDoc if active_doc.GetType() == 3: # Check if it's an assembly document type (AssemblyDocumentType = 3) root_comp_sys = active_doc.ComponentSystem traverse_components(root_comp_sys) else: print("Current document isn't an Assembly.") ``` 这个过程从当前活动窗口所指向的那个顶层实体开始逐层深入打印出每一个组成部分的名字及其层次关系。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值