使用VBA进行solidworks开发指南.doc

.目录 第1章概述2 1.1内容简介2 1.2名词解释2 1.3预备知识3 第2章录制、编辑、运行宏3 2.1录制、编辑、运行宏基本步骤：3 2.2一些基本的建议：3 第3章代码格式及帮助信息5 3.1代码格式：5 3.2获得帮助：6 第4章常用对象模型7 4.1综述：7 4.2 SldWorks.SldWorks :8 4.3 SldWorks.ModelDoc2：8 4.4 SldWorks.PartDoc、SldWorks.AssemblyDoc、SldWorks.DrawingDoc：9 4.5 SldWorks.feature、SldWorks.Sketch ：9 第5章零件 PartDoc9 5.1综述：9 5.2选择对象的话题：10 5.3访问并修改特征:12 5.4草图的话题：17 第6章装配体18 6.1综述：18 6.2组件的话题：插入零部件到装配体19 6.3配合的话题：在装配体中添加配合22 6.4由于说到参考，顺便讨论一下配合参考：26 第7章工程图28 7.1综述：28 7.2注释的话题：29 7.3生成图纸的话题：并讨论如何解决实际问题30 第8章总结：40 第1章 概述1.1 内容简介Solidworks在提供了强大的三维建模功能的同时，也为使用者提供了开放的应用程序编程接口（API），通过调用这些API，我们可以将solidworks中一些重复单调或者规则明确的操作使用程序语言描述，通过简单的人机交互，让计算机自己来完成此类工作。掌握了此类本领，可以在以后的工作中，开阔自己的视野，更加深入的了解软件本身工作的原理，并且，改善自己的工作，提高工作效率和质量。本文旨在总结作者工作中获得的经验，专注于solidworks软件本身特点，文章中示例的代码基本上使用了vb语言描述，选择vb语言是因为其语法简单易懂，并且和应用程序间有很明朗的接口不需要再学习其它技术（如果使用c+,可能需要读者拥有COM知识）。Solidworks提供了极其丰富的API，并且有很完善的帮助系统。我们可以使用 Microsoft VBA编写SolidWorks Macros或者使用其他编程环境编写Standalone and Add-in Applications。（使用visual studio到.NET都可以）在SW的API帮助中我们可以很明了的查看API调用语法及相关的示例代码。本文不可能对每一个API进行细致的解释，在后面章节主要指导大家如何使用软件提供的帮助来在需要时得到有用信息的手段。本文所有API和代码都以solidworks2005 sp0.0 版本为准。1.2 名词解释API ：应用编程接口Application Programming Interface对象：即计算机抽象出来的一种事物，在面向对象的程序设计中它表示由数据和与该数据关联的操作组成的类的具体实现。属性：对象所具有的属性，识别及说明对象的特性。方法：对象可以使用的对数据的操作。1.3 预备知识首先我们的读者应该有简单的VB经验。当然如果没有也可以临时抱佛脚（VB语句是直观易懂的），边看代码边学习。很好的掌握SW中宏的录制功能多阅读API帮助中的示例代码，是自学的最佳途径（虽然SW的宏录制功能相比EXCEl来说代码不是很清晰）。 其次solidworks软件应该非常熟练，读者应该有使用solidworks实际建模的经验，这是能够写出良好代码的基础。否则看到一些对象名称也不能了解它对应了软件的那个功能。 如果英文不够好，请准备及时词典，如金山词霸等。Solidworks提供的API帮助是纯英文的，solidworks汉化的还不错，不明白为什么不顺便把API帮助也翻过来。 准备好，我们可以开始了. 第2章 录制、编辑、运行宏2.1 录制、编辑、运行宏基本步骤：开始solidworks编程的最快方式就是录制宏。宏可以记录用户的操作将其记录为一系列solidworksAPI的调用。在solidworks“工具”菜单“宏”中有运行、录制、新建、编辑等选项。我们选择“录制”来开始记录用户操作，选择“停止”来结束宏的录制。结束后会提示保存宏文件，其后缀名为.swp。（估计是solidworks program的意思吧）。录制到停止间对solidworks进行的操作都将记录到宏文件中。但是直接录制的宏程序的可用性很差，我们需要对它进行一些合理的优化，清理多余的语句，所以在录制完成宏之后需要编辑它。编辑宏的时候，选择“工具”菜单“宏”中的“编辑”，此时提示你选择要编辑的宏文件（swp文件）。选择后进入编辑界面（其实就是VBA的编辑器，叫集成环境也行）。需要说明的是，如果之前你在excel、word等软件中录制过宏程序，那么可能solidworks录制宏中的垃圾数据要更多些。2.2 一些基本的建议：Solidworks在帮助中也有一个大体的介绍，在编辑一个新录制的宏时可以需要删除下面的多余代码（Delete extra lines of code）: 1、The following variables are declared automatically in a SolidWorks macro. Delete any variables not used in the macro. SolidWorks对象的声明是自动产生的，可以将没用到的删除 2、Delete all lines of code that change the view. 删除切换视图的代码 arden says：像这样的 Part.ActiveView().RotateAboutCenter 0.0662574, 0.0346621 无情的删掉吧 3、Delete all ModelDocExtension:SelectByID2 calls appearing immediately before ModelDoc2:ClearSelection2 calls. However, do not delete ModelDocExtension:SelectByID2 calls appearing immediately after ModelDoc2:ClearSelection2 calls. Delete all ModelDoc2:ClearSelection2 calls appearing immediately before ModelDocExtension:SelectByID2. 删除所有紧挨ModelDoc2:ClearSelection2之前的ModelDocExtension:SelectByID2调用，不要删除紧挨ModelDoc2:ClearSelection2调用后的ModelDocExtension:SelectByID2。删除所有紧挨ModelDocExtension:SelectByID2之前的ModelDoc2:ClearSelection2。 下图为VBA的集成编辑环境：编辑完成后，按照程序的要求来运行宏，在VBA编辑器中点“运行”开始执行程序，需要注意，有些宏程序的运行有前提条件，比如需要事先选择好一个特征等。第一次运行不一定成功，这时候就要对宏代码进行调整，反复一个编辑代码、测试运行的循环，最后得到比较满意的结果。加载宏到solidworks有很多种方法我们只介绍最简单的三种：快捷键、菜单、工具栏按钮。可以参考文档SW技术文档-2005041402-加载宏到solidworks的三种方法.doc 第3章 代码格式及帮助信息3.1 代码格式：这章中，我们给出一段完成简单功能的代码，并讨论如何从帮助中获得有用信息。 首先，打开soliworks，选择“工具”、“宏”、“新建”，给新的宏文件起名字为“openprt.swp”。清空vba编辑器中的内容，拷贝或者输入下面的代码，保存。 - Preconditions: None Postconditions: Specified document is opened. - Option Explicit Dim swApp As SldWorks.SldWorks Dim fileerror As Long Dim filewarning As Long Sub main() Set swApp = Application.SldWorks swApp.Visible = True swApp.OpenDoc6 "d:/samples/hotrod.sldprt", swDocPART, swOpenDocOptions_Silent, "", fileerror, filewarning End Sub 上面的代码来自solidworksAPI帮助，它打开d:/samples/目录下的零件文件hotrod.sldprt。我们来分别解释一下上面代码的内容：- Preconditions: None Postconditions: Specified document is opened. - 注释：注释块说明了程序运行的上下文：前提条件（Preconditions）为：无 NONE ；运行结果为：打开指定的文件。API帮助中的示例都有这样的格式，需要大家在使用时注意其上下文约束条件。 Option Explicit Dim swApp As SldWorks.SldWorks Dim fileerror As Long Dim filewarning As Long 声明变量和对象：swapp为一个solidworks应用程序对象。其它两个为long型整数，用来保存错误和警告id。 Sub main()这是主过程，以main为名称。 Set swApp = Application.SldWorks刚才的DIM语句只是声明了对象swapp，现在使用SET定义对象 swApp.Visible = True设置应用程序可见 swApp.OpenDoc6 "d:/samples/hotrod.sldprt", swDocPART, swOpenDocOptions_Silent, "", fileerror, filewarning 打开文件d:/samples/hotrod.sldprt 。 End Sub 3.2 获得帮助：当我们想从这个示例代码中了解打开一个文件的细节时，我们需要OpenDoc6函数的参考，可以在索引或者搜索中查找OpenDoc6，得到如下信息（汉字为我的注释）： Description：描述此API完成的功能 This method opens an existing document and returns a pointer to the document object. It also allows control over whether or not to:此方法打开一个已经存在的文档并返回指向此文档对象的指针。它在打开文档时允许做下面控制： Suppress displaying dialog boxes 禁止对话窗口 Open the document read-only只读打开 Open the document view-only只看打开 Convert a drawing to a detached drawing将工程图转换为断开的工程图 Syntax (OLE Automation) 语法： retval = SldWorks.OpenDoc6 ( filename, type, options, configuration, &Errors, &Warnings ) Input: (BSTR) Filename Document name or full path if not in current directory, including extension文件全路径 Input: (long) Type Document type as defined in swDocumentTypes_e 文档类型 Input: (long) Options Mode in which to open the document as defined in swOpenDocOptions_e 打开选项 Input: 输入 (BSTR) Configuration Model configuration in which to open this document 配置设置 Applies to parts and assemblies, not drawings 只在零件和装配体适用 If this argument is empty or the specified configuration is not present in the model, the model is opened in the last-used configuration. 如果未指定任何配置将使用最后一次打开的配置。 Output:输出 (long) Errors Load errors as defined in swFileLoadError_e 打开错误 Output: (long) Warnings Warnings or extra information generated during the open operation as defined in swFileLoadWarning_e 打开警告 Return:返回 (LPDISPATCH) retval Pointer to a Dispatch object, the newly loaded ModelDoc2, or NULL if failed to open Remarks备注： When opening a parent document (assembly, drawing, and so on): SolidWorks also opens any additional documents that are referenced in the parent document (parts, subassemblies, and so on). SolidWorks follows certain rules in trying to locate its referenced documents. If explicit Search Folders have not been set using Tools, Options, System Options, ExternalReferences, then the first place SolidWorks looks for the referenced documents is in the current working directory. If SolidWorks finds the referenced file in the current working directory, then it is loaded from that directory. 我们应该具备的素质就是，可以按照上面的参考内容明白API的使用方法和规则。而我们常常需要注意的焦点是语法（Syntax）知道需要输入什么参数返回什么对象就基本OK了，不要被前面一片英文所迷惑。 最后我们介绍一下API帮助的目录： Solidworks 2005 API Release Notes ：此文档树下为sw2005版本的新特性：新对象新函数等 Programmers Guide ：此文档树目录下为sw编程向导，提供了开始编程的向导、sw对象模型总揽和实际编程中的注意事项等内容。 Examples ：此文档树目录下为sw所有示例工程，分为c+和VB两中语言大类。我们经常需要访问的地方。 APIs ：sw提供的所有API定义及参考。 Obsolete APIs ：sw已过时的API。 第4章 常用对象模型4.1 综述：学会录制宏代码，并从帮助中得到代码中API使用方法后，我们介绍一些常用的对象模型，并给出一些使用方法。这些对象是sw最基本的对象，几乎所有程序都会使用其中的几种，也是我们可以很直观想象到的对象模型： 4.2 SldWorks.SldWorks : 此对象代表solidworks应用程序。我们可以使用此对象进行应用程序层面的操作：打开、保存、关闭文档；设置用户界面的状态等等。一般来说我们的sw程序总是首先定义此对象才能进行其他的操作： 声明和定义示例： Dim swApp As SldWorks.SldWorks Set swApp = Application.SldWorks 或者 Dim swApp As SldWorks.SldWorks Set swApp = CreateObject("SldWorks.Application") 调用属性或方法示例： swApp.Visible = True swApp.OpenDoc6 "d:/samples/hotrod.sldprt", swDocPART, swOpenDocOptions_Silent, "", fileerror, filewarning 4.3 SldWorks.ModelDoc2：此对象代表solidworks的文档。Solidworks有三种最基本的文件格式：零件、装配体、工程图。它们各自都有自己特定的对象来表示，但是solidworks设定了一些通用的方法和属性来操作这些对象。ModelDoc2对象可以直接对这三类文件进行操作。 声明和定义示例： Dim swmodel As SldWorks.modeldoc2 Set swmodel = swapp.OpenDoc6 "d:/samples/hotrod.sldprt", swDocPART, swOpenDocOptions_Silent, "", fileerror, filewarning 打开文档 或者 Dim swmodel As SldWorks.modeldoc2 Set swmodel = swapp.activedoc 得到当前文档 调用属性或方法示例： swmodel.GetPathName得到模型的路径 4.4 SldWorks.PartDoc、SldWorks.AssemblyDoc、SldWorks.DrawingDoc： 上面三个对象分别代表solidworks三种文件格式。使用它们来操作相应类型的文件。 声明和定义示例： Dim swpart As SldWorks.PartDoc Dim swasm As SldWorks.AssemblyDoc Dim swdraw As SldWorks.DrawingDoc Set swpart=swmodel Set swasm = swapp.OpenDoc6 "d:/samples/hotrod.sldasm", swDocPART, swOpenDocOptions_Silent, "", fileerror, filewarning Set swdraw =swapp.activedoc 调用属性或方法示例： swpart.MirrorFeature 镜像特征 swasm.AddMate2 添加配合 swdraw.NewSheet3 插入新图纸 4.5 SldWorks.feature、SldWorks.Sketch ： 代表solidworks中的特征和草图对象。 还有很多对象在此就不再介绍，下面的三章将针对零件、装配体和工程图分别讨论。 第5章 零件 PartDoc5.1 综述：零件是sw基本文件类型之一，我们可以通过此对象创建新零件、得到零件的各种、信息控制零件中的特征属性等等。下面是PartDoc的对象模型： 我们知道特征是组成一个零件的基本对象。但是从上图我们可以看出来，特征对象并不是在零件对象下层的。察看API帮助我们知道，特征是在Modeldoc对象下。在Partdoc下只能对实体对象（Body2）进行操作。所以很多对零件进行的操作，我们需要使用Modeldoc对象。 5.2 选择对象的话题： 首先来学习两个API，这两个API完成选择对象和得到所选择对象的功能： SelectByID2和GetSelectedObject5这两个函数，第一个通过给出对象的name选择对象。第二个通过启用程序前已经选择的索引得到对象。其中的SelectByID2基本上在sw录制宏时所作的选择操作都是用了这个API，但它的局限性在于，程序需要知道所要选择对象的名称、类型（在swSelectType_e中定义）并且函数并不返回所选择对象而是一个执行状态。如果想得到我们刚才选择的对象，则需要用到另一个函数GetSelectedObject5。 使用GetSelectedObject5之前需要介绍一下SelectionMgr对象：此对象允许你得到所选择对象的信息，对其进行一些操作。GetSelectedObject5就是SelectionMgr对象的一个方法。可以使用ModelDoc2.SelectionManager来得到一个SelectionMgr对象。并且需要注意的是sw将所选择的对象进行了索引，我们可能同时选中了多个对象，通过GetSelectedObject5(index)中得index值来得到不同的选择对象。 看下面程序，它使用SelectByID2将当前打开的模型文件中的特征“拉伸1”选中，如果选择成功的话再使用GetSelectedObject5得到此特征： + Filename Selefeat.swp : Select feature”拉伸1” + Option Explicit Dim swApp As SldWorks.SldWorks Dim Model As ModelDoc2 Dim feature As feature 定义一个特征对象 Dim boolstatus As Variant 定义api返回值 Sub main() Set swApp = Application.SldWorks Set Model = swApp.ActiveDoc 前面已经介绍，上面两句话基本上是固定模式 选择叫"拉伸1"的特征 boolstatus = Model.Extension.SelectByID2("拉伸1", "BODYFEATURE", 0, 0, 0, False, 0, Nothing, swSelectOptionDefault) 主要就是这一句话，在写Option Explicit后函数的最后一个参数swSelectOptionDefault可以使用0来代替 If boolstatus = True Then 如果有“拉伸1”这个特征下面的代码将其选中 Dim SelMgr As SelectionMgr 声明一个selectionmgr 对象 Set SelMgr = Model.SelectionManager 得到当前模型的选择对象 Set feature = SelMgr.GetSelectedObject5(1) 此处使用一个索引来得到特征 Debug.Print feature.Name 在立即窗口 打印 特征的name属性 Else Debug.Print "Error" End If End Sub 两个函数的VB语法表述如下，具体请参考API帮助： ModelDocExtension:SelectByID2 Syntax (OLE Automation) retval = ModelDocExtension.SelectByID2 ( Name, Type, X, Y, Z, Append, Mark, Callout. SelectOption ) SelectionMgr:GetSelectedObject5 Syntax (OLE Automation) retval = SelectionMgr.GetSelectedObject5 ( AtIndex ) 在选择对象这个话题中我们还要讨论几个API：ModelDoc2:ClearSelection2 此API清空SW的选择列表，即取消所有选择。还有activate系列：retval = SldWorks.ActivateDoc2 ( name, silent, &errors ) 激活文档 retval = DrawingDoc.ActivateSheet( SheetName )激活工程图纸 retval = DrawingDoc.ActivateView ( viewName)激活视图 void ModelDoc2.ActivateSelectedFeature ()激活选中特征 选择的话题就到这里结束。上面有一处关于swSelectOptionDefault的注释大家可能会有疑惑，这里附加上对solidworks API中定义Enum的介绍。为了让API的参数更直观，swAPI中有很多类似的enum定义，它将一系列小整数和字符串描述符对应，在api的语法参考中都描述了相应的代表对象。具体实现细节需要参考VB的语法，这里我们需要明白，如果你在程序前面定义了Option Explicit（强制声明）选项，那你需要在使用这些enum时候定义它或使用不直观的整数作为参数。 Public enum swDocumentTypes_e 这是一个sw文档类型的列举项 swDocNONE=0什么也不是 swDocPART=1零件类型 在做为参数时 使用1和使用swDocPART效果是相同的，只是swDocPART意义更加明显 swDocASSEMBLY=2装配体类型 swDocDRAWING=3工程图类型 End Enum 5.3 访问并修改特征:我们已经学习了如何选中一个对象，下面我们针对特征来讨论如何得到选中特征对象的属性并修改它。getchoosed.swp得到所选择特征的一些属性信息： + filename : getchoosed.swpdate :2005-03-22used to get the simple hole infomation dep & dia+ Option ExplicitDim swApp As SldWorks.SldWorksDim Model As ModelDoc2Dim curfeature As featureDim boolstatus As BooleanDim featdata As SimpleHoleFeatureData2 声明一个简单直孔特征数据对象Dim component As Component2 声明一个组件对象Dim dep As Double孔深Dim dia As Double孔径Dim SelMgr As SelectionMgr选择管理器Dim ncount As Integer Sub getselected() Set swApp = Application.SldWorks Set Model = swApp.ActiveDoc Set SelMgr = Model.SelectionManager Set curfeature = SelMgr.GetSelectedObject5(1) 得到当前选中的第一个特征 Debug.print curfeature.NameSet featdata = curfeature.GetDefinition 得到特征的定义 boolstatus = featdata.AccessSelections(Model, component) 可以对数据进行访问了 ncount = featdata.GetFeatureScopeBodiesCount 此方法得到拉伸特征在多实体零件中所作用的实体数 Debug.print ncount dep = featdata.Depth 访问属性depth 和 diameterdia = featdata.Diameter Debug.print dia & "*" & dep Debug.print "error arden"在solidworks中可以使用swAPP.sendmsgtouser2 替代msgboxfeatdata.ReleaseSelectionAccess 取消特征数据访问Model.SaveModel.EditRebuild 重建模型End Sub 上面程序运行前，假设你选择了一个简单直孔特征。然后得到这个孔的一些参数：孔深、直径。最初做上面程序的时候，我想象中用Set curfeature = SelMgr.GetSelectedObject5(1)选中特征以后就可以直接curfeature. Depth了。在参考了API帮助后，我才了解到特征的数据需要先AccessSelections后才能访问。总结一下，要访问一个特征，需要经历这样的步骤： 定义一个特征对象及特征数据对象： dim.as . 选中这个特征 ：比如使用GetSelectedObject5 还有SelectebyID等. 得到特征的定义：GetDefinition 进行访问：AccessSelections 上面的程序没有if选择的容错机制，实际编码中，每个可能出现错误的地方都应该使用if来控制，如下面这句话boolstatus =featdata.AccessSelections(Model, component)。我们就需要通过boolstatus的值来判断上面这个语句运行的是否正确，这里的boolstatus很明显是一个布尔型变量： If not boolstatus then 上面语句运行不成功，写错误报告或退出代码 Endif 已经可以访问特征的各参数了，现在我们来修改它： 要修改前面的步骤不能少，当我们已经可以读取一些特征时，我们就可以给他设定一些值。当然有时需要调用特定的参数。solidworks是ole和com的，所以要习惯这样。 在修改完特征后需要调用函数modifydefinition()来实现变化。 我们给一个例子，这个例子比前面的都要全面，它有很好的容错引导机制，可以直接拿来成为一个稳定的宏程序。 + filename : doubleBE.swpdate :2005-03-22 This example doubles the length of the base extrude.这个例子将拉伸凸台的长度增加一倍+ Dim swApp As SldWorks.SldWorks Dim Model As ModelDoc2 Dim Component As Component2 Dim CurFeature As feature Dim isGood As Boolean Dim FeatData As Object 先声明为object，后面自动匹配为 ExtrudeFeatureData 对象 Dim Depth As Double Dim SelMgr As SelectionMgr Sub doubleBE() Set swApp = CreateObject("sldWorks.application") Set Model = swApp.ActiveDoc 确定model是零件或正配体，不是就退出。在这里swDocPART 和swDocASSEMBLY如果不能通过编译则参考 上面的enum介绍，换为1和2 If Model.GetType <> swDocPART And Model.GetType <> swDocASSEMBLY Then Msg = "Only Allowed on Parts or Assemblies" Define message Style = vbOKOnly OK Button only Title = "Error" Define title Call MsgBox(Msg, Style, Title) Display error message Exit Sub Exit this program End If 得到 Selection Manager Set SelMgr