CAA用户界面开发——实例说明(CATIA二次开发).doc

用户界面开发实例说明Creating a Workbench一、目标1.1 目标Showing how to create a workbench to be added to a given workshop. 1.2 显示界面（workbench ）Like the workshop, the workbench is an object that gathers the commands to work on the document and arrange them in toolbars and menus. 1.3 命令标签（command header）Command headers are used to make the link between the workbench and the commands.二、CAAAfrGeoCreationWbench实例说明2.1 功能The CAAAfrGeoCreationWbench use case creates a workbench named CAA Geometrical Creation for the CAAGeometry document. Its specifications cover most of the cases you will meet. Two toolbars are provided:The Solids toolbar. It includes five new commands: Cuboid, Sphere, Torus, and Cylinder 1 and 2.The Surfaces toolbar. It includes three new commands: Revolution Surface, Nurbs Surface, and Offset Surface.The only change in the menu bar is the addition of these commands in the Insert menu using two submenus below the existing ones.2.2 运行运行CATIA系统，并依次选择Start-Infrastructure-CAA V5: Geometrical Creation： This creates a new CAAGeometry document with the CAA V5: Geometrical Creation workbench active. 2.3 框架组成CAAAfrGeoCreationWkbWorkbench description classCAAAfrGeoCreationWkbFactoryFactory class for the workbench classCAAIAfrGeoCreationWkbFactoryFactory interface implemented by CAAAfrGeoCreationWkbFactoryTIE_CAAIAfrGeoCreationWkbFactoryTIE class for the factory interfaceCAAIAfrGeoCreationWkbAddinAdd-in interface exposed by the workbench and that all its add-ins must implementTIE_CAAIAfrGeoCreationWkbAddinTIE class for the add-in interface三、程序结构（Step-by-Step）3.1 编程准备3.1.1 确认 Make sure that the workshop to which it is dedicated exposes the CATIxxxConfiguration interface, where xxx is the workshop identifier, in a PublicInterfaces or ProtectedInterfaces directory. Create the module directory to store the workbench code along with its two subdirectories LocalInterfaces and src. Then you will need to create the following files. In the frameworks ProtectedInterfaces directoryCAAIAfrGeoCreationWkbAddin.hThe header file of the workbench exposed interface to enable clients to create add-insIn the CAAAfrGeoCreationWbench.mLocalInterfaces directoryCAAIAfrGeoCreationWkbFactory.hThe header file of the workbench factory interfaceCAAAfrGeoCreationWkbFactory.hThe header file of the workbench factory classCAAAfrGeoCreationWkb.hThe header file of the workbench description classIn the CAAAfrGeoCreationWbench.msrc directoryCAAIAfrGeoCreationWkbAddin.cppThe source file of the workbench exposed interface to enable clients to create add-insCAAIAfrGeoCreationWkbFactory.cppThe source file of the workbench factory interfaceCAAAfrGeoCreationWkbFactory.cppThe source file of the workbench factory classCAAAfrGeoCreationWkb.cppThe source file of the workbench description classTIE_CAAIAfrGeoCreationWkbAddin.tsrcThe file to create the TIE for CAAIAfrGeometryWksAddinTIE_CAAIAfrGeoCreationWkbFactory.tsrcThe file to create the TIE for CAAIAfrGeometryWksFactoryIn the dictionary, that is the CNextcodedictionary directory, referenced at run time using the CATDictionaryPath environment variable, create or updateCAAApplicationF.dicoThe interface dictionaryCAAApplicationF.factThe factory dictionaryIn the CNextresourcesmsgcatalog directory, referenced at run time using the CATMsgCatalogPath environment variableCAAAfrGeoCreationWkb.CATNlsThe workbench message fileCAAAfrGeoCreationWkbHeader.CATNls andCAAAfrGeoCreationWkbHeader.CATRscThe command header resource files3.1.2 开发步骤#StepWhere1Create the workbench factory interfaceLocalInterfaces and src2Create the workbench factoryLocalInterfaces and src3Create the workbench description classLocalInterfaces and src4Create the command headersCreateCommands method5Create the workbench and arrange the commandsCreateWorkbench method6Provide the resources and insert the workbench into the Start menuResource files7Create the workbench exposed interfaceProtectedInterfaces and src3.2 建立Workbench 的Factory Interface （Creating the Workbench Factory Interface）3.2.1 命名CAAIAfrGeoCreationWkbFactory3.2.2 头文件（the header file ）CAAIAfrGeoCreationWkbFactory.h#include extern IID IID_CAAIAfrGeoCreationWkbFactory;class CAAIAfrGeoCreationWkbFactory : public CATIGenericFactory CATDeclareInterface; public :;A factory interface is a CAA interface, that is, an abstract class that derives from CATIGenericFactory. As any interface, it has an IID declared as IID_ followed by the interface name, and includes the CATDeclareInterface macro that declares that this abstract class is an interface. No additional method than those of CATIGenericFactory is necessary. Dont forget the public keyword required by the TIE compiler.（？）3.2.3 源文件（The source file ）CAAIAfrGeoCreationWkbFactory.cpp#include IID IID_CAAIAfrGeoCreationWkbFactory = 0xb32eed10, 0xd4c1, 0x11d3, 0xb7, 0xf5, 0x00, 0x08, 0xc7, 0x4f, 0xe8, 0xdd ;CATImplementInterface(CAAIAfrGeoCreationWkbFactory, CATIGenericFactory);The CATImplementInterface macro is used in conjunction with CATDeclareInterface in the header file to make an interface from this abstract class and to declare that it OM-derives from CATIGenericfactory.3.2.4 TIE文件（The TIE tsrc file）TIE_CAAIAfrGeoCreationWkbFactory.tsrc #include CAAIAfrGeoCreationWkbFactory.hThe Multi-Workspace Application Builder (mkmk) will generate the TIE for this interface for you, that is, the TIE_CAAIAfrGeoCreationWkbFactory.h file in the ProtectedGenerated directory.3.3 建立Workbench 的Factory （Creating the Workbench Factory）3.3.1 注意事项The factory class that creates workbench instances must concatenate the name of the class to instantiate, that is, the workbench description class CAAAfrGeoCreationWkb, with the string Factory. This gives CAAAfrGeoCreationWkbFactory.3.3.2 头文件CAAAfrGeoCreationWkbFactory.h #include CATWorkshopConfigurationFactory.h CATDeclareConfigurationFactory(CAAAfrGeoCreationWkb);The CATDeclareConfigurationFactory macro argument is the name of the workbench description class.3.3.3 源文件CAAAfrGeoCreationWkbFactory.cpp #include #include #include CATImplementConfigurationFactory(CAAAfrGeoCreationWkb, CAAIAfrGeoCreationWkbFactory);The CATImplementConfigurationFactory arguments are the name of the workbench description class and the name of the workbench factory interface respectively. The CATDeclareConfigurationFactory and CATImplementConfigurationFactory macros create the workbench factory implementation class as a data extension of the CATApplicationFrame component3.3.4 更新字典 The interface dictionarythat is a file whose name is the framework name suffixed by dico, such as CAAApplicationFrame.dico, and that you should create or update in the framework CNext/code/dictionary directory. The interface dictionary contains the following declaration to state that the CATApplicationFrame component implements the CAAIAfrGeoCreationWkbFactory interface, by means of the extension class created by the macros, whose code is located in the libCAAAfrGeoCreationWbench shared library or DLL:（不太明白）CATApplicationFrame CAAIAfrGeoCreationWkbFactory libCAAAfrGeoCreationWbench The factory dictionarythat is a file whose name is the framework name suffixed by fact, such as CAAApplicationFrame.fact, and that you should create or update in the framework CNext/code/dictionary directory. The factory dictionary contains the following declaration to state that the CAAIAfrGeoCreationWkbFactory interface is an interface to a factory whose implementation creates a CAAAfrGeoCreationWkb class instance: CAAAfrGeoCreationWkb CAAIAfrGeoCreationWkbFactory3.4 定义与实现Workbench 类（Creating the Workbench Description Class）3.4.1 说明The CAAAfrGeoCreationWkb class implements the CATICAAAfrGeometryWksConfiguration interface exposed by the CAAGeometry workshop . It includes the following methods: CreateCommands to instantiate the command headers for the commands of the workbench CreateWorkbench to create the containers for the workbench, the menus, and the toolbars, and arrange the commands in the menus and toolbars GetCustomInterfaces which returns the names of the interfaces exposed by the workbench to enable its customization GetAddinInterface which returns the name of the interface exposed by the workbench to create add-ins. 3.4.2 头文件CAAAfrGeoCreationWkb.h#include CATBaseUnknown.h#include CATListPV.hclass CATCmdWorkbench;class CAAAfrGeoCreationWkb : public CATBaseUnknown CATDeclareClass; public: CAAAfrGeoCreationWkb(); virtual CAAAfrGeoCreationWkb(); void CreateCommands(); CATCmdWorkbench * CreateWorkbench(); CATClassId GetAddinInterface(); void GetCustomInterfaces(CATListPV * oDefaultIIDList , CATListPV * oCustomIIDList) ; private: CAAAfrGeoCreationWkb(const CAAAfrGeoCreationWkb &iObjectToCopy);The CAAAfrGeoCreationWkb class C+-derives from CATBaseUnknown. The CATDeclareClass macro declares that the class CAAAfrGeoCreationWkb belongs to a component. The class has a constructor, a destructor, the four methods of the CATIWorkbench interface, and a copy constructor. Note that the copy constructor is set as private. This prevents the compiler from creating the copy constructor as public without you know. This copy constructor is not implemented in the source file.3.4.3 源文件CAAAfrGeoCreationWkb.cpp #include #include / See Creating the Command HeadersMacDeclareHeader(CAAAfrGeoCreationWkbHeader);#include CATImplementClass(CAAAfrGeoCreationWkb, Implementation, CATBaseUnknown, CATNull);#include TIE_CATICAAAfrGeometryWksConfiguration(CAAAfrGeoCreationWkb);CAAAfrGeoCreationWkb:CAAAfrGeoCreationWkb() CAAAfrGeoCreationWkb:CAAAfrGeoCreationWkb() void CAAAfrGeoCreationWkb:CreateCommands() . / See Creating the Command HeadersCATCmdWorkbench * CAAAfrGeoCreationWkb:CreateWorkbench() . / See Creating the Workbench and Arranging the CommandsCATClassId CAAAfrGeoCreationWkb:GetAddinInterface() return CAAIAfrGeoCreationWkbAddin;void CAAAfrGeoCreationWkb:GetCustomInterfaces(CATListPV * oDefaultIIDList, CATListPV * oCustomIIDList) TIE_CATICAAAfrGeometryWksConfiguration 宏The CAAAfrGeoCreationWkb class states that it implements the CATICAAAfrGeometryWksConfiguration interface TIE_ CATImplementClass宏declaring that the CAAAfrGeoCreationWkb class is a component main class 2, thanks to the Implementation keyword, and that it OM-derives from CATBaseUnknown 2. The fourth parameter must always be set to CATNull for component main classes. 创建命令标签（Creating the Command Headers）（见命令标签）.1 命令标签Each command available in your workbench must have a command header. A command header is an instance of a command header class, and different commands can share the same command header class to create their command header. .2 创建命令标签类CAAAfrGeoCreationWkbHeader command header class is careated in CAAAfrGeoCreationWkb.cpp: #include MacDeclareHeader(CAAAfrGeoCreationWkbHeader);The MacDeclareHeader macro creates the header file and the source file for the CAAAfrGeoCreationWkbHeader class, and associates with this class the resource files CAAAfrGeoCreationWkbHeader.CATNls and CAAAfrGeoCreationWkbHeader.CATRsc. .3 定义命令标签Create the code to instantiate your command headers in the empty CreateCommands method. This method should contain one instantiation statement of the command header class per command. Each statement has the following form, for example for the Cuboid command. void CAAAfrGeoCreationWkb:CreateCommands() . new CAAAfrGeoCreationWkbHeader(CAAAfrCuboidHdr, CAADegGeoCommands, CAADegCreateCuboidCmd, (void *) NULL); . 其中：1）CAAAfruboidHdr is the identifier you need to assign to the command header. It will be used afterwards: （1）To associate the command starters you will define to put the command in a menu and in toolbars with the command header.（2）To build the variables that define the command header resources, such as the name seen by the end user in his/her own language in the menu, or the icon to display in a toolbar. 2）CAADegGeoCommands is the name of the shared library or DLL containing the Cuboid commands code, without the prefix lib, and without the suffix depending on the operating system. 3）CAADegCreateCuboidCmd is the name of the Cuboid command class 4）the last argument is the possible pointer to the object to pass to the command when executing it. It is often a character string that indicates the action to carry out when the same command can perform several actions depending on the active document and data, such as update or update all, or cut or copy. Creating the Workbench and Arranging the Commands.1 创建workbench using the NewAccess macro：CATCmdWorkbench * CAAAfrGeoCreationWkb:CreateWorkbench() NewAccess(CATCmdWorkbench,pCAAAfrGeoCreationWkb,CAAAfrGeoCreationWkb); . / See Creating the Containers for the Toolbars and the Menu Bar return pCAAAfrGeoCreationWkb;pCAAAfrGeoCreationWkb is the variable used to handle the workbench instance pointer, and CAAAfrGeoCreationWkb is the workbench identifier. Note that the workbench class name and the workbench identifier must be identical to take into account the workbench resources in the Start menu. They appear both in bold typeface. This identifier is also used to name the workbench resource files CAAAfrGeoCreationWkb.CATNls and CAAAfrGeoCreationWkb.CATRsc. The workbench resources, and how to provide them, are described in Creating Resources for Workbenches. .2 创建containers . NewAccess(CATCmdContainer,pCAAAfrSolidEltTlb,CAAAfrSolidEltTlb); SetAccessChild(pCAAAfrGeoCreationWkb, pCAAAfrSolidEltTlb); . / See Creating the Solids Toolbar Content AddToolbarView(pCAAAfrSolidEltTlb,1,Right); NewAccess(CATCmdContainer,pCAAAfrSurfacicEltTlb,CAAAfrSurfacicEltTlb); SetAccessNext(pCAAAfrSolidEltTlb,pCAAAfrSurfacicEltTlb); . / See Creating the Surfaces Toolbar Content AddToolbarView(pCAAAfrSurfacicEltTlb,-1,Right); NewAccess(CATCmdContainer,pCAAAfrGeoCreationMbr,CAAAfrGeoCreationMbr); . / See Creating the Menu Bar Content SetWorkbenchMenu(pCAAAfrGeoCreationWkb,pCAAAfrGeoCreationMbr);.其中：（1）The Solids toolbar is created as an instance of the CATCmdContainer class using the NewAccess macro. pCAAAfrSolidEltTlb is the variable used to handle the Solids toolbar command container instance pointer, and CAAAfrSolidEltTlb is the identifier used to refer to it in the workbench resource files. This identifier must be unique among all the toolbar identifiers that can be found within the application. The Solids toolbar is set as the child of the workbench using the SetAccessChild macro, and its default location is defined using the AddToolbarView macro, where 1 means that the Solids toolbar is visible by default (-1 means invisible), and Right means that the toolbar is docked at the right side of the application window. （2）The Surfaces toolbar is created in the same way, but it is set next to the Solids toolbar using the SetAccessNext macro. It is invisible (-1 means invisible) by default, and is also docked at the right side of the application window. （3）The menu bar is also created as an instance of the CATCmdContainer class and is referred to using the pCAAAfrGeoCreationMbr pointer. Its identifier is CAAAfrGeoCreationMbr and is used for its resources. It is set as the workbenchs menu bar using the SetWorkbenchMenu macro. The toolbar resources, and how to provide them, are described in Creating Resources for Workbenches. See also Providing the Resources and Inserting the Workbench into the Start Menu for an overview of all the resources to create.1）添加Solids 工具条按钮（Creating the Solids Toolbar Content）This toolbar contains four commands: Cuboid, Sphere, Torus, and Cylinder. You should, for each command: （1）Create a command starter using the NewAccess macro （2）Associate the command starter, using the SetAccessCommand macro, with the appropriate command header identifier defined in the CreateCommands method （3）Arrange the command starters in the toolbar using the SetAccessChild and SetAccessNext macros . NewAccess(CATCmdStarter,pCAAAfrTSolidEltCuboidStr,CAAAfrTSolidEltCuboidStr); SetAccessCommand(pCAAAfrTSolidEltCuboidStr,CAAAfrCuboidHdr); SetAccessChild(pCAAAfrSolidEltTlb,pCAAAfrTSolidEltCuboidStr); NewAccess(CATCmdStarter,pCAAAfrTSolidEltSphereStr,CAAAfrTSolidEltSphereStr); SetAccessCommand(pCAAAfrTSolidEltSphereStr,CAAAfrSphereHdr); SetAccessNext(pCAAAfrTSolidEltCuboidStr,pCAAAfrTSolidEltSphereStr); NewAccess(CATCmdStarter,pCAAAfrTSolidEltTorusStr,CAAAfrTSolidEltTorusStr); SetAccessCommand(pCAAAfrTSolidEltTorusStr,CAAAfrTorusHdr); SetAccessNext(pCAAAfrTSolidEltSphereStr,pCAAAfrTSolidEltTorusStr); NewAccess(CATCmdStarter,pCAAAfrTSolidEltCylinder1Str,CAAAfrTSolidEltCylinder1Str); SetAcce