AutoCAD OEM Technical Documentation

AutoCAD OEM

AutoCAD OEM is a high-level CAD platform that can be used as the foundation for you to easily develop and deliver products using a wide variety of ready-made CAD functions tailored to your end users’ specific needs. AutoCAD OEM is based on AutoCAD® and provides true DWG file compatibility.

Find out more below:

What is AutoCAD OEM?

AutoCAD OEM has almost the same feature set as AutoCAD. As a licensed AutoCAD OEM developer, you choose how much access end users have to the AutoCAD feature set and customization features. You choose the commands and features you will support. AutoCAD OEM products can use any AutoCAD functionality internally, while limiting CAD functionality supplied to end users. This architecture provides security for your product and the data your product creates and edits.

All AutoCAD OEM products begin as AutoCAD plugins. The My First Plugin Training Guide provides information on creating plugins.

You create custom products by using AutoCAD OEM to do the following:

Expose only the AutoCAD functionality necessary to your particular products by customizing your products’ user interfaces

Create new functionality with ObjectARX®, ObjectDBX™ , Visual LISP®, Visual Basic® for Applications (VBA), ActiveX® Automation, and ObjectARX managed class APIs

The following diagram illustrates the various levels of access in an AutoCAD OEM product.

The AutoCAD OEM Make Wizard

AutoCAD OEM includes a ‘Make Wizard’, which is a useful tool you can use to very simply build and customize your product. The wizard automates project setup, registration, and AutoCAD OEM resource configuration based on the information you provide. It also guarantees that your product is built with the correct name and includes the required files.

The wizard does most of the work of building your finished product so that you can devote more time to developing value-added functionality.

Using the AutoCAD OEM Make Wizard, you can

Outside the AutoCAD OEM Make Wizard, you can

As an AutoCAD OEM developer, you provide the name of your product and program. For example, the program name could be cadd.exe.

The wizard uses both the information you provide and the AutoCAD OEM engine files to create a directory containing all necessary files. The directory includes an executable whose name is based on the program name you enter in the wizard. The executable is the basis for your AutoCAD OEM product. The wizard “stamps” your product files by providing an identity to the necessary AutoCAD OEM engine files.

The AutoCAD OEM Make Wizard saves a configuration file when you create your product. This file is named .xml and is located in the projects\ folder. The OEMInstallerWizard uses this file to find the name of your product, the name of your company, and other information.

Specifying Your Own Project Information

Using the AutoCad OEM Make Wizzard, you can use the Project Information page to specify identifying information for your product. The wizard uses the values you enter to provide your product’s identity to the necessary AutoCAD OEM engine files.

Note After all the text boxes on the Project Information page are filled in, the Table of Contents for the wizard is available. The Table of Contents lists the titles of the wizard pages; you can use the titles to navigate without using the Back and Next buttons.

Enabling Commands and System Variables

With the Commands table on the AutoCAD OEM Make Wizzard Commands page, you can enable built-in commands and system variables.

The table lists the global command names for built-in commands, with each command preceded by an underscore. The table also lists system variables, which are not preceded by an underscore.

You can give commands and system variables varying levels of support in your product:

To change the default level of support for a command or system variable, select it from the AutoCAD OEM Commands page and select an option in the Support Options area of the page.

Specifying Your Own Modules

On the Your Modules page of the AutoCad OEM Make Wizard, you can specify applications and other support files that you want to include in your AutoCAD OEM product. The files and settings you specify are displayed in the table.

Using the Add Module button, you add your application and support files to your product. After you select a module, its file name and location are displayed in the list, and the Build With and Build Destination options become available. The Remove Module button deletes modules from the list. To edit a module file or its location, double-click the field. You may also use environement variables within the location field.

After you add a module, you can select a bind option or a copy option from the Build With list. Bind options are available for all supported file types. If you select a bind option for a file, the wizard stamps the module.

If you select the CopyFile option in the Build With list, the wizard does not stamp the module. Instead, the wizard copies the file to the location you provide in the Build Destination area of the Your Modules page. The CopyFile option is useful for support files such as fonts and sample drawings, as well as for DLL files that are not linked with AutoCAD OEM libraries and thus do not require binding

After a file has been built into your product, the wizard binds or copies it only if the file has been modified since a previous build. This optimization reduces processing time and helps streamline the debugging process. Note that all files are rebuilt if the “Build All” option is selected.

Specifying Settings for Your Module

On the Your Module Settings page, you can use the table to enter the names of the custom commands provided by the modules on the Your Modules page. Specifically, enter custom command names defined in your ObjectARX, AutoLISP, VBA, and managed application modules.

You can enter new commands, delete existing commands, or import a command list from an external file. You can also enable your custom defined setvars in this page. To do this you should add the setvar name to the default application. When you build your project using the AutoCAD OEM Make Wizard, your ObjectARX applications and object enablers are registered with the appropriate settings, including application name, ObjectARX commands, and load controls.

The applications you added on the Your Modules page are displayed in the Application column. If an ObjectARX or other application defines commands, you must add the command names in the Your Commands field for that application. The wizard configures your product to include the specified commands. You must list global and local command names for commands defined in ObjectARX applications. For ObjectARX, object enablers, and managed applications, you must also enter a logical application name and a load controls number to be specified in the registry. The logical application name should match the name that the application uses if it registers itself.

Built-in AutoCAD OEM commands are on a different page in the wizard from your custom commands. This is especially helpful during maintenance. Separate pages prevent confusion between built-in commands that cannot be modified, and custom commands that can.

All custom commands that you specify are available for use at the command line of your product and for inclusion in your menu and toolbars.

For custom commands defined in ObjectARX modules, you should

AutoCAD OEM allows up to 1500 commands, including supported built-in commands.

Controlling Your Toolbar and Status Bar

On the Toolbar and Status Bar page of the AutoCad OEM Make Wizzard, you can set attributes for controls on toolbars. It is also possible to remove the controls entirely from the CUI command list. Click the plus sign next to each item that you want to change.

You can use this page to turn the Z coordinates display on or off for your status bar, which is useful if your product is a 2D tool. To customize your status bar panes for attributes such as tooltips and visibility, you use an application programming interface.

You can also control the following:

Tooltip text determines the string displayed in the Windows tooltip when the user’s cursor hovers over the control. If you assign an empty string, no tooltip is displayed.

AutoCAD OEM Features

On the AutoCAD OEM Features page of the AutoCAd OEM Make Wizard you select the features that your product supports. Many features in the table are part of the Options dialog box.

In the Description column, features are described. If you decide to support a feature in your product, select the feature and, under Support Options, select On.

If you decide not to support a feature in your product, select the feature and, under Support Options, select Off.