Before You Begin

AutoCAD Map 3D SDK

Before You Begin

To develop applications using AutoCAD Map 3D ObjectARX, you should be familiar with AutoCAD ObjectARX and also the AutoCAD Map 3D and AutoCAD applications.

For information about... Refer to...
AutoCAD ObjectARX AutoCAD ObjectARX Documentation, arxdoc.chm, which is located in the docs folder of your ObjectARX installation.
AutoCAD Map 3D and AutoCAD AutoCAD Map 3D Help, which is located in the Help folder of AutoCAD Map 3D installations.

Important Note  AutoCAD Map 3D Help is especially useful for undestanding how AutoCAD Map 3D models its domain, for understanding drawing sets and queries, for example. Since detailed explanations of these paradigms are available in AutoCAD Map 3D Help, AutoCAD Map 3D ObjectARX Help explains them only briefly or not at all. Before you attempt to automate or extend an AutoCAD Map 3D feature, review the subject in AutoCAD Map 3D Help.

Compatability of ObjectARX and AutoCAD Map 3D

AutoCAD Map 3D ObjectARX must be installed in an existing AutoCAD ObjectARX installation, and the AutoCAD Map 3D and AutoCAD ObjectARX versions must be compatible with each other and with the version of AutoCAD Map 3D that you are extending. For example, AutoCAD Map 3D ObjectARX 2007 must be installed into an existing AutoCAD ObjectARX 2007 installation, and you need both APIs to build ObjectARX applications for AutoCAD Map 3D 2007.

Components Not Intended for Public Use

In many cases, but not all, where a component is documented but not intended for public use, this fact is noted in the component description. With the following components, however, this note may not be present. Avoid them nevertheless. They are intended for internal Autodesk use only.

Important Note  Be aware of these components. Avoid using them in your applications.

Components to avoid:

AcMapMbTileNameGeneratorGrid Class
AcMapMbTileNameGeneratorData Class
AcMapMbTileNameGeneratorSequence Class
AcMapMbTileNameGenerator Class

Review What's New

Besides highlighting new functionality, the What's New topic also lists ObjectARX components that are not intended for public use, in addition to the components that are already listed in "Components Not Intended for Public Use" above. Even though they are present in public header files and may even be partially documented, they are intended for internal Autodesk use only.

Important Note  Be aware of these components. Avoid using them in your applications.

Return Descriptions With Multiple Return Codes Cited

With return descriptions of functions where multiple return codes are cited, note that the list of return codes is not necessarily exhaustive. Undocumented return codes are possible.

For example, the return descriptions for ObjectARX functions FullEdge::GetHalfEdge() and AcDbBasicFilter::FilterObjects() should simply say, "Returns eOk or an error code." Their lists of return codes are lengthy enough that you might think they are exhaustive, but they are not.

Typographic Conventions

How It Looks What It Is
anteatereater Text you enter at the AutoCAD Map 3D command prompt.
dirname\filename.ext Names of files and directories.
dir *.h /b/o:n > dir.txt Code.

Note  All file names and directory paths in AutoCAD Map 3D are case sensitive.